Build Instructions

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Building)
(Requirements)
(236 intermediate revisions by 61 users not shown)
Line 1: Line 1:
[[Category:Users]]
+
{{Quicklinks}}
=Installing from source=
+
  
==Download from SVN==
+
This page covers building OpenSimulator from source code on multiple platforms.  Please help us keep this page up to date as the project progresses. If you just want to run OpenSimulator, [[Download]] and [[Configuration|run]] the binary build instead. In the most cases, you should be fine with binaries.
Check out the [[Download]] Section
+
  
==MS Windows==
+
= Obtaining the Source Code =
  
OpenSim requires either the .Net framework version 2.0, or the latest Mono. It supports the following compilers:
+
Check out the [[Download]] page for instructions on obtaining an OpenSimulator source release. If you want the current development code (i.e. the Git master branch) see [[Developer_Documentation#Source_Code_Repository_Access]].
* [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!
+
= Building =
  
=== Building ===
 
  
* In the top-level directory, run the '<tt>runprebuild.bat</tt>' file. This will create both a VS2005 solution file, and a nant build file.
+
Although this page is long, building is generally quite simple.  See the BUILDING.txt file in the distribution itself for simplified instructions.
* 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.
+
== Requirements ==
  
==== Physics ====
+
OpenSimulator 0.9.0.x requires either
 +
* [http://msdn.microsoft.com/en-us/netframework/cc378097 .NET Framework 4.0] on Windows
 +
* [https://www.mono-project.com/download/stable/ Mono] on Linux or Mac.  Mono 2.10.8 is the minimum version.
 +
You may also need nant tool.
  
===== 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 <i>ode.dll not found</i> type of error (which can occur even though the dll is present!), try to build ode from source, follow the directions on [[PhysicsEngines]].
+
OpenSimulator 0.9.1 (including current master) requires either
 +
* [http://msdn.microsoft.com/en-us/netframework/cc378097 .NET Framework 4.6] on Windows
 +
* [https://www.mono-project.com/download/stable/ Mono] on Linux or Mac. Mono 5.12 is the minimum recommended version.
 +
recommend compiling with msbuild.
  
Be sure you don't already have a system library version of libode.so that's being used instead of the one in the bin folder of your opensimulator distribution
 
  
=== Running ===
+
Other platforms may have own mono distributions, or may need to compile mono on them.
  
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.
+
Other libraries used by OpenSimulator can be found at our opensim-libs git repo.
  
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.
+
git clone git://opensimulator.org/git/opensim-libs
  
Physics can be invoked by adding the appropriate line to the [Startup] section of <tt>OpenSim.ini</tt>.  For ODE, that would be:
+
You may need to compile them for your platform, in particular the unmanaged ones like Bullet or ODE native code libraries
  
physics = OpenDynamicsEngine
+
== MS Windows ==
  
You can also add a command line option to a shortcut, or run from a command prompt with:
+
=== Supported Compilers ===
 +
* [https://visualstudio.microsoft.com/downloads/ Visual Studio Community 2017]
 +
* Or any version that does support the .Net version. At least VS2010 for versions prior to 0.91, VS2015 for 0.91 and after.
  
-physics=OpenDynamicsEngine
+
=== Compiling in an IDE ===
 +
# Run "runprebuild.bat"
 +
# Open the resulting "OpenSim.sln" in Visual Studio IDE.
 +
# Select Debug or Release configuration
 +
# Menu Build -> Build Solution.
  
'''''Windows Vista'''''
+
===Compiling at the Command Prompt ===
 +
# Run "runprebuild.bat".
 +
# Run the resulting "compile.bat" file.
  
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.
+
== Linux and Other Mono Platforms ==
  
If you have McAfee SecurityCenter, see the description below.
+
=== Prepare to compile ===
 +
To create the several project files run on the folder opensim:
  
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.
+
  ./runprebuild.sh
  
 +
==== Compile with Nant ====
 +
On some mono versions, in particular old ones may need the use of nant to proper compile OpenSimulator, in that case just run:
  
'''''McAfee Security'''''
+
  nant
  
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.
+
==== Compile with xbuild ====
  
''Disable firewall''
+
On mono versions you can just use xbuild.
  
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".
+
  xbuild
  
''Enable <tt>OpenSim.exe</tt> to open ports''
+
xbuild is no longer recommended on mono 5.x, but currently still works (5.12)
  
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.
+
on more recent monos Release configuration may give some performance gain, but you do lose some debug capabilities.
 +
to compile Release configuration:
 +
  xbuild /p:Configuration=Release
  
Finally, select "OK" and exit the McAfee SecurityCenter window.
+
==== Compile with msbuild ====
 +
For Opensim 0.9.1 you can still use xbuild but Mono recommends the use of msbuild. You might need to install the package msbuild in addition to mono-complete for that.
  
==Linux/Mac OS X/FreeBSD==
+
Use xbuild on the other cases.
  
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.
+
Recent improvements, specially on JIT runtime, justify compiling in Release configuration, but you do lose some debug capabilities.
[[Installing and running on x86-64]]
+
  
===Building===
+
to compile with Debug configuration:
 +
  msbuild
  
Steps to get packages that are needed to compile the source.
+
to compile with Release configuration:
 +
  msbuild /p:Configuration=Release
  
'''FreeBSD 6.2'''
+
= Configuration =
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]
+
See [[Configuration]].
"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/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. --[[User:Mokele|Mokele]] 11:41, 9 February 2008 (PST)
 
 
 
'''Ubuntu 8.04'''
 
 
Basically the same instructions as in Ubuntu 7.10.
 
 
sudo apt-get install subversion nant mono-gmcs libmono-microsoft8.0-cil libmono-system-runtime2.0-cil libgdiplus
 
svn co http://opensimulator.org/svn/opensim/trunk opensim
 
cd opensim
 
./runprebuild.sh
 
nant
 
 
* If you get an exception "System.NotSupportedException: CodePage 1252 not supported" running OpenSim with MySql, install also libmono-i18n2.0-cil.
 
 
sudo apt-get install libmono-i18n2.0-cil
 
 
* The  above steps work on running OpenSim revision 4612 on Ubuntu Server 8.04.
 
--[[User:Trains|Trains]] 10 May 2008
 
 
 
'''openSUSE 10.3'''
 
 
Install an openSUSE 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.
 
subversion (1.4.4)
 
nant (0.85)
 
mono-jscript
 
- check that mono-core is installed
 
 
* 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
 
 
Build after installation of above in bash terminal.
 
 
su -
 
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.
 
 
 
'''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/1.2.5/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, not sure about Intel. 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 libsecondlife.dll ../../opensim/bin
 
 
* Edit the libsecondlife.dll.config (PowerPC Only). Remove the cpu="x86" tag in the last dllmap line.
 
 
'''RedHat'''
 
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
 
 
=== Physics ===
 
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 <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 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 <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.
 
cd bin
 
mono OpenSim.exe
 
 
* 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).
 
 
===Dependencies===
 
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
 
 
[[Category:Users]]
 
[[Category:Users]]
 +
[[Category:Users]]
 +
[[Category:Getting Started]]

Revision as of 17:09, 6 February 2019

This page covers building OpenSimulator from source code on multiple platforms. Please help us keep this page up to date as the project progresses. If you just want to run OpenSimulator, Download and run the binary build instead. In the most cases, you should be fine with binaries.

Contents

Obtaining the Source Code

Check out the Download page for instructions on obtaining an OpenSimulator source release. If you want the current development code (i.e. the Git master branch) see Developer_Documentation#Source_Code_Repository_Access.

Building

Although this page is long, building is generally quite simple. See the BUILDING.txt file in the distribution itself for simplified instructions.

Requirements

OpenSimulator 0.9.0.x requires either

You may also need nant tool.


OpenSimulator 0.9.1 (including current master) requires either

recommend compiling with msbuild.


Other platforms may have own mono distributions, or may need to compile mono on them.


Other libraries used by OpenSimulator can be found at our opensim-libs git repo.

git clone git://opensimulator.org/git/opensim-libs

You may need to compile them for your platform, in particular the unmanaged ones like Bullet or ODE native code libraries

MS Windows

Supported Compilers

  • Visual Studio Community 2017
  • Or any version that does support the .Net version. At least VS2010 for versions prior to 0.91, VS2015 for 0.91 and after.

Compiling in an IDE

  1. Run "runprebuild.bat"
  2. Open the resulting "OpenSim.sln" in Visual Studio IDE.
  3. Select Debug or Release configuration
  4. Menu Build -> Build Solution.

Compiling at the Command Prompt

  1. Run "runprebuild.bat".
  2. Run the resulting "compile.bat" file.

Linux and Other Mono Platforms

Prepare to compile

To create the several project files run on the folder opensim:

 ./runprebuild.sh

Compile with Nant

On some mono versions, in particular old ones may need the use of nant to proper compile OpenSimulator, in that case just run:

 nant

Compile with xbuild

On mono versions you can just use xbuild.

 xbuild

xbuild is no longer recommended on mono 5.x, but currently still works (5.12)


on more recent monos Release configuration may give some performance gain, but you do lose some debug capabilities. to compile Release configuration:

 xbuild /p:Configuration=Release

Compile with msbuild

For Opensim 0.9.1 you can still use xbuild but Mono recommends the use of msbuild. You might need to install the package msbuild in addition to mono-complete for that.

Use xbuild on the other cases.

Recent improvements, specially on JIT runtime, justify compiling in Release configuration, but you do lose some debug capabilities.

to compile with Debug configuration:

  msbuild

to compile with Release configuration:

  msbuild /p:Configuration=Release

Configuration

See Configuration.

Personal tools
General
About This Wiki