Build Instructions
From OpenSimulator
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
- .NET Framework 4.0 on Windows
- Mono on Linux or Mac. Mono 2.10.8 is the minimum version.
You may also need nant tool.
OpenSimulator 0.9.1 (including current master) requires either
- .NET Framework 4.6 on Windows
- Mono on Linux or Mac. Mono 5.12 is the minimum recommended version.
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
- Run "runprebuild.bat"
- Open the resulting "OpenSim.sln" in Visual Studio IDE.
- Select Debug or Release configuration
- Menu Build -> Build Solution.
Compiling at the Command Prompt
- Run "runprebuild.bat".
- 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) >>>> xbuild tool is deprecated and will be removed in future updates, use msbuild instead <<<<
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. (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
Configuration
See Configuration.
