Build Instructions

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Supported Compilers)
(23 intermediate revisions by 2 users not shown)
Line 14: Line 14:
 
== Requirements ==
 
== Requirements ==
  
OpenSimulator 0.8.x and 0.9.0.x requires either  
+
OpenSimulator 0.9.0.x requires either  
 
* [http://msdn.microsoft.com/en-us/netframework/cc378097 .NET Framework 4.0] on Windows
 
* [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.
 
* [https://www.mono-project.com/download/stable/ Mono] on Linux or Mac.  Mono 2.10.8 is the minimum version.
Line 38: Line 38:
 
=== Supported Compilers ===
 
=== Supported Compilers ===
 
* [https://visualstudio.microsoft.com/downloads/ Visual Studio Community 2017]
 
* [https://visualstudio.microsoft.com/downloads/ Visual Studio Community 2017]
Any version that does support the .Net version can be used. For example for opensimulator versions prior to 0.9.1, VS2010 can be used.
+
* 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 ===
 
=== Compiling in an IDE ===
Line 44: Line 44:
 
# Open the resulting "OpenSim.sln" in Visual Studio IDE.
 
# Open the resulting "OpenSim.sln" in Visual Studio IDE.
 
# Select Debug or Release configuration
 
# Select Debug or Release configuration
# Build (or Debug) -> Build Solution.
+
# Menu Build -> Build Solution.
  
 
===Compiling at the Command Prompt ===
 
===Compiling at the Command Prompt ===
Line 50: Line 50:
 
# Run the resulting "compile.bat" file.
 
# Run the resulting "compile.bat" file.
  
== Linux ==
+
== Linux and Other Mono Platforms ==
  
 
=== Prepare to compile ===
 
=== Prepare to compile ===
 
To create the several project files run on the folder opensim:
 
To create the several project files run on the folder opensim:
  
  ./runprebuild.sh
+
  ./runprebuild.sh
  
=== Compile with Nant ===
+
==== Compile with Nant ====
On some mono versions, in particular old ones just run:
+
On some mono versions, in particular old ones may need the use of nant to proper compile OpenSimulator, in that case just run:
  
 
   nant
 
   nant
  
 +
==== Compile with xbuild ====
  
=== Compile with xbuild ===
+
On mono versions you can just use xbuild.
 
+
other mono versions, including mono5.12 support xbuild
+
  
 
   xbuild
 
   xbuild
  
=== Compile with msbuild ===
+
xbuild is no longer recommended on mono 5.x, but currently still works (5.12)
Mono 5.x recommends the use of msbuild
+
 
 +
 
 +
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
 
   msbuild
 
+
 
 +
to compile with Release configuration:
 +
  msbuild /p:Configuration=Release
  
 
= Configuration =
 
= Configuration =

Revision as of 04:12, 27 November 2018

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 requires either


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