Build Instructions

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(→‎Open Dynamics Engine (ODE))
m (→‎Install dotnet under Debian/Ubuntu)
 
(480 intermediate revisions by 86 users not shown)
Line 1: Line 1:
−
=Installing from source=
+
{{Quicklinks|Build_Instructions}}
  
−
==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.
+
== 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.
  
−
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.
+
=== Get source code ===
  
−
If you don't care about physics (walking on prims, etc), ignore the rest of this section.
+
get or update source from git
  
−
==== Physics ====
+
git clone git://opensimulator.org/git/opensim
  
−
===== Open Dynamics Engine (ODE) =====
+
=== Building on Windows ===
 +
To building under Windows, the following is required:
  
−
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.
+
* [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 dotnet 8.0 SDK]
  
−
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,  try using the debug version of the dll.  The release version appears to crash on some CPU's (the error is usually "ode.dll not found", but it's misleading because the dll may still be there, but crashing.) The debug version is available here:
+
optionally also
  
−
http://www.squiggle.com/opensim/ode-debug.dll <br>
+
* Visual Studio .NET, version 2022 or later
  
−
Rename it ode.dll and put it in .\bin, replacing the stock ode.dll.  You can also try building ode.dll from souce (ode.org, version 0.8; make sure to enable trimesh)
 
  
−
=== Running ===
+
Create the project files running:
  
−
Double-click on the OpenSim.exe executable file in the 'bin' directory. This will start up OpenSim in standalone mode.
+
runprebuild.bat
  
−
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.
+
Load the generated OpenSim.sln into Visual Studio and build the solution, or just run
 +
compile.bat
  
−
Physics can be invoked by adding the appropriate line to opensim.ini, under [Startup]. For ODE, that would be:
+
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
  
−
physics = OpenDynamicsEngine
 
  
−
You can also add a command line option to a shortcut, or run from a command prompt with:
+
Configure, See [[Configuration]].
  
−
-physics=OPenDynamicsEngine
 
  
−
==Linux/Mac OS X==
+
Now just run OpenSim.exe from the bin folder, and set up the region.
  
−
=== Subversion Repository ===
+
=== Building on Linux / Mac ===
  
−
To check out the latest revision:
+
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
  
−
svn co svn://opensecondlife.org/opensim/trunk opensim.new/trunk
 
  
−
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.
+
Create the project files, run:
  
−
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
+
./runprebuild.sh
  
−
=== Building (Mono) ===
+
then run
 +
dotnet build --configuration Release OpenSim.sln
  
−
  cd opensim.new/trunk
+
or just
 +
  ./compile.sh
  
−
mono bin/Prebuild.exe /target nant
 
−
nant -buildfile:OpenSim.build
 
  
−
mono bin/Prebuild.exe /target nant
+
Configure. See [[Configuration]].
−
nant -buildfile:OpenSim.build
+
  
−
(Yes, you must rerun the prebuild again after the first build, and then build again!)
 
  
−
Later revisions(1657 and above) no longer require you to build twice. Thus the procedure is simply as follows:
+
run ./opensim.sh from the bin folder, and set up the region
  
−
cd opensim.new/trunk
+
== 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.
  
−
mono bin/Prebuild.exe /target nant
+
== Requirements ==
−
nant -buildfile:OpenSim.build
+
  
−
==== Physics ====
+
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.
  
−
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.
 
  
−
===== Open Dynamics Engine (ODE) =====
+
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.
  
−
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 build libode.so from source.
+
Other platforms may have own mono distributions, or may need to compile mono on them.
  
−
Remove libode.so from the ./bin folder.  (Note that subsequent svn updates may replace it again).  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:
+
Other libraries used by OpenSimulator can be found at our opensim-libs git repo:
  
−
--with-trimesh=gimpact
+
git clone git://opensimulator.org/git/opensim-libs
−
--enable-shared
+
  
−
make sure the configure script confirms these choices, and always compile with single precision (I believe that's default).  Try <code> make -k </code> if you get errors relating to drawstuff, test*, or openGL.  <code> make install </code> should put libode.so in the proper place (usually /usr/local/lib), and it should be seen by opensim (ode.net.dll)
+
libOpenMetaVerse used can be found at https://bitbucket.org/opensimulator/
  
−
=== Running (Mono) ===
+
You may need to compile them for your platform, in particular the unmanaged ones like Bullet or ODE native code libraries
  
−
cd bin
+
== MS Windows ==
−
mono OpenSim.exe
+
  
−
to invoke ODE, add the option:
+
=== Supported Compilers ===
−
-physics=OpenDynamicsEngine
+
* [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
  
−
or add <code>  physics = OpenDynamicsEngine </code> to the [Startup] section of opensim.ini.
+
=== 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.
  
−
=Binary releases=
+
===Compiling at the Command Prompt ===
 +
# Run "runprebuild.bat".
 +
# Run the resulting "compile.bat" file.
  
−
nightly builds, presumably for Linux:
+
== Linux and Other Mono Platforms ==
  
−
http://ruth.petitbe.be/build/
+
=== 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 :
 +
 
 +
<source lang="bash">
 +
# 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
 +
</source>
 +
 
 +
Then :
 +
 
 +
<source lang="bash">
 +
sudo apt update
 +
sudo apt install dotnet-sdk-8.0
 +
</source>
 +
 
 +
https://learn.microsoft.com/en-us/dotnet/core/install/linux-ubuntu<br/>
 +
https://learn.microsoft.com/en-us/dotnet/core/install/linux-debian<br/>
 +
 
 +
=== 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. ''(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
 +
 
 +
==== 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.
 +
 
 +
== 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]]

Latest revision as of 11:39, 15 May 2024

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

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

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