Build Instructions

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(→‎Building)
(→‎Requirements)
(399 intermediate revisions by 83 users not shown)
Line 1: Line 1:
−
=Installing from source=
+
{{Quicklinks}}
  
−
==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 also is compiled with the C# and not the C++ IDE for those who are using the no-cost Express Editions from MS.
+
= Obtaining the Source Code =
  
−
=== Subversion Repository ===
+
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]].
  
−
1. Get the source code from the svn repository:
+
= Building =
  
−
svn://openmv.org/opensim/trunk
 
  
−
=== Building ===
+
Although this page is long, building is generally quite simple.  See the BUILDING.txt file in the distribution itself for simplified instructions.
  
−
2. In the top-level directory, run the 'runprebuild.bat' file. This will create both a VS2005 solution file, and a nant build file.
+
== Requirements ==
  
−
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.
+
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.
  
−
Note: if you want to implement collision-based physics, OpenDynamicsEngine (ODE) is the furthest along at the moment.  It is not fully supported, but is starting to work somewhat reliably using a small number of regions per sim.  You invoke ODE with the option -physics=OpenDynamicsEngine (can be added to opensim.ini under [Startup] as physics = OpenDynamicsEngine)
 
  
−
As installed from svn, ODE does not work on all platforms. If you get an ODE-related crash, and/or a libode or ode.dll not found type of error, you will need to do the following:
+
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.
  
−
remove libode.so (unix) or ode.dll (windows) from the ./bin folder.  Do NOT remove ode.net.dll!  Download ode 0.8 source packages from ode.org.  When compiling, make sure to use the following configure options:
 
  
−
--with-trimesh=gimpact
+
Other platforms may have own mono distributions, or may need to compile mono on them.
−
--enable-shared
+
  
−
make sure the configure script confirms these choices (on unix).  I forget exactly how to do this in visual studio, but there are copious docs in the source tree.  I believe I'm using OPCODE instead of GIMPACT on windows, and no, I don't remember why I did that.  Always compile with single precision.
 
  
−
=== Running ===
+
Other libraries used by OpenSimulator can be found at our opensim-libs git repo.
  
−
Double-click on the OpenSim.exe executable file in the 'bin' directory. This will start up OpenSim in standalone mode.
+
git clone git://opensimulator.org/git/opensim-libs
  
−
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 "chmod 777 *" from the bin directory solves this.
+
You may need to compile them for your platform, in particular the unmanaged ones like Bullet or ODE native code libraries
  
−
==Linux/Mac OS X==
+
== MS Windows ==
  
−
=== Subversion Repository ===
+
=== 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.
  
−
To check out the latest revision:
+
=== 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.
  
−
svn co svn://opensecondlife.org/opensim/trunk opensim.new/trunk
+
===Compiling at the Command Prompt ===
 +
# Run "runprebuild.bat".
 +
# Run the resulting "compile.bat" file.
  
−
Note: The libopenjpeg-libsl-...so is not really working. For this reason you should download the newest libsecondlife from http://www.libsecondlife.org, and build your own libopenjpeg library. If you use this instead of the SVN version, your sim will work fine.
+
== Linux and Other Mono Platforms ==
  
−
Note to Mac OS X users: OS X does not come packaged with subversion, so you will need to either install it or access the repository from a computer that does have subversion
+
=== Prepare to compile ===
 +
To create the several project files run on the folder opensim:
  
−
=== Building (Mono) ===
+
  ./runprebuild.sh
  
−
cd opensim.new/trunk
+
==== 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:
  
−
mono bin/Prebuild.exe /target nant
+
  nant
−
nant -buildfile:OpenSim.build
+
  
−
mono bin/Prebuild.exe /target nant
+
==== Compile with xbuild ====
−
nant -buildfile:OpenSim.build
+
  
−
(Yes, you must rerun the prebuild again after the first build, and then build again!)
+
On mono versions you can just use xbuild.
  
−
Later revisions(1657 and above) no longer require you to build twice.  Thus the procedure is simply as follows:
+
  xbuild
  
−
cd opensim.new/trunk
+
xbuild is no longer recommended on mono 5.x, but currently still works (5.12)
  
−
mono bin/Prebuild.exe /target nant
 
−
nant -buildfile:OpenSim.build
 
  
−
=== Running (Mono) ===
+
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
  
−
cd bin
+
==== Compile with msbuild ====
−
mono OpenSim.exe
+
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.
  
−
=Binary releases=
+
Use xbuild on the other cases.
  
−
Some recent pre-compiled releases are available at [http://www.lotusbell.com/opensim/ OpenSim binaries]. These are usually a few revs out-of-date.
+
Recent improvements, specially on JIT runtime, justify compiling in Release configuration, but you do lose some debug capabilities.
  
−
'''NB: This Link is currently non-functional -''' ''does anyone know where the Binaries now live??''<hr>
+
to compile with Debug configuration:
−
There are some older versions of the binaries [http://openmetaverse.org/opensim/builds/ here]
+
  msbuild
 +
 
 +
to compile with Release configuration:
 +
  msbuild /p:Configuration=Release
 +
 
 +
= Configuration =
 +
 
 +
See [[Configuration]].
 +
 
 +
[[Category:Users]]
 +
[[Category:Users]]
 +
[[Category:Getting Started]]

Revision as of 17:09, 6 February 2019

Languages Languages: 

En.png English   De.png Deutsch   Fr.png Français   Jp.png 日本語

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.

Retrieved from "http://opensimulator.org/index.php?title=Build_Instructions&oldid=47272"
Personal tools
General
About This Wiki