Build Instructions

=Installing from source=

MS Windows
OpenSim requires either the .Net framework version 2.0, or the latest Mono. It supports the following compilers:
 * Microsoft Visual C# Express Edition (note: not Visual C++)
 * 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!

Subversion Repository
1. Get the nightly build source code from the svn repository:

http://opensimulator.org/svn/opensim/trunk

2. Get 0.4.5.2 Stable version from svn repository: svn co http://opensimulator.org/svn/opensim/tags/0.4.5.2-stable opensim

Building
2. In the top-level directory, run the 'runprebuild.bat' file. This will create both a VS2005 solution file, and a nant build file.

3. Open the resulting sln file with visual studio, and build it there, or 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.

Open Dynamics Engine (ODE)
If you want to implement collision-based physics, OpenDynamicsEngine (ODE) is the furthest along at the moment (9/07). It is not fully supported, but is starting to work somewhat reliably using a small number of regions per sim.

As installed from svn, ODE does not work on all platforms. If you get an ODE-related crash, and/or an ode.dll not found type of error (which can occur even though the dll is present!), try using the debug version of the dll, available here:

http://www.squiggle.com/opensim/ode-debug.dll

Rename it ode.dll and put it in .\bin, replacing the stock ode.dll.

If you do want to try to build ode from source, follow the directions on PhysicsEngines.

You can also try building ode.dll from the latest version of the source (http://www.ode.org/; make sure to enable trimesh)

Running
Recent versions of OpenSim come without an OpenSim.ini file. Copy the OpenSim.ini.example file to OpenSim.ini before making any changes.

Double-click on the OpenSim.exe</tt> executable file in the 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 "chmod 777 *</tt>" from the bin</tt> directory solves this.

Physics can be invoked by adding the appropriate line to the [Startup] section of 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 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 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 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
Please note that the current (as of 2007-11-23) SVN will not work on 64bit linux systems when built. You will need to use the binary build further down the page. Installing and running on x86-64

Install Steps for Unix Platforms
Steps to get packages that are needed to compile the source.

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

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/trunk opensim-libs cd opensim-libs/unmanaged/OpenDynamicsEngine/ ./configure --enable-shared make mv ./ode/src/libode.so /opensim/installation/directory/opensim/bin/

Ubuntu 7.10
sudo aptitude install subversion nant mono mono-gmcs libmono-microsoft8.0-cil libmono-system-runtime2.0-cil svn co http://opensimulator.org/svn/opensim/trunk opensim cd opensim ./runprebuild.sh nant


 * The above steps are for just running OpenSim. If you want to use MySQL either install during the installation process or install later. For development you'll need to install gcc, gc++, and whatever other modules are needed.
 * The above steps work on running OpenSim 0.4 on Ubuntu Server 7.10. I  did a new install and everything worked fine for  me. During the installation process I had Ubuntu install MySQL. --Mokele 11:41, 9 February 2008 (PST)

Mac OS X 10.5
export PKG_CONFIG_PATH="/Library/Frameworks/Mono.framework/Versions/1.2.5/lib/pkgconfig/:${PKG_CONFIG_PATH}" svn co http://opensimulator.org/svn/opensim/trunk opensim cd opensim ./runprebuild.sh nant
 * OpenSim should work on Intel Macs, I had one person confirm he's running OpenSim on Mac OS X 10.5.1 on a MacBook Pro. I've been trying to get to work on 10.5.1  and 10.4.11 on PowerBook (PowerPC) it compiles and runs but have not been able to get the SecondLife Viewer to connect. --Mokele 11:47, 9 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 Mono 1.2.5 from ftp://www.go-mono.com/archive/1.2.5/macos-10-universal/5/MonoFramework-1.2.5_5.macos10.novell.universal.dmg and in Terminal or X11 add the following line to .profile
 * Compile OpenSim

svn co svn://opensecondlife.org/libsl/trunk libsl cd libsl/openjpeg-libsl make -f Makefile.osx cp libopenjpeg-libsl-2.1.2.0.dylib ../../opensim/bin
 * Download and Compile libopenjpeg-libsl-2.1.2.0.dylib

Mac OS X 10.4
export PKG_CONFIG_PATH="/Library/Frameworks/Mono.framework/Versions/1.2.5/lib/pkgconfig/:${PKG_CONFIG_PATH}"
 * OpenSim should work on Intel Macs, I had one person confirm he's running OpenSim on Mac OS X 10.5.1 on a MacBook Pro. I've been trying to get to work on 10.5.1  and 10.4.11 on PowerBook G4 (PowerPC) it compiles and runs but have not been able to get the SecondLife Viewer to connect. --Mokele 11:47, 9 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 from the Optional Install from the DVD/CD Installation Disk.
 * Install Mono 1.2.5 from ftp://www.go-mono.com/archive/1.2.5/macos-10-universal/5/MonoFramework-1.2.5_5.macos10.novell.universal.dmg and in Terminal or X11 add the following line to .profile

svn co http://opensimulator.org/svn/opensim/trunk opensim cd opensim ./runprebuild.sh nant
 * Compile OpenSim

svn co svn://opensecondlife.org/libsl/trunk libsl cd libsl/openjpeg-libsl make -f Makefile.osx cp libopenjpeg-libsl-2.1.2.0.dylib ../../opensim/bin.
 * Download and Compile libopenjpeg-libsl-2.1.2.0.dylib

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

cd bin mono OpenSim.exe

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

or add  to the [Startup] section of 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).

Physics (Unix)
If you want to implement collision-based physics, OpenDynamicsEngine (ODE) is the furthest along at the moment (9/07). It is not fully supported, but is starting to work somewhat reliably using a small number of regions per sim.

Open Dynamics Engine (ODE)
As installed from svn, ODE does not work on all platforms. If you get an ODE-related crash, and/or a libode.so not found type of error, you will need to build libode from source.

Remove libode.so</tt> from the ./bin</tt> folder. (Note that subsequent svn updates may replace it again; best fix is to copy your built libode.so</tt> to <tt>bin</tt>). Do NOT remove <tt>ode.net.dll</tt>! Download the latest source packages from http://www.ode.org/. 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  if you get errors relating to drawstuff, test*, or openGL. 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>)

MAC OS X
I've been able to get OpenSim compile on 10.4.11 and 10.5.1 on my PowerBook G4 and running but have not been able to get the SecondLife Viewer to connect. Diego Zamboni on his site, http://zzamboni.org/brt/, as been able to get OpenSim to work. He's running OpenSim on a MacBook Pro with 10.5.1. So it may very well be  issues with trying to run OpenSim on PowerPCs. --Mokele 11:32, 9 February 2008 (PST)

External tutorials and howtos
Spanish howto: Opensim in GNU/Linux

French How To: Installer OpenSim sur un serveur Linux en réseau

=Binary releases=

Nightly builds, in tar-gzip format:

http://ruth.petitbe.be/build/

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