Build Instructions

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Supported Compilers)
(MS Windows)
 
(12 intermediate revisions by 2 users not shown)
Line 20: Line 20:
  
  
OpenSimulator 0.9.1 requires either
+
OpenSimulator 0.9.1 (including current master) requires
 
* [http://msdn.microsoft.com/en-us/netframework/cc378097 .NET Framework 4.6] on Windows  
 
* [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.
 
* [https://www.mono-project.com/download/stable/ 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 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:
  
Other libraries used by OpenSimulator can be found at our opensim-libs git repo.
+
git clone git://opensimulator.org/git/opensim-libs
  
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
 
You may need to compile them for your platform, in particular the unmanaged ones like Bullet or ODE native code libraries
Line 39: Line 40:
 
* [https://visualstudio.microsoft.com/downloads/ Visual Studio Community 2017]
 
* [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.
 
* 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.1 Support Microsoft Visual Studio 2019 Enterprise Professional Community (runprebuild.bat ln11-18).
  
 
=== Compiling in an IDE ===
 
=== Compiling in an IDE ===
Line 64: Line 66:
 
==== Compile with xbuild ====
 
==== Compile with xbuild ====
  
On mono versions you can just use xbuild.
+
On mono versions you can just use xbuild. ''(msbuild is recommended for 0.9.1.0.0+)''
  
 
   xbuild
 
   xbuild
Line 70: Line 72:
 
xbuild is no longer recommended on mono 5.x, but currently still works (5.12)
 
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.
+
On more recent mono versions Release configuration may give some performance gain, but you do lose some debug capabilities.
 
to compile Release configuration:
 
to compile Release configuration:
 
   xbuild /p:Configuration=Release
 
   xbuild /p:Configuration=Release
  
 
==== Compile with msbuild ====
 
==== 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.
+
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.
+
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.
 
Recent improvements, specially on JIT runtime, justify compiling in Release configuration, but you do lose some debug capabilities.

Latest revision as of 01:34, 11 August 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

[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] 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.1 Support Microsoft Visual Studio 2019 Enterprise Professional Community (runprebuild.bat ln11-18).

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

[edit] Configuration

See Configuration.

Personal tools
General
About This Wiki