OpenSimulator - User contributions [en]

Build Instructions

2008-12-03T10:09:43Z

Dutchie: /* Debian 4 */

[[Category:Users]]
This page covers building OpenSim from source code on multiple platforms. Please help us keep this page up to date as the project progresses.

==Download from SVN==
Check out the [[Download]] Section

==MS Windows==

OpenSim requires either the .Net framework version 2.0, or the latest Mono. It supports the following compilers:
* [http://msdn2.microsoft.com/en-us/express/aa700756.aspx Microsoft Visual C# Express Edition] (note: not Visual C++)
* [http://www.mono-project.com/ mono]

Note for people who just downloaded the sources from http://dist.opensimulator.org/ (the "Downloads" link on the left) be advised that some important things are missing (like MySQL template scripts). For such features, you must download using svn!

Additional note: any Microsoft C# Express edition should work (2005 or 2008)

=== Building ===

* In the top-level directory, run the '<tt>runprebuild.bat</tt>' file. This will create a VS2005 solution file, a nant build file and a '<tt>compile.bat</tt>' file.
* If you prefer VS2008, run the '<tt>runprebuild2008.bat</tt>' instead.

* Open the resulting sln file with visual studio and build it there, or
* Run the '<tt>compile.bat</tt>' file. This will build the executable using MSBuild.
* if you prefer to use nant, run nant in the same top-level directory. This will build the executables.

If you don't care about physics (walking on prims, etc), ignore the rest of this section.

=== Running ===

Recent versions of OpenSim come without an <tt>OpenSim.ini</tt> file. Copy the <tt>OpenSim.ini.example</tt> file to <tt>OpenSim.ini</tt> before making any changes.

Double-click on the <tt>OpenSim.exe</tt> executable file in the <tt>bin</tt> directory. This will start up OpenSim in standalone mode.

The debugger in VS2005 C# may be used to step through the code. For those that use a Cygwin shell, you may find that one or more dll's have permissions that cause problems running. Most find that a "<tt>chmod 777 *</tt>" from the <tt>bin</tt> directory solves this.

Physics can be invoked by adding the appropriate line to the [Startup] section of <tt>OpenSim.ini</tt>. For ODE, that would be:

physics = OpenDynamicsEngine

You can also add a command line option to a shortcut, or run from a command prompt with:

-physics=OpenDynamicsEngine

'''''Windows Vista'''''

To run on Windows Vista, you must first disable Windows Firewall. Under the new "Start" button of Vista, select "Control panel". Then double-click "Windows Firewall". In the window that pops up, on the left column, select "Turn Windows Firewall on or off". You will have to give permission for this to run, then select the option "Off (not recommended)". Click "OK" and exit from the Windows Firewall window.

If you have McAfee SecurityCenter, see the description below.

Once all the security features are disabled, right click on <tt>OpenSim.exe</tt> and select "Run as administrator". This will pop up a window asking permission, select "Allow". Your OpenSim server should run in a DOS-like window and accept connections.

'''''McAfee Security'''''

McAfee Security does not allow applications to listen on ports not explicitly specified. You have two options: 1) disable firewall protection all together, 2) enable <tt>OpenSim.exe</tt> to be able to open ports.

''Disable firewall''

Open McAfee SecurityCenter. Select "Internet & Network". In the lower left corner is a small link to "Configure...". Select this. In the right side of the window, select the bar that says "Firewall protection is enabled". Here you can select "Off".

''Enable <tt>OpenSim.exe</tt> to open ports''

Open McAfee SecurityCenter. Select "Internet & Network". In the lower left corner is a small link to "Configure...". Select this. In the right side of the window, select the bar that says "Firewall protection is enabled". Select the "Advanced..." button. This will pop up a new window.

In the new window, on the left side, select "Program Permissions." In the middle on the right side of the window, select the "Add Allowed Program" button. Use the browser that pops up to find the OpenSim executable and select it.

Finally, select "OK" and exit the McAfee SecurityCenter window.

==Linux/Mac OS X/FreeBSD==

The easiest plaform to get running on the Linux side is Ubuntu 8.10, 32bit. This is what most of the developers running Linux use. If you are looking for the quick path, start there.

=== Ubuntu 8.04 / 8.10 ===

For Ubuntu users on older distributions (7.10, 8.04, etc.) '''you need''' to upgrade your mono to 1.9.1.

You can use the built in packages for mono. However, for better performance, you may want to [http://xyzzyxyzzy.net/2008/05/08/updated-mono-build-script-for-hardy-heron-and-mono-191/ upgrade mono to 1.9.1] ([http://tempvariable.blogspot.com/2008/04/installing-mono-191-on-ubuntu-804-hardy.html Other simple method])

sudo apt-get install subversion nant mono-gmcs libmono-microsoft8.0-cil \
libmono-system-runtime2.0-cil libgdiplus libmono-i18n2.0-cil libmono-oracle2.0-cil ruby
svn co http://opensimulator.org/svn/opensim/trunk opensim
cd opensim
./runprebuild.sh
nant

=== openSUSE 10.3 and 11 ===

Install an openSUSE 11 or 10.3 with its default options, add the online repositories
when finished installing do an online update with all the latest packages.

In yast install these packages, for running Opensim in standalone mode.
(there is a slight diffrence between 10.3 and 11 but following should be same)
subversion
nant
mono-jscript
- check that mono-core is installed

If you just want to use SQLite then jump to last section
within this post.

* Optional mysql - for Opensim running in Grid mode:
Install these mysql packages via yast
mysql
mysql-client
mysql-administrator
mysql-gui-tools
mysql-query-browser

Before building create the mysql database.
/etc/init.d/mysql start
mysql -u root -p -h localhost
(when asked for password just hit enter)

mysql> create database opensim;
mysql> quit

set the configuration in bin/mysql_connection.ini
Or on later builds set the connection string inside bin/OpenSim.ini

Build after installation of above in bash terminal. i save it in /opt

su -
cd /opt
svn co http://opensimulator.org/svn/opensim/trunk opensim
cd opensim
./runprebuild.sh
nant

After this you should be able to continue on starting the diffrent Servers, look in the mysql-config section,or
just run your OpenSim as a Standalone. By - eagleFX

=== Mac OS X 10.5/10.4 ===
* OpenSim is now working on PowerPC Macs! Thanks to DrScofield and those who helped him. Current nightly builds for PowerPC are not working, not sure about Intel so use the 0.5 Build. OpenSim works on Intel Macs. I'm testing on PowerBook G4. Tested these step on 10.5, but not 10.4 but should work --[[User:Mokele|Mokele]] 22:36, 14 February 2008 (PST)
* Install XCode Developers Tools from DVD/CD Installation Disk or download from http://developer.apple.com/. You have to create an Apple account to access the downloads if you don't have an Apple account.
* Install X11 for 10.4 from the Optional Install from the DVD/CD Installation Disk. X11 for 10.5 is installed by default.
* Install Mono 1.2.5 from http://ftp.novell.com/pub/mono/archive/1.2.5/macos-10-universal/5/MonoFramework-1.2.5_5.macos10.novell.universal.dmg and in Terminal or X11 edit the .profile file and add the following line:
export PKG_CONFIG_PATH="/Library/Frameworks/Mono.framework/Versions/Current/lib/pkgconfig/:${PKG_CONFIG_PATH}"
* Compile OpenSim
svn co http://opensimulator.org/svn/opensim/tags/0.5.0-release opensim
cd opensim
./runprebuild.sh
nant

* Download and Compile libopenjpeg-libsl-2.1.2.0.dylib and libsecondlife.dll
* libopenjpeg-libsl-2.1.2.0.dylib:
svn co http://opensimulator.org/svn/opensim-libs/libsl1550 opensim-libs
cd opensim-libs/openjpeg-libsl
make -f Makefile.osx
cp libopenjpeg-libsl-2.1.2.0.dylib ../../opensim/bin
* Note: The Makefile that creates the libopenjpeg-libsl-2.1.2.0.so does not compile on PowerPC, but works properly on Intel Macs. Looks like a gcc issue with compile options.

* libsecondlife.dll: (for PowerPC Only, see details on this step [http://xyzzyxyzzy.net/2008/02/12/installing-opensim-on-powerpcor-of-eggs-and-virtual-worlds installing OpenSim on PowerPC…or: of eggs and virtual worlds])
cd .. (back into opensim-libs)
nant
cp bin/libsecondlife.dll ../opensim/bin

* Edit the libsecondlife.dll.config (PowerPC Only). Remove the cpu="x86" tag in the last dllmap line.

=== FreeBSD 6.2 ===
su
cd /usr/ports/devel/subversion/ && make install clean (you may also need to rebuild apr-svn if this step fails)
cd /usr/ports/lang/mono/ && make install clean
cd /usr/ports/devel/nant/ && make install clean
cd /usr/ports/databases/sqlite3/ && make install clean
cd /usr/ports/x11-toolkits/libgdiplus/ && make install clean
cd /opensim/installation/directory/
svn co http://opensimulator.org/svn/opensim/trunk opensim
cd opensim
./runprebuild.sh
nant

Note: [http://opensimulator.org/wiki/OpenSim:FAQ#System.DllNotFoundException:_..2Flibopenjpeg-libsl-2.1.2.0.so|Follow the instructions on the FAQ to fix the]
"System.DllNotFoundException: ./libopenjpeg-libsl-2.1.2.0.so" issue, but use "gmake" instead of "make"

For ODE Physics you must do the following:
cd /usr/ports/graphics/libGL/ && make install clean
cd /usr/ports/graphics/libGLU/ && make install clean
cd /opensim/installation/directory/
svn co http://opensimulator.org/svn/opensim-libs/trunk opensim-libs
cd opensim-libs/unmanaged/OpenDynamicsEngine2/
sh autogen.sh
./configure --enable-shared --enable-release --disable-demos
make
mv ./ode/src/.libs/libode.so /opensim/installation/directory/opensim/bin/

=== RedHat Enterprise Linux 4 ===
sudo vi /etc/yum.repos.d/mono.repo

[mono]
name=Mono for rhel-4-i386 (stable)
baseurl=http://ftp.novell.com/pub/mono/download-stable/rhel-4-i386/
enabled=1
gpgcheck=0

sudo yum install mono-complete monodoc-core nant
svn co svn co http://opensimulator.org/svn/opensim/trunk opensim
cd opensim
./runprebuild.sh
nant

=== RedHat Enterprise Linux 5 ===

The instructions below also work on other RedHat Linux flavors such as CentOS or maybe Fedora.

1. Put the [http://download.opensuse.org/repositories/Mono/RHEL_5/Mono.repo Mono.repo] file in the /etc/yum.repo.d/ directory:
$ sudo su -
$ cd /etc/yum.repos.d/
$ wget http://download.opensuse.org/repositories/Mono/RHEL_5/Mono.repo
Naturally use the most [http://download.opensuse.org/repositories/Mono up-to-date link for your distribution].

2. Install Mono and related tools with yum:
$ yum install mono nant mono-jscript mono-nunit
Make sure to use nunit-console2 to run your tests.

=== Fedora 5 ===
* I needed to build latest mono and nant from sources to build OpenSim successfully, the ones available in yum repository didn't work so I had to uninstall and build and configure the packages.

For detailed instructions go [http://ruakuu.blogspot.com/2008/06/installing-and-configuring-opensim-on.html here]

=== Debian 4 ===

The following packages and their dependencies are required to run OpenSim on a default Debian 4 netinstall:
* mono
* libmono-corlib2.0-cil
* libmono-sqlite2.0-cil
* libmono-system-web2.0-cil
* libmono-microsoft8.0-cil
* libmono-system-runtime2.0-cil
* libmono-oracle2.0-cil (new dependency since r7587)

Hint: Currently (Nov/28/2008) it is possible to use Debian etch, but you will need to add custom repositories for mono to work. However installing or upgrading to Lenny/Sid will enable you to use the standard debian repositories.

=== 64bit ===
Please note that only 32bit binaries are provided in the bin/ directory of subversion. If you want to use 64bit, you'll need to rebuild these shared objects. See [[Installing and running on x86-64]]

=== Physics (Open Dynamics Engine ODE) ===
As installed from svn, ODE will work on most 32 bit platforms. If you get an ODE-related crash, and/or a <i>libode.so not found</i> type of error, you will need to build libode from source.

Remove <tt>libode.so</tt> from the <tt>./bin</tt> folder. (Note that subsequent svn updates may replace it again; best fix is to copy your built <tt>libode.so</tt> to <tt>bin</tt>). Do NOT remove <tt>ode.net.dll</tt>! Download the latest source from:

svn co http://opensimulator.org/svn/opensim-libs/trunk/unmanaged/OpenDynamicsEngine

OpenSim requires a couple of patches on top of ODE which are not yet included upstream. When compiling, make sure to use the following configure options:

--with-trimesh=gimpact
--enable-shared

Make sure the configure script confirms these choices, and always compile with single precision (I believe that's the default). Try <code> make -k </code> if you get errors relating to drawstuff, test*, or openGL. <code> make install </code> should put <tt>libode.so</tt> in the proper place (usually <tt>/usr/local/lib</tt>), and it should be seen by opensim (<tt>ode.net.dll</tt>)

===Running===
Recent versions of OpenSim come without an <tt>OpenSim.ini</tt> file. Copy the <tt>OpenSim.ini.example</tt> file to <tt>OpenSim.ini</tt> before making any changes.
<code>
cd bin
mono OpenSim.exe
</code>

Note: if you are running a 32bit Server such as Ubuntu 8.0.4 you need the alternative launcher:

<code>
mono OpenSim.32BitLaunch.exe
</code>

* To invoke ODE, add the option:
-physics=OpenDynamicsEngine
to the <tt>mono OpenSim.exe</tt> line

or add <code> physics = OpenDynamicsEngine </code> to the [Startup] section of <tt>OpenSim.ini</tt>. Same deal for other physics engines, when available.

On mono 1.2.6, some distributions may see
Unhandled Exception: System.NotSupportedException: CodePage 1252 not supported
on startup when using mysql. This can be resolved by installing the package libmono-i18n2.0-cil (see http://bugs.mysql.com/bug.php?id=33938).

=== Additional Items ===

* [[GC_NO_EXPLICIT|GC NO EXPLICIT]] - Enable Large Heap in Mono, this has been known to help performance and stability

[[Category:Users]]

Console-less OpenSim

2008-09-27T08:59:48Z

Dutchie: Added "screen" description

normally opensim will only run in console mode: whenever you start OpenSim you will end up at a prompt inside OpenSim's very own console — which is very convenient if you want to manage it that way. it is rather inconvenient if you want to start OpenSim as a daemon in the background (e.g., from <code>/etc/init.d/opensim</code>) and control it via the <code>RemoteAdminPlugin</code>, for example.

As the suggested backgrounding below doesn't work for everyone, the option of using the package screen is a great alternative. Once screen is installed, use the following command to start the simulator:

screen -S OpenSim -d -m mono OpenSim.exe

Once started, you can view the active session(s) listed with <code>screen -ls</code>. To attach a screen, use <code>screen -r Name</code>. From the example above that would be <code>screen -r OpenSim</code>. Once in the screen session, you can detach it by using Ctrl-A,D.

Killing a session without attaching it can be achieved by issuing:

screen -S OpenSim -r -m -X quit

{{obsolete}}

as of OpenSim's subversion release r4400 the basic support for running OpenSim without such a console is in the code base and all you need to do is invoke OpenSim with the <code>-background True</code> commandline parameter:

% mono --debug OpenSim.exe -background True

'''note: that is just a single dash for the <code>-background</code> option!'''

to shutdown a console-less OpenSim instance, use the following <code>shutdown.py</code> script (also located in <code>share/python/console</code>):

<pre>
#!/usr/bin/python
# -*- encoding: utf-8 -*-

import ConfigParser
import xmlrpclib
import optparse
import os.path

if __name__ == '__main__':
parser = optparse.OptionParser()
parser.add_option('-c', '--config', dest = 'config', help = 'config file', metavar = 'CONFIG')
parser.add_option('-s', '--server', dest = 'server', help = 'URI for the grid server', metavar = 'SERVER')
parser.add_option('-p', '--password', dest = 'password', help = 'password for the grid server', metavar = 'PASSWD')
(options, args) = parser.parse_args()

configFile = options.config
if not configFile:
if os.path.isfile(os.path.expanduser('~/.opensim-console.rc')):
configFile = os.path.expanduser('~/.opensim-console.rc')
if not configFile:
parser.error('missing option config')
sys.exit(1)

config = ConfigParser.ConfigParser()
config.readfp(open(configFile))

server = config.get('opensim', 'server')
password = config.get('opensim', 'password')

if options.server: server = options.server
if options.password: password = options.password

gridServer = xmlrpclib.Server(server)
res = gridServer.admin_shutdown({'password': password})

if res['success'] == 'true':
print 'shutdown of %s initiated' % server
else:
print 'shutdown of %s failed' % server

</pre>

you can either pass in the server URI and password to use via commandline parameters, or you can create <code>.opensim-console.rc</code> in your home directory and set default values:

<pre>
[opensim]
server = http://127.0.0.1:9000/
password = secret
</pre>

then all you need to do to shutdown your OpenSim server is invoke <code>shutdown.py</code>

the goal is to extend <code>shutdown.py</code> into a remote console of sorts.

''(adapted from [http://xyzzyxyzzy.net/2008/04/29/console-less-opensim/ xyzzy xyzzy])'''

User talk:Dutchie

2008-09-27T08:41:27Z

Dutchie: Intro

Hi,

A brief introduction:
I'm Dutch by origin, live in France. In OSGrid I'm known as Reena Bismuth, irc: FrenchDutchie (someone had already taken Dutchie).
I am not a programmer, I'm quite ok on the Operating System side and learning a lot about the workings of OpenSim.

Feel free to send any questions or comments.

Office hours

2008-09-27T08:31:14Z

Dutchie: Wright Plaza carries its name for nearly a year, we need an up-to-date agenda (no references to r2xxx, that is 4500 revisions ago)

OpenSim weekly office hours are held in an OpenSim world somewhere on the Internet. The purpose of these office hours is to created a focussed weekly discussion on the state of OpenSim, and things that need attention. It is intended for people wishing to become contributors to the project, so if you show up, you'll probably walk away with something on your todo list.

The office hours are held on Tuesdays at 19:00 UTC. This corresponds to:
* 11:00 PST - San Francisco (U.S.A. - California)
* 14:00 - New York (U.S.A. - New York)
* 19:00 UST - Oslo (Norway)
* 20:00 - Italy
* 02:00 Wed - Perth (Australia) (sorry adam)
* 15:00 AST - Atlantic Canada

There is useful [http://www.timeanddate.com/ Time'n'date] tool for timezone aware planning, with [http://www.timeanddate.com/worldclock/converter.html Time Zone Converter] & [http://www.timeanddate.com/worldclock/meeting.html Meeting Planner] (last thing helps to plan meeting for up 4 tz places)

The office hours will take place at the sim "Wright Plaza" on osgrid.

To get to this sim, make sure you have created an account with the normal first, last and password and set the home location to "Wright Plaza". This is done at http://www.osgrid.org.

Then startup the client with a -loginuri of "-loginuri http://osgrid.org:8002" and you should arrive on "Wright Plaza".

=== Previous Agenda Items ===

{{obsolete}}
Cfk would like to suggest that we give some thought to the following bugs.
#) Remoting exceptions with adjacent non-running sims.
#) Prim unlinking.
#) Enabling the script editor from the edit prim dialog box.
#) jpeg/ode dll and glibc-2.4 exceptions and stability.
#) GridServer.exe locks up in r2090 and works fine in r2060 on OSGrid.
#) Enabling avatar 'sit' on a prim.
#) More progress on avatar customization consistency. (Avatar changes when crossing region boundaries).

== Logs ==
* [[Chat log from the meeting on 2008-09-23]]
* [[Chat log from the meeting on 2008-09-16]]
* [[Chat log from the meeting on 2008-09-09]]
* [[Chat log from the meeting on 2008-08-26]]
* [[Chat log from the meeting on 2008-08-19]]
* [[Chat log from the meeting on 2008-08-12]]
* [[Chat log from the meeting on 2008-08-05]]
* [[Chat log from the meeting on 2008-07-22]]
* [[Chat log from the meeting on 2008-07-15]]
* [[Chat log from the meeting on 2008-07-08]]
* [[Chat log from the meeting on 2008-07-01]]
* [[Chat log from the meeting on 2008-06-17]]
* [[Chat log from the meeting on 2008-06-10]]
* [[Chat log from the meeting on 2008-04-15]]
* [[Chat log from the meeting on 2008-04-08]]
* [[Chat log from the meeting on 2008-03-11]]
* [[Chat log from the meeting on 2008-03-04]]
* [[Chat log from the meeting on 2008-02-17]]
* [[Chat log from the meeting on 2008-02-12]]
* [[Chat log from the meeting on 2008-02-05]]
* [[Chat log from the meeting on 2008-01-29]]
* [[Chat log from the meeting on 2008-01-09]]
* [[Chat log from the meeting on 2007-12-18]]
* [[Chat log from the meeting on 2007-12-11]]
* Chat log from the meeting on 2007-12-4 (meeting cancelled)
* [[Chat log from the meeting on 2007-11-27]]
* Chat log from the meeting on 2007-11-20 (missing)
* [[Chat log from the meeting on 2007-11-13]]
* [[Chat log from the meeting on 2007-11-06]]
* [[Chat log from the meeting on 2007-10-30]]
* [[Chat log from the meeting on 2007-10-23]]
* [[Chat log from the meeting on 2007-10-16]]
* [[Chat log from the meeting on 2007-10-09]]

[[Category:Development]]
[[Category:Office Hours]]