Build Instructions

Revision as of 12:51, 23 January 2011

 

Home

 

Download

 

News

 

Support

 

Admin

 

Dev

 

Screen Shots

 

Grid List

 

Bugs

Languages:

English    Deutsch    Français    日本語

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 OpenSim

Check out the Download page for instructions on obtaining an OpenSim source release.

MS Windows

UPDATED: Feb.15.2010

OpenSim requires either the .Net Framework version 3.51, or Mono 2.4.2.3 or newer. It supports the following compilers:

Net Framework is available from here: www.microsoft.com/downloads/details.aspx

• Microsoft Visual C# Express Edition (note: not Visual C++)

New URL: http://www.microsoft.com/express/Windows/ ( The Visual Studio® 2010 Express )

• mono

Additional note: If you like IDE's you will need C# express 2008 or VS 2008.

Additional note: Microsoft C# Express v9 may install .Net 3.5 with resultant path error.

1. To avoid install .Net framework version 2.0 (installed by default in Windows XP & newer)

Additional note: It is possible to develop on Windows Vista 64 bits with the following tweaks:

1. Select OpenSim project properties from solution and choose platform to be x86. Rebuild solution.
2. Select OpenSim.exe properties under solution bin folder and choose windows xp sp 2 compatibility mode + run as administrator.

Additional note: It is possible to develop with Visual Studio 2010 - C# Express with the following tweaks:

1. In the top-level directory, run the 'runprebuild.bat' file. This will create a VS2008 solution file.
2. Open the VS2008 solution file in VS 2010 Express and run the conversion wizard to crease a VS2010 solution file.
3. In the solution explorer of the resulting project, right click on each project (there are 91) and select properties. Under the Application tab, set the Target framework to .NET Framework 3.5.
4. In the solution explorer, under the OpenSim project select "app.config".
5. Copy the contents of bin\OpenSim.exe.config into the app.config file

Building

• In the top-level directory, run the 'runprebuild.bat' file. This will create a VS2008 solution file, a nant build file and a 'compile.bat' file.

• Open the resulting sln file with visual studio and build it there, or
• Run the 'compile.bat' 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.

Note that only a limited number of directories and files are actually required for a working system,the rest are just used for source code and the build process:

 addon-modules
 bin
 doc
 share
 ThirdParty
 ThirdPartyLicences
 BUILDING.txt
 CONTRIBUTORS.txt
 LICENSE.txt
 README.txt
 TESTING.bat

Running

Copy the bin/OpenSim.ini.example file to bin/OpenSim.ini before making any changes.

Assuming you initially want to create an Opensim Standalone setup, the example Opensim.ini already has the appropriate [Architecture] setting for that in place referring to an include file at bin/config-include/StandaloneCommon.ini.example.

Copy the bin/config-include/StandaloneCommon.ini.example file to bin/config-include/StandaloneCommon.ini before making any changes to that too. A cache is recommended to make Opensim run in a more stable and efficient manner. Choose a cache as described in bin/config-include/StandaloneCommon.ini.

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

The debugger in VS2008 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 *" from the bin directory solves this.

Windows Vista

Some people have reported that 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 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 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 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 platform to get running on the Linux side is Ubuntu 10.04, 32bit. This is what most of the developers running Linux use. If you are looking for the quick path, start there.

Many distros (including Ubuntu) ship with only the "mono-runtime" package installed, however you need to install "mono-complete" for some OpenSimulator features such as LSL script commands.

Ubuntu

For Ubuntu users on older distributions (7.10, 8.04, etc.) you need to upgrade your version of mono to at least 2.4. For anyone who needs to upgrade their Mono, see Update Mono on Ubuntu.

Ubuntu Karmic (9.10) includes mono 2.4.2.3 packages.

Ubuntu Lucid (10.04) includes mono 2.4.4 packages

Ubuntu Maverick (10.10) includes mono 2.6.7 packages

To build:

sudo apt-get install nant mono-gmcs libmono-microsoft8.0-cil \
     libmono-system-runtime2.0-cil libgdiplus libmono-i18n2.0-cil libmono-oracle2.0-cil
Download opensim
cd opensim
./runprebuild.sh
nant

openSUSE 10.3/11/11.1

Install an openSUSE 11.1, 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/11.1 but following should be same)

subversion
nant
mono-jscript
- check that mono-core is installed

just in case you do not already have it installed

 sudo zypper install mono-data-oracle

A tip for OpenSuSE 11.1 users - you can install packages from the command line using the 'zypper' tool. For example, to install 'nant', use this command:

 sudo zypper install nant

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

(note that selecting mysql in the Yast2 Installer will select the other packages automatically)

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> use opensim;
mysql> create user 'opensim'@'localhost' identified by 'thePassword';
mysql> grant all on *.* to 'opensim'@'localhost';
mysql> quit

• note that the grant all command may differ if you're adding the opensim database to an existing mysql installation.

On current builds set the connection string inside bin/OpenSim.ini after coppying the OpenSim.ini.example file. If you are changing to MySQL from SQLite, the connection string for mysql also exists in the bin/Region/*xml files.

• It is important to remember this if you start out using the built-in SQLite database engine.

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

su -
cd /opt
Download opensim
cd opensim
./runprebuild.sh
nant

Or, if you have a current (0.6+), you can simply execute:

make

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.

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 (Works on iMac G5 with OS 10.4.11, including expanding to local grid mode.
• 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 (The more recent releases Mono 1.2.6, 1.9.1 and 2.0.1 do not appear to work with these installation instructions 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/old/libsl1550 opensim-libs
cd opensim-libs/openjpeg-libsl
make -f Makefile.osx
cp libopenjpeg-libsl-2.1.2.0.dylib ../../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. (It appears to work on iMac G5 with OS X 10.4.11.

• libsecondlife.dll: (for PowerPC Only, see details on this step installing OpenSim on PowerPC…or: of eggs and virtual worlds)

cd .. (back into opensim-libs)
nant
cp bin/libsecondlife.dll ../bin

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

You might find it work for your environment (OS X 10.5.7, Intel):

• make sure you have X11 installed
• grab the Apple Dev Tools from [1]
• install Mono Framework 2.4 from [2]
• Get OpenSim source:

 svn co http://opensimulator.org/svn/opensim/tags/0.6.5-post-fixes opensim

• Compile OpenSim:

 cd opensim
 ./runprebuild.sh
 nant

You might find it work for your environment (OS X 10.5.7 and 10.6, Intel) on (8/9/09):

• make sure you have X11 installed
• Very important to grab the latest Apple Dev Tools (3.2.1 on 8/9/09) (from [3] - You will need a developer account, it is free.
• install Mono Framework 2.4 (version 2.4.2.3 on 8/9/09) from [4]
• install Mac Ports from [5]
• Mac Ports should update its packages on install, but to be safe, type the following at the Terminal:

 sudo port -v selfupdate

• Use mac ports to install nant. (This should pull in everything you need. I think this will also try to install mono, but since I already had it installed, that errored on me. Don't worry about it though, it should install everything else you need.) At the Terminal type:

 sudo port install nant 
   

• Get OpenSim source. I downloaded 0.6.6 from [6]
• Uncompress the download.
• Compile OpenSim:

 cd opensim
 ./runprebuild.sh
 nant
 

• Then of course the issue with the 0.6.6 release.

This release had some bugs with default automatic configuration on the first startup of OpenSim.exe. bin/Regions/default.xml (region configuration file) is not automatically created in the main directory. Therefore, you must manually create this file. Here is an example.

<Root>
  <Config sim_UUID="UUID" sim_name="NAME" sim_location_x="1000" sim_location_y="1000"
 internal_ip_address="IP_ADDRESS_OF_SERVER" internal_ip_port="9000" allow_alternate_ports="false"
 external_host_name="DNS_NAME_OF_SERVER" master_avatar_uuid="00000000-0000-0000-0000-000000000000"
 estate_covanant_uuid="00000000-0000-0000-0000-000000000000" master_avatar_first="FIRST_NAME"
 master_avatar_last="SECOND_NAME" master_avatar_pass="PASSWORD" />
</Root>

You must change UUID, NAME, IP_ADDRESS_OF_SERVER, DNS_NAME_OF_SERVER, FIRST_NAME, SECOND_NAME and PASSWORD to your own values. (I noticed than IP_ADDRESS_OF_SERVER should be set to real IP not to 127.0.0.1)

Summary:

• Run OpenSim0.6.6Setup.exe and install OpenSim in Windows
• Run OpenSim.exe and enter default values - record them!
• Shutdown simulator (command: shutdown)
• Create default.xml with copy of above
• Change values in default.xml with recoded values
• Be sure default.xml be in main directory (same with OpenSim.ini)
• Run again OpenSim.exe
• Connect with viewer

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/
Download opensim
cd opensim
./runprebuild.sh
nant

Note: 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
Download 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 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 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 12 & 13

Fedora 12 and 13 installs are fairly simple. Nant and Mono now work out of the box with OpenSim. Incase you are completley new to this, here is a complete step by step guide to run OpenSim on a base install of Fedora (bare minimum of packages). It will also work on GUI installs.

1. yum install wget nano nant libgdiplus mono-devel mono-jscript

2. Download opensim (wget http://dist.opensimulator.org/opensim-0.7.0.1-source.tar.gz)

3. tar -xf opensim-0.7.0.1-source.tar.gz

4. mv opensim-0.7.0.1-source opensim

5. cd opensim

6. ./runprebuild.sh

7. nant

8. cd /bin

9. cd /config-include/

10. cp StandaloneCommon.ini.example StandaloneCommon.ini

11. cd ..

12. cp OpenSim.ini.example OpenSim.ini

13. mono OpenSim.exe

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 here

Debian 4

For detailed instructions please see Debian 4 Build Instructions

Debian 5

1. Install Debian in the usual way. In the package list choose just the last option - 'Standard system' Leave all other install options unchecked unless you have other reason to install them.

2. Log in as your root user make sure it works.

3. type: aptitude update (or apt-get update)

4. type: aptitude install nant and answer 'y' to 'Do you want to continue'- This will install nant and all of its dependancies.

5. type: apt-get install git-core and answer 'y' to 'Do you want to continue'.

6. type: aptitude install build-essential swig autoconf gawk mono-common binfmt-support bison libglib2.0-dev gettext and answer 'y' to 'Do you want to continue'

7. type: wget http://ftp.novell.com/pub/mono/sources/mono/mono-2.4.3.tar.bz2 to download mono

8. type: tar xf mono-2.4.3.tar.bz2 to extract the mono source code to a directory (substitute the latest build)

9. type: cd mono-2.4.3 to change int the directory you just created

10. type: ./configure --with-libgdiplus=yes - wait for it to finish

11. type: make - and wait some more as this takes a bit - moreso on older machines

12. type: make install

13. type: cd /

14 type: git clone git://opensimulator.org/git/opensim

15 type: cd opensim

16. type: git checkout -b 0.6.8-post-fixes origin/0.6.8-post-fixes (substitute the latest build)

17. type: git pull

18. type: apt-get -u upgrade and answer 'y' to 'do you want to continue?'. This will update all packages to their latest versions via apt (it will not upgrade opensim or mono as they were compiled seperately)

19. Reboot, just to make sure it all comes up cleanly (type: shutdown -r now)

20. Login, type: cd /

21. type: cd opensim

22. type: ./runprebuild.sh

23 type: nant - wait for this to finish

24. type: cd bin

25. type: cp OpenSim.ini.example OpenSim.ini

26. type: mono OpenSim.exe

27. Answer the onscreen wizard promts and Opensim will start in standalone mode.

To add MySql support type: apt-get install mysql-server and answer 'y' to 'Do you want to Continue'. You will be prompted for a password for the MySQL root user, enter it twice as requested. Edit OpenSim.ini to use MySql as directed elsewhere.

CentOS 5.2 32bit

For detailed instructions please see CentOS 5.2 Build Instructions

CentOS 5.3 32bit

For detailed installation and configuration instructions please see this blog

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 libode.so not found type of error, you will need to build libode from source.

Remove libode.so from the ./bin folder. (Note that subsequent svn updates may replace it again; best fix is to copy your built libode.so to bin). Do NOT remove ode.net.dll! 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 make -k if you get errors relating to drawstuff, test*, or openGL. make install should put libode.so in the proper place (usually /usr/local/lib), and it should be seen by opensim (ode.net.dll)

Note: if OpenSim fails to launch with Exception: System.DllNotFoundException: ode, after compiling ODE, just copy libode.so from its usual place (probably /usr/local/lib/) to ./bin/, as per this suggestion

Setting up ODE for 64 Bits systems:

HOWTO on setting up and Install OpenSim on SLES10 - SP1 64Bit

1. I installed Mono 2.01, added this installation source in Yast2

   This distro supports installing packages via YaST. Add the following installation source to YaST:
   * http://ftp.novell.com/pub/mono/download-stable/SLE_10 [^]
   For assistance with using repositories and installing packages with YaST, visit the Yast help page.

   "nant" was installed also via this operation.

2. I installed subversion from http://software.opensuse.org/search [^]

  SLES/SLED10 ->
  subversion-1.5.2-34.2.x86_64.rpm

3. I downloaded and installed the lastest SVN version of opensim as usual (like a 32 bit system):

  http://opensimulator.org/wiki/Build_Instructions [^]

4. I downloaded and installed the Open Dynamics Engine (ODE) to replace the 32 bit version of ODE with a 64 bit version.

  I did that with the following linux commands:
 (it is expected that you have all required Linux building tools installed):
  
  # cd
  # svn co http://opensimulator.org/svn/opensim-libs/trunk/unmanaged/OpenDynamicsEngine [^]
  # cd OpenDynamicEngine
  # chmod a+x ou/bootstrap
  # sh autogen.sh

I installed/updated SLES10 with these rpm's for autogen.sh to run properly. http://software.opensuse.org/search [^]

  SLES/SLED10 ->
  - autoconf-2.61-168.1.x86_64.rpm
  - automake-1.10.1-5.3.x86_64.rpm

  # CFLAGS="-m64" ./configure --enable-shared
  # make

I installed gtk2-devel via yast2, and all its dependancies, because make keept failing.

  # cp ./ode/src/.libs/libode.so /opt/opensim/bin/

note:
in this directory it had made several versions of the "libode.so" because of running the previous commands several times
so i had to copy libode.so.1.0.0 to /opt/opensim/bin/libode.so

  # vi ../opensim/bin/OpenSim.ini (change av_capsule_standup_tensor_linux to 1700000)

The 'chmod' command is required to fix permissions that are wrong. The change in OpenSim.ini is required to avoid that avatars have bend legs and/or their feet are in the ground.

Running

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

cd bin
mono OpenSim.exe

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

mono OpenSim.32BitLaunch.exe

• To invoke ODE, add the option:

-physics=OpenDynamicsEngine

to the mono OpenSim.exe line

or add physics = OpenDynamicsEngine to the [Startup] section of OpenSim.ini. 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).