Build Instructions

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Ubuntu 7.10)
m (Install dotnet under Debian/Ubuntu)
 
(399 intermediate revisions by 71 users not shown)
Line 1: Line 1:
[[Category:Users]]
+
{{Quicklinks|Build_Instructions}}
=Installing from source=
+
  
==MS Windows==
+
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.
  
OpenSim requires either the .Net framework version 2.0, or the latest Mono. It supports the following compilers:
+
= Obtaining the Source Code =
* [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!
+
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 =
  
=== Subversion Repository ===
 
  
1. Get the nightly build source code from the svn repository:
+
Although this page is long, building is generally quite simple. See the BUILDING.txt file in the distribution itself for simplified instructions.
  
http://opensimulator.org/svn/opensim/trunk
+
== Version 0.9.3.0 and above ==
 +
Microsoft stopped the development of .Net Framework and Mono, replacing them by new dotnet
 +
This is a significant breaking change that we try to follow on 0.9.3.0.
  
2. Get 0.4.5.2 Stable version  from svn repository:
+
=== Get source code ===
svn co http://opensimulator.org/svn/opensim/tags/0.4.5.2-stable opensim
+
  
=== Building ===
+
get or update source from git
  
2. 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.
+
git clone git://opensimulator.org/git/opensim
  
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.
+
=== Building on Windows ===
 +
To building under Windows, the following is required:
  
If you don't care about physics (walking on prims, etc), ignore the rest of this section.
+
* [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 dotnet 8.0 SDK]
  
==== Physics ====
+
optionally also
  
===== Open Dynamics Engine (ODE) =====
+
* Visual Studio .NET, version 2022 or later
  
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 using the debug version of the dll, available here:
+
Create the project files running:
  
http://www.squiggle.com/opensim/ode-debug.dll <br>
+
runprebuild.bat
  
Rename it <tt>ode.dll</tt> and put it in <tt>.\bin</tt>, replacing the stock <tt>ode.dll</tt>. 
+
Load the generated OpenSim.sln into Visual Studio and build the solution, or just run
 +
compile.bat
  
 +
to run you may also need
 +
* to install the [https://docs.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170 run time files for vc++]
 +
* to authorize the install of older .NetFramework 3.5
  
If you do want to try to build ode from source, follow the directions on [[PhysicsEngines]].
 
  
You can also try building <tt>ode.dll</tt> from the latest version of the source (http://www.ode.org/; make sure to enable trimesh)
+
Configure, See [[Configuration]].
  
=== 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.
+
Now just run OpenSim.exe from the bin folder, and set up the region.
  
Double-click on the <tt>OpenSim.exe</tt> executable file in the <tt>bin</tt> directory. This will start up OpenSim in standalone mode.
+
=== Building on Linux / Mac ===
  
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.
+
you will need
 +
* [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 dotnet 8.0 SDK]
 +
* libgdiplus
 +
**if you have mono 6.x complete, you already have libgdiplus, otherwise you need to install it using a package manager for your operating system, like apt, brew, macports, etc. For example on debian:
 +
*** apt-get update && apt-get install -y apt-utils libgdiplus libc6-dev
  
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
+
Create the project files, run:
  
You can also add a command line option to a shortcut, or run from a command prompt with:
+
./runprebuild.sh
  
  -physics=OpenDynamicsEngine
+
then run
 +
  dotnet build --configuration Release OpenSim.sln
  
'''''Windows Vista'''''
+
or just
 +
./compile.sh
  
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.
+
Configure. See [[Configuration]].
  
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.
 
  
 +
run ./opensim.sh from the bin folder, and set up the region
  
'''''McAfee Security'''''
+
== Older Versions ==
 +
  Source for old .Net Framework 4.x and Mono is in branch Mono-Net4X
 +
  This is mostly same code as 0.9.2.2 release.
  
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.
+
== Requirements ==
  
''Disable firewall''
+
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 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''
+
OpenSimulator >= 0.9.1 (including current master) requires
 +
* [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.<br>'''Note:''' rather than using your Linux distro's Mono packages, which may be missing required components, please [https://www.mono-project.com/download/stable/ install from the official Mono repo for your distro].
 +
recommend compiling with msbuild.
  
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.
+
Other platforms may have own mono distributions, or may need to compile mono on them.
  
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.
+
Other libraries used by OpenSimulator can be found at our opensim-libs git repo:
  
Finally, select "OK" and exit the McAfee SecurityCenter window.
+
git clone git://opensimulator.org/git/opensim-libs
  
==Linux/Mac OS X/FreeBSD==
+
libOpenMetaVerse used can be found at https://bitbucket.org/opensimulator/
  
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.
+
You may need to compile them for your platform, in particular the unmanaged ones like Bullet or ODE native code libraries
[[Installing and running on x86-64]]
+
  
=== Install Steps for Unix Platforms ===
+
== MS Windows ==
  
Steps to get packages that are needed to compile the source.
+
=== 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.
 +
* OpenSimulator >=0.9.2.0 can compile for .Net Framework 4.8 using runprebuild48.bat instead of runprebuild.bat below and with VS2017/19/22
  
==== FreeBSD 6.2 ====
+
=== Compiling in an IDE ===
su
+
# Run "runprebuild.bat"
cd /usr/ports/devel/subversion/ && make install clean (you may also need to rebuild apr-svn if this step fails)
+
# Open the resulting "OpenSim.sln" in Visual Studio IDE.
cd /usr/ports/lang/mono/ && make install clean
+
# Select Debug or Release configuration
cd /usr/ports/devel/nant/ && make install clean
+
# Menu Build -> Build Solution.
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:
+
===Compiling at the Command Prompt ===
cd /usr/ports/graphics/libGL/ && make install clean
+
# Run "runprebuild.bat".
cd /usr/ports/graphics/libGLU/ && make install clean
+
# Run the resulting "compile.bat" file.
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 ====
+
== Linux and Other Mono Platforms ==
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.
+
=== Install dotnet under Debian/Ubuntu ===
* 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)
+
  
==== Mac OS X 10.5 ====
+
For Ubuntu 22.04 LTS and higher, dotnet is available in the distribution's repos.  
* 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
+
export PKG_CONFIG_PATH="/Library/Frameworks/Mono.framework/Versions/1.2.5/lib/pkgconfig/:${PKG_CONFIG_PATH}"
+
  
* Compile OpenSim
+
For Ubuntu 20.04 LTS and lower, and for all versions of Debian, add Microsoft repository to your installation :
svn co http://opensimulator.org/svn/opensim/trunk opensim
+
cd opensim
+
./runprebuild.sh
+
nant
+
  
* Download and Compile libopenjpeg-libsl-2.1.2.0.dylib
+
<source lang="bash">
svn co svn://opensecondlife.org/libsl/trunk libsl
+
# Get OS version info
cd libsl/openjpeg-libsl
+
source /etc/os-release
make -f Makefile.osx
+
cp libopenjpeg-libsl-2.1.2.0.dylib ../../opensim/bin
+
  
==== Mac OS X 10.4 ====
+
# Download Microsoft signing key and repository
* 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.
+
wget https://packages.microsoft.com/config/$ID/$VERSION_ID/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
* 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
+
export PKG_CONFIG_PATH="/Library/Frameworks/Mono.framework/Versions/1.2.5/lib/pkgconfig/:${PKG_CONFIG_PATH}"
+
  
* Compile OpenSim
+
# Install Microsoft signing key and repository
svn co http://opensimulator.org/svn/opensim/trunk opensim
+
sudo dpkg -i packages-microsoft-prod.deb
cd opensim
+
./runprebuild.sh
+
nant
+
  
* Download and Compile libopenjpeg-libsl-2.1.2.0.dylib
+
# Clean up
svn co svn://opensecondlife.org/libsl/trunk libsl
+
rm packages-microsoft-prod.deb
cd libsl/openjpeg-libsl
+
make -f Makefile.osx
+
cp libopenjpeg-libsl-2.1.2.0.dylib ../../opensim/bin.
+
  
=== Running (Mono) ===
+
# Update packages
 +
sudo apt update
 +
</source>
  
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.
+
Then :
  
cd bin
+
<source lang="bash">
mono OpenSim.exe
+
sudo apt update
 +
sudo apt install dotnet-sdk-8.0
 +
</source>
  
to invoke ODE, add the option:
+
https://learn.microsoft.com/en-us/dotnet/core/install/linux-ubuntu<br/>
-physics=OpenDynamicsEngine
+
https://learn.microsoft.com/en-us/dotnet/core/install/linux-debian<br/>
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.
+
=== Prepare to compile ===
 +
To create the several project files run on the folder opensim:
  
On mono 1.2.6, some distributions may see
+
  ./runprebuild.sh
  
Unhandled Exception: System.NotSupportedException: CodePage 1252 not supported
+
==== 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:
  
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).
+
  nant
  
=== Physics (Unix) ===
+
==== Compile with xbuild ====
  
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.
+
On mono versions you can just use xbuild. ''(msbuild is recommended for 0.9.1.0.0+)''
  
==== Open Dynamics Engine (ODE) ====
+
  xbuild
  
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.
+
xbuild is no longer recommended on mono 5.x, but currently still works (5.12)
  
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:
+
''>>>> xbuild tool is deprecated and will be removed in future updates, use msbuild instead <<<<''
  
--with-trimesh=gimpact
+
On more recent mono versions Release configuration may give some performance gain, but you do lose some debug capabilities.
--enable-shared
+
to compile Release configuration:
 +
  xbuild /p:Configuration=Release
  
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>)
+
==== 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. (Currently msbuild is included if you install mono-complete, on Ubuntu, from the official mono repositories. https://www.mono-project.com/download/stable/#download-lin )
  
==== MAC OS X ====
+
Use xbuild on the other cases as a last resort.
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. --[[User:Mokele|Mokele]] 11:32, 9 February 2008 (PST)
+
  
=== External tutorials and howtos ===
+
Recent improvements, specially on JIT runtime, justify compiling in Release configuration, but you do lose some debug capabilities.
[http://nonumerable.net/metaverso-opensim-en-gnulinux/ Spanish howto: Opensim in GNU/Linux]
+
  
[http://www.secondlifefrance.com/index.php/Tutoriels-OpenSim/installer-opensim-sur-un-serveur-linux.html French How To: Installer OpenSim sur un serveur Linux en réseau]
+
to compile with Debug configuration:
 +
  msbuild
  
=Binary releases=
+
to compile with Release configuration:
 +
  msbuild /p:Configuration=Release
  
Nightly builds, in tar-gzip format:
+
to compile with the debug configuration and detailed opensim.log file can then be read with a text editor:
 +
  msbuild /p:Configuration=Debug /fileLogger /flp:logfile=opensim.log /v:d
  
http://ruth.petitbe.be/build/
+
you can specify the following values for the level of detail of the opensim.log file:
 +
  q [quiet], m [minimal], n [normal], d [detailed] and diag [diagnostic].
  
The following packages and their dependencies are required to run OpenSim on a default Debian 4 netinstall:
+
To compile for .Net Framework 4.8 with mono >=6.12. you can run runprebuild48.sh instead of runprebuild.sh above. Not much gain doing that, if any.
* mono
+
* libmono-corlib2.0-cil
+
* libmono-sqlite2.0-cil
+
* libmono-system-web2.0-cil
+
* libmono-microsoft8.0-cil
+
* libmono-system-runtime2.0-cil
+
  
 +
== Ahead of Time compilation (AOT)==
 +
As you all know the files *.exe and .dll created by the compiling process above do no contain native code for the machine.<br>
 +
With those files, the native code required by the cpu is created at runtime, as needed, in a process known as Just in Time (JIT)<br>
 +
It is possible to do another compile stage on those files to create native code, that will ready when the program starts. This is the Ahead of time process (AOT).<br>
 +
Since JIT is done at runtime, it has limited time to do extensive code optimizations, AOT on the other hand can do all.<br>
 +
AOT should this way be faster to load, save some the memory needed by JIT work, and reduce latency due to code generation when a new code section is needed.<br>
 +
This way AOT helps reduce the huge performance gap between C# and a more proper language like C++, even considering JIT can do some optimization dependent on current code execution state, that AOT can't. (if you think c# is as fast as competent c++ code, better change what you are smoking...)<br>
 +
In fact both .net and mono do AOT on their components during install<br>
 +
JIT will still be active, compiling some other code at run time. OpenSim and used .net/mono framework parts depend on it.<br>
 +
 +
For Linux, 0.9.2.0 now includes scripts makeaot.sh and cleanaot.sh to help testing AOT.<br>
 +
Run makeaot.sh after the compile stage above, to generate the native code files. The option -O=all must be added to mono when executing opensim.exe, ex:<br>
 +
mono --desktop -O=all OpenSim.exe
 +
Script cleanaot.sh removes the binary files used by AOT. You must run it if you recompile the code (to be safe even if running makeaot).<br>
 +
<b>DO NOT FORGET to run makeaot.sh or cleanaot.sh after recompile!</b><br>
 +
The generated files are specific for that machine. <b>Do not copy the native code files to other machine, unless it is absolutely identical</b><br>
 +
The original .exe and .dll are still needed<br>
 +
 +
AOT is also possible in windows, but using different tools, and those add things to central repository on the machine, harder to isolate and maintain. see [https://docs.microsoft.com/en-us/dotnet/framework/tools/ngen-exe-native-image-generator ngen]<br>
 +
 +
Macs are.. Macs.. Future models may totally forbid JIT, like Apple mobile products do. Mono AOT on current Macs may work as on Linux<br>
 +
 +
In practical use, don't expect much more than a bit faster loading.<br>
 +
Additionally, since compilation is different, it may add new issues. So test with care<br>
 +
Opensim performance issues are mostly on its own code, terrible bad communications protocols, use of bad .net/mono framework code (demo quality in same cases), etc.<br>
 +
And of course eternally broken GC<br>
 +
But... well every ns counts..<br>
 +
 +
= Configuration =
 +
 +
See [[Configuration]].
 +
 +
[[Category:Users]]
 +
[[Category:Users]]
 
[[Category:Getting Started]]
 
[[Category:Getting Started]]

Latest revision as of 12:39, 15 May 2024

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

[edit] 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.

[edit] Building

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

[edit] Version 0.9.3.0 and above

Microsoft stopped the development of .Net Framework and Mono, replacing them by new dotnet This is a significant breaking change that we try to follow on 0.9.3.0.

[edit] Get source code

get or update source from git

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

[edit] Building on Windows

To building under Windows, the following is required:

optionally also

  • Visual Studio .NET, version 2022 or later


Create the project files running:

runprebuild.bat

Load the generated OpenSim.sln into Visual Studio and build the solution, or just run

compile.bat

to run you may also need


Configure, See Configuration.


Now just run OpenSim.exe from the bin folder, and set up the region.

[edit] Building on Linux / Mac

you will need

  • dotnet 8.0 SDK
  • libgdiplus
    • if you have mono 6.x complete, you already have libgdiplus, otherwise you need to install it using a package manager for your operating system, like apt, brew, macports, etc. For example on debian:
      • apt-get update && apt-get install -y apt-utils libgdiplus libc6-dev


Create the project files, run:

./runprebuild.sh

then run

dotnet build --configuration Release OpenSim.sln

or just

./compile.sh


Configure. See Configuration.


run ./opensim.sh from the bin folder, and set up the region

[edit] Older Versions

  Source for old .Net Framework 4.x and Mono is in branch Mono-Net4X 
  This is mostly same code as 0.9.2.2 release.

[edit] Requirements

OpenSimulator 0.9.0.x requires either

You may also need nant tool.


OpenSimulator >= 0.9.1 (including current master) requires

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

libOpenMetaVerse used can be found at https://bitbucket.org/opensimulator/

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

[edit] MS Windows

[edit] 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.
  • OpenSimulator >=0.9.2.0 can compile for .Net Framework 4.8 using runprebuild48.bat instead of runprebuild.bat below and with VS2017/19/22

[edit] 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.

[edit] Compiling at the Command Prompt

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

[edit] Linux and Other Mono Platforms

[edit] Install dotnet under Debian/Ubuntu

For Ubuntu 22.04 LTS and higher, dotnet is available in the distribution's repos.

For Ubuntu 20.04 LTS and lower, and for all versions of Debian, add Microsoft repository to your installation :

# Get OS version info
source /etc/os-release
 
# Download Microsoft signing key and repository
wget https://packages.microsoft.com/config/$ID/$VERSION_ID/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
 
# Install Microsoft signing key and repository
sudo dpkg -i packages-microsoft-prod.deb
 
# Clean up
rm packages-microsoft-prod.deb
 
# Update packages
sudo apt update

Then :

sudo apt update
sudo apt install dotnet-sdk-8.0

https://learn.microsoft.com/en-us/dotnet/core/install/linux-ubuntu
https://learn.microsoft.com/en-us/dotnet/core/install/linux-debian

[edit] Prepare to compile

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

 ./runprebuild.sh

[edit] 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

[edit] Compile with xbuild

On mono versions you can just use xbuild. (msbuild is recommended for 0.9.1.0.0+)

 xbuild

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

>>>> xbuild tool is deprecated and will be removed in future updates, use msbuild instead <<<<

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

 xbuild /p:Configuration=Release

[edit] 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. (Currently msbuild is included if you install mono-complete, on Ubuntu, from the official mono repositories. https://www.mono-project.com/download/stable/#download-lin )

Use xbuild on the other cases as a last resort.

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

to compile with the debug configuration and detailed opensim.log file can then be read with a text editor:

  msbuild /p:Configuration=Debug /fileLogger /flp:logfile=opensim.log /v:d

you can specify the following values for the level of detail of the opensim.log file:

  q [quiet], m [minimal], n [normal], d [detailed] and diag [diagnostic].

To compile for .Net Framework 4.8 with mono >=6.12. you can run runprebuild48.sh instead of runprebuild.sh above. Not much gain doing that, if any.

[edit] Ahead of Time compilation (AOT)

As you all know the files *.exe and .dll created by the compiling process above do no contain native code for the machine.
With those files, the native code required by the cpu is created at runtime, as needed, in a process known as Just in Time (JIT)
It is possible to do another compile stage on those files to create native code, that will ready when the program starts. This is the Ahead of time process (AOT).
Since JIT is done at runtime, it has limited time to do extensive code optimizations, AOT on the other hand can do all.
AOT should this way be faster to load, save some the memory needed by JIT work, and reduce latency due to code generation when a new code section is needed.
This way AOT helps reduce the huge performance gap between C# and a more proper language like C++, even considering JIT can do some optimization dependent on current code execution state, that AOT can't. (if you think c# is as fast as competent c++ code, better change what you are smoking...)
In fact both .net and mono do AOT on their components during install
JIT will still be active, compiling some other code at run time. OpenSim and used .net/mono framework parts depend on it.

For Linux, 0.9.2.0 now includes scripts makeaot.sh and cleanaot.sh to help testing AOT.
Run makeaot.sh after the compile stage above, to generate the native code files. The option -O=all must be added to mono when executing opensim.exe, ex:

mono --desktop -O=all OpenSim.exe

Script cleanaot.sh removes the binary files used by AOT. You must run it if you recompile the code (to be safe even if running makeaot).
DO NOT FORGET to run makeaot.sh or cleanaot.sh after recompile!
The generated files are specific for that machine. Do not copy the native code files to other machine, unless it is absolutely identical
The original .exe and .dll are still needed

AOT is also possible in windows, but using different tools, and those add things to central repository on the machine, harder to isolate and maintain. see ngen

Macs are.. Macs.. Future models may totally forbid JIT, like Apple mobile products do. Mono AOT on current Macs may work as on Linux

In practical use, don't expect much more than a bit faster loading.
Additionally, since compilation is different, it may add new issues. So test with care
Opensim performance issues are mostly on its own code, terrible bad communications protocols, use of bad .net/mono framework code (demo quality in same cases), etc.
And of course eternally broken GC
But... well every ns counts..

[edit] Configuration

See Configuration.

Personal tools
General
About This Wiki