OpenSimulator - User contributions [en]

OpenSimSearch

2009-01-09T20:12:23Z

Zariok: provide user/pass instructions from gforge to checkout the code

OpenSimSearch makes it possible to have working Search included in OpenSim. At this moment only the Popular Places, Places, Landsales are fully activate, Events works in basic mode, still working on Classifieds and in the future the "New" search that works with HTML pages.

==How to setup OSS==

* Make sure you have a Apache/PHP/MySQL configuration ready else Search won't work!!

You can grab the latest version of OpenSimSearch through SVN, use the command below and use 'anonymous' as the username and a blank password to checkout the code.

<code>
svn checkout http://forge.opensimulator.org/svn/ossearch
</code>

====Using the Binary====

<h5> The following parts are for the Grid owner only</h5>

* In the trunk/bin folder you can find the latest binary release which you can include into your OpenSim.Just grab the 2 binary files and place them in the <b>bin</b> folder of OpenSim.

* Copy all files in the trunk/webroot to your webserver

* Create a new database called <b>ossearch</b>

* Import the SQL file ossearch.sql into your database

<code>
mysql --user --password ossearch < ossearch.sql
</code>

* Make sure you change the databaseinfo.php file to reflect your settings.

<source lang=php>
<?php
$DB_HOST = "<servername>";
$DB_USER = "<username>";
$DB_PASSWORD = "<password>";
$DB_NAME = "<database>";
?>
</source>

<h5> The following parts are for the Region owners </h5>

* In the trunk/bin folder you can find the latest binary release which you can include into your OpenSim.Just grab the 2 binary files and place them in the <b>bin</b> folder of OpenSim.

* Search needs the DataSnapShot module to be activated, here's how to get it activated:

<source lang=text>
[DataSnapshot]
; The following set of configs pertains to search.
; Set index_sims to true to enable search engines to index your searchable data
; If false, no data will be exposed, DataSnapshot module will be off, and you can ignore the rest of
; these search-related configs
index_sims = true
; The variable data_exposure controls what the regions expose:
; minimum: exposes only things explicitly marked for search
; all: exposes everything
data_exposure = minimum
; If search is on, change this to your grid name; will be ignored for standalones
gridname = "<yourgridname>"
; Period between data snapshots, in seconds. 20 minutes, for starters, so that you see the initial changes fast.
; Later, you may want to increase this to 3600 (1 hour) or more
default_snapshot_period = 1200
; This will be created in bin, if it doesn't exist already. It will hold the data snapshots.
snapshot_cache_directory = "DataSnapshot"
; This semicolon-separated string serves to notify specific data services about the existence
; of this sim. Uncomment if you want to index your data with this and/or other search providers.
data_services="http://<yourserver>/search/register.php"
</source>

* Add the following 2 lines to your OpenSim.ini file to get Search activated

<code>
[Search]<br>
SearchURL = http://gridserver/search/query.php
</code>

<h5>[Grid owners]</h5>

* Startup your region server and check your MySQL database table <b>hostregister</b> if the regionserver registered itself. If it registers, that means the DataSnapShot Module is working and you can use Search.

In the trunk/webroot folder there's a file called parser.php. This file is the parser of the info from the DataSnapShot Module. This file needs to be run with cron or some other way. If this file isn't run, the search tables won't be filled and you won't see anything.

To set up a cron job, take a look at this page:

* http://www.faqts.com/knowledge_base/view.phtml/aid/1005

<h5>[Region owners]</h5>

* Startup your region server and have the Grid owner check if your region shows up in the MySQL database table <b>hostregister</b>. When it does, your region now has Search enabled from the Grid

====Notes for the Grid Owners====

* If you're a Grid owner, make sure that regionserver can access your Search URL else the Search on those regions will fail.

* Whenever a sim fails, sometimes the user that has set the cron job up will fire off emails to the root user. These emails can be annoying but only give warnings about it working.

Tips

2008-04-02T04:22:37Z

Zariok: /* How can I flatten a region? */

[[Category:Users]]
==Terrain Tidbits==
===How can I flatten a region?===
When you have multiple regions, that you need to terraform to a certain height, the quickest way to do it is by selecting a region, and fill the terrain to the specified height:
change-region YourRegionName
script terrain fill 20

''Note:'' Remember to change to the region you wish to modify if that is the only region wish to make changes to. Without using the change-region command, you may very well end up flattening multiple regions!

As of SVN 4061
terrain fill 25

[[Category:Getting Started]]

=== What programs can I use to create terrains for OpenSim? ===
If you are after simple terrain files (jpg, gif, etc), you can use Photoshop or any number of freeware programs, like [http://www.gimp.org/ Gimp]. If you want more complex terrains, you will need programs that output to standard 3d raw format (aka r32 or r64). [http://www.bundysoft.com/L3DT/ L3DT] and [http://www.planetside.co.uk/terragen/ Terragen] are two of the top commercial programs for this. (anyone know of a freeware one?), or you could, with some practice, use [http://www.blender.org/ Blender]. The free version of L3DT can make terrains up to 2048x2048 in size, or 8x8 regions.
You can use `terrain load IMG yourfile.png` to load '''greyscale''' PNG files. Remember to use something like `terrain rescale 0 25` to make it visible.
Here is some info on [[Using L3DT]] to make a terrain.

You can also use http://lab.parkstudio.ru/terra/ if you know a bit about heightmaps and how they work. Just set the custom landscape texture gradient to pure black and pure white and turn off water.
And here are some [[Free Terrains]] that you can use. Enjoy!

=== Where do I put the files for my terrains? ===
This one is actually pretty simple, but first the 'hard' answer: anywhere in the PATH will work. Lost? yeah, I was too, so... just drop the file into the <tt>bin</tt> directory (right where your <tt>OpenSim.exe</tt> file is).

===How do I change the terrain for a group of sims?===
First, the file must be in f32 (or f64?) format. This is easy to do with L3DT's export feature. (Use the RAW format and set the options to <tt>Y flipped = true</tt> and at the bottom, change it to read 'float' instead of 'ushort'). It also needs to be a file that will cover each sim in a 256x256 layer (so, for 2x2 regions, you need a 512x512 file), It is very important that you rename the file extension to .r32 for the import to properly work.
Then, once you have it saved, on the <tt>OpenSim.exe</tt> console, type in:
script terrain load-tile <filename> <image X> <image y> <bottomleftsim X> <bottomleftsim y>
For example, I run a square of 4 sims in a 2x2 pattern. I started my sim placement at 0, 0 and ended at 1, 1. my line reads:
script terrain load-tile simalpha.r32 512 512 0 0
Next, before you log in, you may want to go to type in: *(THIS FUNCTION MAY NOT WORK)
script terrain multiply 0.4
This should scale it down from the nearly 300 meters altitude I ran into to something a little more reasonable for the minimap.

===How do I load a terrain file on startup?===
Edit the file <tt>startup_commands.txt</tt> in the bin directory and add the above commands "<tt>script terrain load-tile ...</tt>" and "<tt>script terrain multiply ...</tt>" one per line.

*** Notice this method is no longer required and should be considered a legacy function, Terrain persistance is now working 100%.

Terrain Tidbits brought to you by Tilde, with a few questions in IRC :) - [[User:Tildeampersand|Tilde]] 10:32, 15 August 2007 (PDT)

===How do I import into OpenSim the terrain shape of my Second Life sim?===
First, assure you are in the right region if you have more than one, by using:

change-region <nowiki><regionname></nowiki>

Then use the command (file extension now determines the format, use .r32 for L3DT terrains)

script terrain load <filename>

Watch [http://archimedix.wordpress.com/2007/11/26/opensim/ this video] for a step-by-step tutorial.

=== Other useless or useful info depending on who reads it ===

* I found out that each point on the grey scale (0 to 255) equals approximately .23 to .25 meters in terrain height. - [[CharlieO]]
* Also for those who want to manually edit a png file, you need at minimum 3 different shades of grey. and one has to be drastically different than the other 2 in order to have the height show correctly. - [[CharlieO]]
example:
1) 0,0,0
2) 223, 233, 233
3) 255, 255, 255

FAQ

2007-09-05T19:12:49Z

Zariok: /* Are there test servers running OpenSim I can connect to? */

A list of frequently asked questions. Please add anything you think is reasonable here.
= Building OpenSim =

=== I can't find any build files or solution files ===

* If you're on windows, run prebuild.bat - on linux prebuild.sh

=== VS2005 wont open the .sln file ===

* Try running the VS2005 C#. You are probably running VS2005 C++. This is a C# project.

= Running OpenSim =

=== Running OpenSim.exe from a Cygwin shell has access denied for some dll's ===

* Do a 'cd bin' followed by 'chmod a+x *' to make all dll files executable.

=== I cannot start my sim ===

* See [[OpenSim: Running]].

= Configuring OpenSim =

First, read [[OpenSim: Configuration]].

=== Where can I get a new UUID for my sim config? ===

Use 'uuidgen' or generate one on the [http://www.famkruithof.net/uuid/uuidgen uuidgen webpage].

=== Can I run multiple regions with OpenSim? ===

Yes. To do this add another xml file to bin/Regions. You need to create a new 'sim_UUID' (see above) and change the 'sim_name', 'internal_ip_port', 'sim_location_x' and 'sim_location_y' (and anything else you wish to change). Restart OpenSim.

sim_location_x and sim_location_y should be in adjacent regions, then you will be able to run back and forth between regions.

* See [[OpenSim: Configuration]].

=== How do I enable prim storage? ===

* In the OpenSim.ini file, change the storage_plugin so it points to OpenSim.DataStore.MonoSqlite.dll (storage_plugin = OpenSim.DataStore.MonoSqlite.dll).

Note: you can specify the same database for all region.xml files, as information in the database is stored with the region.

Currently, sqlite is the only database provider that works for prim storage, this will change in the future.

=== There are a bunch of textures in the library, but they are all 0x0? What's wrong? ===
To enable these extra textures for your use, you must delete your regionassets.yap file, and restart your sim. WARNING: IF YOU DO THIS, YOU WILL LOSE ANY ASSETS (textures, scripts, animations, etc) THAT YOU HAVE UPLOADED!

=== What databases are supported in OpenSim? ===
Right now the only database supported is sqlite. This is being done first to ensure all our persistent data is SQL friendly for storage, and because sqlite requires no user interaction to setup. The architexture for OpenSim specifically allows for different data store backends, and others will be created in the near future.

=== Can I export all my prims, for safe keeping? ===

Yes. From the console type
save_xml yourbackupfile

You can later load those prims with
load_xml yourbackupfile

This is also a good way to dump and clone prims from one OpenSim server to another.

= Something Has Gone Wrong! =

=== I get a timeout during region handshake ===

* Do you have the correct IP in your Regions\* config file?
* Do you have multiple interfaces on the server running OpenSim? OpenSim will not bind outgoing UDP packets to a specific IP, its default IP to reach you will be what the Region answers UDP with. If you have configured the region for another IP you will get a timeout during connect.

=== I cannot connect to my OpenSim ===

* See [[OpenSim: Connecting]].

=== I connect but cannot move ===

If the client connects but the avatar can only spin in place and not move, then the sim is not correctly configured. It completed the initial login function, but packets are not being exchanged between the client and the sim, probably due to a network configuration error on the sim.

* See [[OpenSim: Configuration]].

=== From time to time my Avatar seems to get stuck ===
Right now there is a bottle neck when syncing prims off to the database. This will cause small (5 - 10 second) apparent hangs of the Avatar, but it will recover fine once the data is synced. It is a known issue based on legacy architecture of some of the data storage code. We hope this will be removed soon.

=== I have problems with viewing the worldmap ===

* This may happen when running OpenSim on a Linux server, both in grid or standalone mode.
* Symptoms: when opening the worldmap window in the SL-viewer, the sims are not displayed grahically in the worldmap, the server console shows some error related to openjpeg, the current session freezes...
* Reason: your svn source trunk has not the correct (or whatever...) libopenjpeg-libsl library.
* Solution: get the newest code from libsecondlife (svn co svn://opensecondlife.org/libsl/trunk), 'make' manually in the subdir openjpeg-libsl, and copy the resulting libopenjpeg-libsl-2.1.2.0.so into your OpenSim .../bin subdir, overwriting the existing one.
* Recompile & restart OpenSim.

= Exceptions on the Console =
This is a list of Exceptions that you may see on the console, what they mean, and if they are a problem.

=== System.DllNotFoundException: ./libopenjpeg-libsl-2.1.2.0.so ===
Failed generating terrain map: System.DllNotFoundException: ./libopenjpeg-libsl-2.1.2.0.so
at (wrapper managed-to-native) OpenJPEGNet.OpenJPEG:LibslAllocDecoded OpenJPEGNet.OpenJPEG/LibslImage&)
at OpenJPEGNet.OpenJPEG.Encode (System.Byte[] decoded, Int32 width, Int32 height, Int32 components, Boolean lossless) [0x00000]
at OpenJPEGNet.OpenJPEG.EncodeFromImage (System.Drawing.Bitmap bitmap, Boolean lossless) [0x00000]
at OpenSim.Region.Terrain.TerrainEngine.ExportJpegImage (System.String gradientmap) [0x00000]

You are on Linux, and the native lib libopenjpeg-libsl-2.1.2.0.so is not compatible with your system for one of the following reasons:
* You have an old processor (libopenjpeg has been compiled with optimizations)
* You are running in 64bit mode (none of the native libs are built for 64bit)

You can rebuild your own libopenjpeg from source, or run in a compatible environment.

= OpenSim in the Wild =

=== Are there test servers running OpenSim I can connect to? ===

Yes. Check out http://deepgrid.com, http://osgrid.org

=== Can I teleport from the Linden Lab Second Life grid to my Sim? ===

No, OpenSim islands cannot connect to the Linden Lab grid.

= Terrain Tidbits =
=== What programs can I use to create terrains for OpenSim? ===
If you are after simple terrain files (jpg, gif, etc), you can use Photoshop or any number of freeware programs, like Gimp. If you want more complex terrains, you will need programs that output to standard 3d raw format (aka r32 or r64). L3DT and Terragen are two of the top commercial programs for this. (anyone know of a freeware one?), or you could, with some practice, use Blender. The free version of L3DT can make terrains up to 2048x2048 in size, or 8x8 regions.

=== Where do I put the files for my terrains? ===
This one is actually pretty simple, but first the 'hard' answer: anywhere in the PATH will work. Lost? yeah, I was too, so... just drop the file into the /bin directory (right where your opensim.exe file is).

=== How do I change the terrain for a group of sims? ===
First, the file must be in f32 (or f64?) format. This is done easliy with L3DT's export feature. (use the RAW format and set the oprions to Y flipped = true and at the bottom, change it to read 'float' instead of 'ushort'). It also needs to be a file that will cover each sim in a 256x256 layer (so, for 2x2 regions, you need a 512x512 file).

Then, once you have it saved, on the OpenSim.exe console, type in:

terrain load-tile f32 <filename> <image X> <image y> <bottomleftsim X> <bottomleftsim y>

For example, I run a square of 4 sims in a 2x2 pattern. I started my sim placement at 0, 0 and ended at 1, 1. my line reads:

terrain load-tile f32 simalpha.raw 512 512 0 0

Next, before you log in, you may want to go to type in:

terrain multiply 0.4

This should scale it down from the nearly 300 meters altitude I ran into to something a little more reasonable for the minimap.

=== How do I load a terrain file on startup? ===
Edit the file startup_commands.txt in the bin directory and add the above commands "terrain load-tile ..." and "terrain multiply ..." one per line.

Terrain Tidbits brought to you by Tilde, with a few questions in IRC :) - [[User:Tildeampersand|Tilde]] 10:32, 15 August 2007 (PDT)

= In World Questions =

=== Does in world scripting work yet? ===

Not yet, but there is a lot of work going on here. Please see [[LlFunction_implementation_status]] for the latest info.

=== Why do I walk through objects? ===

Basicphysics doesn't support collisions between objects (just between you and the ground). There is active work on other physics engines for OpenSim, but these are quite experimental at this point, so not considered supported.

=== Can I edit my avatar? ===

Yes, but you need to create a Shape, Hair, Shirt, and Pants first via the Inventory button. There are no defaults created for each user at this point.

= Grid Mode =
Note: Grid Mode isn't officially supported yet. As such, you are pretty much on your own if you are trying to get OpenSim up and running in Grid Mode.

=== I start the sim and it doesn't connect to any grid ===

When OpenSim is first started, it needs configuration.

* See [[OpenSim: Configuration]].

=== I start the OpenSim.Grid.UserServer.exe and it gives an error ===

If this error is access denied for username@localhost, the mysql database is not set up.

It will print some text and wait for input - either an enter to accept a default value, or another value you can supply.

* See [[OpenSim: Configuration]].

=== I want to run my own Local Grid but one or more servers fail to start ===

* Be sure that you're able to start OpenSim.exe alone, in Standalone mode, and to be able to login.
* Start the servers in the correct UGAS order and answer the questions as recommended (see [[OpenSim: Configuration]]).
* Set all the external URI's to the correct IP: 127.0.0.1 if running on your local machine, or aaa.bbb.ccc.ddd if running on a remote server.
* Check again all the *.xml configuration files for any wrong settings or typing errors...!
* Don't forget to connect with your SL-viewer to port 8002 (Grid User-Server) instead of 9000 (Standalone OpenSim-Server).
* Delete all *.xml and *.yap files in the bin directory if you want to run a full reconfiguration again.

= How to ask for help =

=== Before asking for help... ===

* Search the wiki and web before asking for help.
* Check your configuration files for any obvious defects.
* Check that you're starting up the processes correctly.
* See [[OpenSim: Install]].
* See [[OpenSim: Configuration]].
* See [[OpenSim: Running]].
* See [[OpenSim: Connecting]].

=== Asking in IRC ===

IRC channels are #opensim-help, #opensim and #opensim-dev on EFNet. Approach them in that order :) Please be courteous and remember that the developers and anyone else assisting you are volunteers there.

* Don't ask to ask, just ask.
* Phrase your question in the form of a question.
* Be specific.
* Explain the problem.
* Describe how to reproduce the problem.
* If you need to paste configuration files or error messages, please paste to [http://pastebin.ca/ pastebin] then send the link in the IRC channel.

=== After you get help ===

* If no-one can help you, please submit a bug.
* If someone does help you, please document the problem and fix on the wiki on this page.