Revision as of 07:59, 27 November 2023

Home

Download

News

Support

Admin

Dev

Screen Shots

Grid List

Bugs

Languages:

English Deutsch Français 日本語

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.

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.

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.

Get source code

get or update source from git

git clone git://opensimulator.org/git/opensim

Building on Windows

To building under Windows, the following is required:

dotnet 6.0 SDK and Desktop Runtime

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

to install the run time files for vc++
to authorize the install of older .NetFramework 3.5

Configure, See Configuration.

Now just run OpenSim.exe from the bin folder, and set up the region.

Building on Linux / Mac

you will need

dotnet 6.0 SDK and Runtime
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

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.

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

.NET Framework 4.6 on Windows
Mono on Linux or Mac. Mono 5.12 is the minimum recommended version.
Note: rather than using your Linux distro's Mono packages, which may be missing required components, please install from the official Mono repo for your distro.

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

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

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

Configuration

See Configuration.

Views

Build Instructions

From OpenSimulator

Revision as of 07:59, 27 November 2023

Contents

Obtaining the Source Code

Building

Version 0.9.3.0 and above

Get source code

Building on Windows

Building on Linux / Mac

Older Versions

Requirements

MS Windows

Supported Compilers

Compiling in an IDE

Compiling at the Command Prompt

Linux and Other Mono Platforms

Prepare to compile

Compile with Nant

Compile with xbuild

Compile with msbuild

Ahead of Time compilation (AOT)

Configuration

Personal tools

General

For Administrators

For Developers

For Creators

For Grid Users

Related Links

About This Wiki

Search

Tools

@@ Line 1: / Line 1: @@
-{{Template:Quicklinks}}
+{{Quicklinks|Build_Instructions}}
-[[Category:Users]]
+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.
-This page covers building OpenSim from source code on multiple platforms.  Please help us keep this page up to date as the project progresses.
-==Download OpenSim ==
+= Obtaining the Source Code =
-Check out the [[Download]] page for instructions on obtaining an OpenSim source release.
+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]].
-==General Notes==
+= Building =
-Although this page is long, building is generally quite simple.  See the BUILDING.txt file in the distribution itself for simplified instructions. This page discusses what you need to do before actual building.
-===Setting Files===
+Although this page is long, building is generally quite simple.  See the BUILDING.txt file in the distribution itself for simplified instructions.
-Unlike binary distributions, OpenSimulator source distributions are delivered without default configuration files, i.e, '''OpenSim.ini''' and '''StandaloneCommon.ini'''. Therefore you'll need to create them by yourself. Look carefully at [[Configuration]] page not to suffer from the errors like ''"APPLICATION EXCEPTION DETECTED: System.UnhandledExceptionEventArgs Exception: System.Exception: Configuration file is missing the [SimulationDataStore] section"''(= missing "OpenSim.ini") or ''"Error loading plugin from OpenSim.Services.FriendsService.dll, exception System.Exception: No StorageProvider configured"''(= missing "*Common.ini").
+== 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.
-===Crash Course on Linux===
+=== Get source code ===
-The easiest platform to get running on the Linux side is Ubuntu 32bit.  This is what most of the developers running Linux use.  If you are looking for the quick path, start [[#Ubuntu|there]].
+get or update source from git
-'''Many distros (including Ubuntu) ship with only the "mono-runtime" package installed, however you need to install "mono-complete" for some OpenSimulator features such as LSL script commands.'''
+ git clone git://opensimulator.org/git/opensim
-== MS Windows  ==
+=== Building on Windows ===
+To building under Windows, the following is required:
-OpenSim requires either the .Net Framework version 3.51, or&nbsp;Mono 2.4.3 or newer. It supports the following compilers:
+* [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 dotnet 6.0 SDK and Desktop Runtime]
-Net Framework is available from here: [http://www.microsoft.com/downloads/details.aspx?FamilyID=ab99342f-5d1a-413d-8319-81da479ab0d7&displaylang=en www.microsoft.com/downloads/details.aspx]
+optionally also
-*[http://msdn2.microsoft.com/en-us/express/aa700756.aspx Microsoft Visual C# Express Edition] (note: not Visual C++)
+* Visual Studio .NET, version 2022 or later
-New URL: http://www.microsoft.com/express/Windows/ ( The Visual Studio® 2010 Express )
-*[http://www.mono-project.com/ mono]
-Additional note: If you like IDE's you will need C# express 2008 or VS 2008.
-Additional note: Microsoft C# Express v9 may install .Net 3.5 with resultant path error.
+Create the project files running:
-#To avoid install .Net framework version 2.0 (installed by default in Windows XP&nbsp;&amp;&nbsp;newer)
+ runprebuild.bat
-Additional note: It is possible to develop on Windows Vista 64 bits with the following tweaks:
+Load the generated OpenSim.sln into Visual Studio and build the solution, or just run
+ compile.bat
-#Select OpenSim project properties from solution and choose platform to be x86. Rebuild solution.
+to run you may also need
-#Select OpenSim.exe properties under solution bin folder and choose windows xp sp 2 compatibility mode + run as administrator.
+* 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
-Additional note:  It is possible to develop with Visual Studio 2010 - C# Express with the following tweaks:
-#In the top-level directory, run the '<tt>runprebuild.bat</tt>' file. This will create a VS2008 solution file.
+Configure, See [[Configuration]].
-#Open the VS2008 solution file in VS 2010 Express and run the conversion wizard to crease a VS2010 solution file.
-#In the solution explorer of the resulting project, right click on each project (there are 91) and select properties.  Under the Application tab, set the Target framework to .NET Framework 3.5.
-#In the solution explorer, under the OpenSim project select "app.config".
-#Copy the contents of bin\OpenSim.exe.config into the app.config file
-=== Building  ===
-*In the top-level directory, run the '<tt>runprebuild.bat</tt>' file. This will create a VS2008 solution file, a nant build file and a '<tt>compile.bat</tt>' file.
+Now just run OpenSim.exe from the bin folder, and set up the region.
-*Open the resulting sln file with visual studio and build it there, or
+=== Building on Linux / Mac ===
-*Run the '<tt>compile.bat</tt>' file. This will build the executable using MSBuild.
-*if you prefer to use nant, run nant in the same top-level directory. This will build the executables.
-The debugger in VS2008 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 "<tt>chmod 777 *</tt>" from the <tt>bin</tt> directory solves this.
+you will need
+* [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 dotnet 6.0 SDK and Runtime]
+* 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
-== Mac OS X ==
-=== Mac OS X 10.5 and later, Intel ===
+Create the project files, run:
-Only you have to do is to get :
-* Mono SDK from [http://www.go-mono.com/mono-downloads/download.html Mono Download Page]
-* MonoDevelop package from [http://monodevelop.com/Download MonoDevelop Download Page]
-and then install them - now no need to install XCode nor MacPort (you can still install mono dev libraries and nant with MacPort though).
-When you run nano to build OpenSimulator, it may show an error like "Unable to locate 'mono' module using pkg-config. Download the Mono
-development packages". I suspect XCode or MacPort causes something wrong (since it worked fine after I removed both), but I'm not sure. Anyway, insert a line into '''/usr/bin/nant''' script file to manage this problem :
-<pre>
-#!/bin/sh
-export PKG_CONFIG_PATH=/Library/Frameworks/Mono.framework/Libraries/pkgconfig    # add this!
-exec /Library/Frameworks/Mono.framework/Versions/2.10.2/bin/mono \
-    /Library/Frameworks/Mono.framework/Versions/2.10.2/share/NAnt/bin/NAnt.exe "$@"
-</pre>
-You can even compile and debug OpenSimulator with MonoDevelop IDE after running "runprebuild.sh". Open the solution file(*.sln) with MonoDevelop IDE then select Build -> Build All from the menu.
-=== Mac OS X 10.4/10.5 on PowerPC ===
-OpenSim can run on PowerPC Macs (such as G4, G5). These instructions were tested on 10.5.8.  Note that two libraries must also be built from source. Caveat: the OpenSim app was only briefly tested in self-contained mode. There may well be issues with this build. Feel free to note any issues you find below (or in a new wiki page? discussion?).
-Unfortunately, the OpenSim version used here must be compiled on one version of Mono (2.6.7) and run on another (2.8.2). This means either upgrading Mono after the build, or having both versions installed and accessing the older version when you want to build. These instructions let you have both versions installed.
-* Install Xcode 3.1.4 Developer Tools from from http://developer.apple.com/. You must have a free Apple developer account to access the downloads. 3.1.4 was the last PowerPC Xcode.
-* (10.4 only) Install X11 from the Optional Install (or see if it's a Customize option when you install Xcode). 10.5 gets X11 by default (''from OS X or dev tools?'').
-* Install Mono 2.6.7 PowerPC Framework from here: http://www.go-mono.com/mono-downloads/download.html (binary OS X Framework, no need to build from source)
-* Then install Mono 2.8.2 PowerPC framework. For these instructions to work, you must first install 2.6.7, THEN 2.8.2. (The old framework is not deleted, but "Current" symlinks are updated).
-* Download OpenSim 0.7.0.2 source tarball: http://dist.opensimulator.org/opensim-0.7.0.2-source.tar.gz Expand to a suitable folder for development and running.
-** Feel free to try a newer version of OpenSim (the repository is on git now).
-** If you used a newer OpenSim version, check BUILDING.txt for any changes to build instructions (we fall under "Linux")
-* Edit or create .profile or .bash_profile in your OS X home folder, with the following lines:
- # remember real PATH
- export OSIM_HACK_ORIG_PATH=$PATH
- # normal path for running OpenSim
- export PATH=$PATH:/Library/Frameworks/Mono.framework/Versions/Current/bin:/usr/local/mysql/bin
- # Just for nant:
- export PKG_CONFIG_PATH=/Library/Frameworks/Mono.framework/Versions/2.6.7/lib/pkgconfig
- alias oldpath="export PATH=$OSIM_HACK_ORIG_PATH:/Library/Frameworks/Mono.framework/Versions/2.6.7/bin"
-* Open a new Terminal window, and cd to your uncompressed OpenSim source folder (shortcut: type "cd " then drag the folder to the Terminal window). The enter these commands:
- oldpath
   ./runprebuild.sh
- nant
-* nant should take around 10 minutes to compile your OpenSim. If you get through that without errors, you're halfway there! (I did get 234 warnings).
+then run
-* *Important* Before we forget, open a new Terminal window (necessary to avoid the effects of "oldpath").
+  dotnet build --configuration Release OpenSim.sln
-* Now we need PowerPC versions of two libraries. Build each one and replace the compiled .dylib files in the opensim/bin folder.
-** libode.dylib http://cdnetworks-us-1.dl.sourceforge.net/project/opende/ODE/0.11.1/ode-0.11.1.zip
-** libopenjpeg-dotnet-2.1.3.0-dotnet-1.dylib (checked out with svn:)
-  svn co http://libopenmetaverse.googlecode.com/svn/libopenmetaverse/trunk/openjpeg-dotnet libopenmetaverse-read-only
- cd libopenmetaverse-read-only
-** To build, remove the Makefile file, which is for Linux, and rename Makefile.osx to just Makefile, then give the command: make )
-** Remove the other versions of the two libraries (similar names, different extensions, like "libode-x86_64.so". Two libode's and three libopenjpeg's).
-* Configure your sim: Copy OpenSim.ini.example to OpenSim.ini and customize it per its comments.
-* Likewise copy and customize StandaloneCommon.ini in bin/config-include
-* Note that the comments say that the current SQLite plugin doesn't work on OS X. Either solve that, or install MySQL, which requires no compiling and is relatively easy to set up:
-** From http://downloads.mysql.com/archives.php?p=mysql-5.1&v=5.1.40, download MySQL 5.1.40 for 10.5 PowerPC (installer, not 64-bit)
-** Run the installer. (which installs to /usr/local)
-** Install MySQL.prefPane into System Preferences by double-clicking it.
-** Open the pref pane and start MySQL.
-** (Optional:) For unattended startup, install MySQLStartupItem (doesn't always work for me).
-** (Recommended:) In Terminal, do the one-time setup of MySQL with this command: mysql_secure_installation
-** In MySQL, create the opensim user per the comments in OpenSim.ini. Give it all the create privileges.
-*** Since this is a Mac, you could use Sequel Pro (donationware) to do that in a nice GUI. Standard connection, host: 127.0.0.1 (if on the same Mac)
-* You're ready to run OpenSim. In that new Terminal window, cd to your OpenSim-source/bin folder.
- mono OpenSim.exe
-* If all is well, you will be prompted "New region name []: "
-* Turn to "Running OpenSim for the first time" on wiki page [[Configuration]]
-* When fully up and running, the prompt is "Region (<region-name>) #"
-== Ubuntu ==
+or just
+ ./compile.sh
-For Ubuntu users on older distributions (7.10, 8.04, 9.10 etc.) '''you need''' to upgrade your version of mono to at least 2.4.3. For anyone who needs to upgrade their Mono, see [[Update Mono on Ubuntu]].
-Ubuntu Karmic (9.10) includes mono 2.4.2.3 packages.
+Configure. See [[Configuration]].
-Ubuntu Lucid (10.04) includes mono 2.4.4 packages
-Ubuntu Maverick (10.10) includes mono 2.6.7 packages
+run ./opensim.sh from the bin folder, and set up the region
-To build:
+== 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.
- sudo apt-get install nant mono-gmcs libmono-microsoft8.0-cil \
+== Requirements ==
-      libmono-system-runtime2.0-cil libgdiplus libmono-i18n2.0-cil libmono-oracle2.0-cil
- [[Download]] opensim
- cd opensim
- ./runprebuild.sh
- nant
-=== Ubuntu 11.04 ===
+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.
-Ubuntu Natty (11.04) includes mono 2.6.7 packages.
-In this version, one only needs to apt-get install nant - this will pull down all the other required packages as dependencies.  This may also be true for some of the earlier Ubuntu releases.  Thus, to build:
+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.
- sudo apt-get install nant
+Other platforms may have own mono distributions, or may need to compile mono on them.
- [[Download]] opensim
- cd opensim
- ./runprebuild.sh
- nant
-To run the regression test suite, you will also need to install nunit-console, like so
+Other libraries used by OpenSimulator can be found at our opensim-libs git repo:
- sudo apt-get install nunit-console
+git clone git://opensimulator.org/git/opensim-libs
- nant test
-{{anchor|CentOS}}{{anchor|RedHat}}{{anchor|RHEL}}{{anchor|Fedora}}
+libOpenMetaVerse used can be found at https://bitbucket.org/opensimulator/
-== RHEL, Fedora, CentOS or other RedHats ==
-After getting run your OpenSimulator binary distributions, you'll need to get mono development library and install nant to build OpenSimulator from the source. See both sections below.
+You may need to compile them for your platform, in particular the unmanaged ones like Bullet or ODE native code libraries
-=== Getting Mono Libraries ===
+== MS Windows ==
-If you have installed mono packages from the core repository for your distributions [[Dependencies#RedHat|when you run OpenSim.exe binary distribusion]], just type:
+=== Supported Compilers ===
-<pre>
+* [https://visualstudio.microsoft.com/downloads/ Visual Studio Community 2017]
-sudo yum install mono-devel
+* Or any version that does support the .Net version. At least VS2010 for versions prior to 0.91, VS2015 for 0.91 and after.
-</pre>
+* 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
-If not, just type (given that [[Dependencies#Installing from Mono Repository|you have already set up yum repository for mono]]) :
+=== Compiling in an IDE ===
-<pre>
+# Run "runprebuild.bat"
-sudo yum install mono-addon-devel
+# Open the resulting "OpenSim.sln" in Visual Studio IDE.
-</pre>
+# Select Debug or Release configuration
+# Menu Build -> Build Solution.
-Both command will install its dependencies as well.
+===Compiling at the Command Prompt ===
+# Run "runprebuild.bat".
+# Run the resulting "compile.bat" file.
-=== Installing NAnt ===
+== Linux and Other Mono Platforms ==
-Run "yum info nant" to check the version of nant package. If you find the package, then just type:
+=== Prepare to compile ===
-<pre>
+To create the several project files run on the folder opensim:
-sudo yum install nant
-</pre>
-You can now run nant out-of-the-box.
+  ./runprebuild.sh
-If you can't find nant package in yum repository, or you feel its version is too early for building OpenSimulator, obtain NAnt from [http://nant.sourceforge.net/ NAnt Project Site]. See User Manual there for detailed instruction. As of 0.90, you will need to create startup script like that (given you have expanded NAnt to /usr/local/nant) :
+==== Compile with Nant ====
-<pre>
+On some mono versions, in particular old ones may need the use of nant to proper compile OpenSimulator, in that case just run:
-sudo vi /usr/bin/nant
-</pre>
-Then inside this file :
-<pre>
-#!/bin/sh
-exec mono /usr/local/nant/bin/NAnt.exe "$@"
-</pre>
-After that, make it executable :
-<pre>
-sudo chmod +x /usr/bin/nant
-</pre>
-You can now run runprebuild.sh and nant to compile OpenSimulator.
+  nant
-== openSUSE ==
+==== Compile with xbuild ====
-Install an openSUSE 11.1, 11 or 10.3 with its default options, add the online repositories
+On mono versions you can just use xbuild. ''(msbuild is recommended for 0.9.1.0.0+)''
-when finished installing do an online update with all the latest packages.
-In yast install these packages, for running Opensim in standalone mode.
+  xbuild
-(there is a slight diffrence between 10.3 and 11/11.1 but following should be same)
- subversion
- nant
- mono-jscript
- - check that mono-core is installed
-just in case you do not already have it installed
+xbuild is no longer recommended on mono 5.x, but currently still works (5.12)
-  sudo zypper install mono-data-oracle
+''>>>> xbuild tool is deprecated and will be removed in future updates, use msbuild instead <<<<''
-A tip for OpenSuSE 11.1 users - you can install packages from the command line using the 'zypper' tool.  For example, to install 'nant', use this command:
+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
-  sudo zypper install nant
+==== 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 )
-If you just want to use SQLite then jump to last section
+Use xbuild on the other cases as a last resort.
-within this post.
-* Optional mysql - for Opensim running in Grid mode:
+Recent improvements, specially on JIT runtime, justify compiling in Release configuration, but you do lose some debug capabilities.
-Install these mysql packages via yast
-  mysql
-  mysql-client
-  mysql-administrator
-  mysql-gui-tools
-  mysql-query-browser
-(note that selecting mysql in the Yast2 Installer will select the other packages automatically)
+to compile with Debug configuration:
+   msbuild
-Before building create the mysql database.
+to compile with Release configuration:
- /etc/init.d/mysql start
+   msbuild /p:Configuration=Release
- mysql -u root -p -h localhost
- (when asked for password just hit enter)
- mysql> create database opensim;
+to compile with the debug configuration and detailed opensim.log file can then be read with a text editor:
- mysql> use opensim;
+   msbuild /p:Configuration=Debug /fileLogger /flp:logfile=opensim.log /v:d
- mysql> create user 'opensim'@'localhost' identified by 'thePassword';
- mysql> grant all on *.* to 'opensim'@'localhost';
- mysql> quit
-*note that the '''grant all''' command may differ if you're adding the opensim database to an existing mysql installation.
+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].
-On current builds set the connection string inside bin/OpenSim.ini after coppying the OpenSim.ini.example file.
+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.
-If you are changing to MySQL from SQLite, the connection string for mysql also exists in the bin/Region/*xml files.
-* It is '''important''' to remember this if you start out using the built-in SQLite database engine.
-Build after installation of above in bash terminal. I save it in /opt
+== 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>
- su -
+For Linux, 0.9.2.0 now includes scripts makeaot.sh and cleanaot.sh to help testing AOT.<br>
- cd /opt
+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>
- [[Download]] opensim
+  mono --desktop -O=all OpenSim.exe
-  cd opensim
+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>
- ./runprebuild.sh
+<b>DO NOT FORGET to run makeaot.sh or cleanaot.sh after recompile!</b><br>
- nant
+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>
-Or, if you have a current (0.6+), you can simply execute:
+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>
- make
+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>
-After this you should be able to continue on starting the diffrent Servers, look in the mysql-config section,or
+In practical use, don't expect much more than a bit faster loading.<br>
-just run your OpenSim as a Standalone.
+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>
-== FreeBSD ==
+= Configuration =
-On FreeBSD 6.2,
- su
- cd /usr/ports/devel/subversion/ && make install clean (you may also need to rebuild apr-svn if this step fails)
- cd /usr/ports/lang/mono/ && make install clean
- cd /usr/ports/devel/nant/ && make install clean
- cd /usr/ports/databases/sqlite3/ && make install clean
- cd /usr/ports/x11-toolkits/libgdiplus/ && make install clean
- cd /opensim/installation/directory/
- [[Download]] opensim
- cd opensim
- ./runprebuild.sh
- nant
- Note: [[Troubleshooting#System.DllNotFoundException:_..2Flibopenjpeg-libsl-2.1.2.0.so|Follow the instructions on the FAQ to fix the]]
- "System.DllNotFoundException: ./libopenjpeg-libsl-2.1.2.0.so" issue, but use "gmake" instead of "make"
-For ODE Physics you must do the following:
- cd /usr/ports/graphics/libGL/ && make install clean
- cd /usr/ports/graphics/libGLU/ && make install clean
- cd /opensim/installation/directory/
- svn co http://opensimulator.org/svn/opensim-libs/trunk opensim-libs
- cd opensim-libs/unmanaged/OpenDynamicsEngine2/
- sh autogen.sh
- ./configure --enable-shared --enable-release --disable-demos
- make
- mv ./ode/src/.libs/libode.so /opensim/installation/directory/opensim/bin/
-== Debian ==
-=== Debian 4 ===
-For detailed instructions please see [[Debian 4 Build Instructions]]
-=== Debian 5 ===
-. Install Debian in the usual way. In the package list choose just the last option - 'Standard system' Leave all other install options unchecked unless you have other reason to install them.
-. Log in as your root user make sure it works.
-. type: aptitude update (or apt-get update)
-. type: aptitude install nant and answer 'y' to 'Do you want to continue'- This will install nant and all of its dependancies.
-. type: apt-get install git-core and answer 'y' to 'Do you want to continue'.
-. type: aptitude install build-essential swig autoconf gawk mono-common binfmt-support bison libglib2.0-dev gettext and answer 'y' to 'Do you want to continue'
-. type: wget http://ftp.novell.com/pub/mono/sources/mono/mono-2.4.3.tar.bz2 to download mono
-. type: tar xf mono-2.4.3.tar.bz2 to extract the mono source code to a directory (substitute the latest build)
-. type: cd mono-2.4.3 to change int the directory you just created
-. type: ./configure --with-libgdiplus=yes - wait for it to finish
-. type: make - and wait some more as this takes a bit - moreso on older machines
-. type: make install
-. type: cd /
-type: git clone git://opensimulator.org/git/opensim
-type: cd opensim
-. type: git checkout -b 0.6.8-post-fixes origin/0.6.8-post-fixes (substitute the latest build)
-. type: git pull
-. type: apt-get -u upgrade and answer 'y' to 'do you want to continue?'. This will update all packages to their latest versions via apt (it will not upgrade opensim or mono as they were compiled seperately)
-. Reboot, just to make sure it all comes up cleanly (type: shutdown -r now)
-. Login, type: cd /
-. type: cd opensim
-. type: ./runprebuild.sh
-type: nant - wait for this to finish
-. type: cd bin
-. type: cp OpenSim.ini.example OpenSim.ini
-. type: mono OpenSim.exe
-. Answer the onscreen wizard promts and Opensim will start in standalone mode.
-To add MySql support type: apt-get install mysql-server and answer 'y' to 'Do you want to Continue'. You will be prompted for a password for the MySQL root user, enter it twice as requested. Edit OpenSim.ini to use MySql as directed elsewhere.
-=== Debian testing/unstable (will be Debian 7)  ===
-Updated 2011 April 19
-#Get root access on a Debian/Linux machine or install a fresh copy yourself. see http://www.debian.org/ This is the most difficult and longest step in our list, but there are many resources to help you through if this is your first time.
-#Log in as your root user.
-#Check <tt>/etc/debian_version</tt> to be sure of what release you are working with, by typing: `<tt>cat /etc/debian_version</tt>'. As of this writing it should reply "<tt>wheezy/sid</tt>".
-#type: `<tt>apt-get update</tt>'
-#type: `<tt>apt-get dist-upgrade</tt>' This will upgrade all packages to their latest versions and will handle conflicts which may arise. See: `<tt>man apt-get</tt>' for more information. If you did not install from scratch this will bring the system up to date. For more information about running and maintaining a Debian system enter: `<tt>apt-get install debian-reference</tt>' and point a web browser at <tt>/usr/share/doc/debian-reference-common/html/index.en.html</tt> This is a book length document (read it later).
-#type: `<tt>apt-get install mono-complete nant git build-essential swig autoconf gawk binfmt-support bison gettext</tt>' and answer 'y' to 'Do you want to continue'.
-#Reboot, just to make sure it all comes up cleanly (type: `<tt>shutdown -r now</tt>')
-#Login again, type: `<tt>cd /usr/src</tt>'
-#type: `<tt>git clone git://opensimulator.org/git/opensim</tt>'
-#type: `<tt>cd opensim</tt>'
-#type: `<tt>git branch -r</tt>' will show you the available branches in the remote repository. You want the most recent release which will be listed as something like "<tt>origin/0.7.0.2-release</tt>"
-#type: `<tt>git checkout -b 0.7.0.2-release origin/0.7.0.2-release</tt>'
-#type: `<tt>git pull</tt>'
-#type: `<tt>./runprebuild.sh</tt>'
-#type: `<tt>nant</tt>'
-#type: `<tt>cd bin</tt>' to switch directories to <tt>/usr/src/opensim/bin</tt>
-#type: `<tt>cp OpenSim.ini.example OpenSim.ini</tt>' (The <tt>[Architecture]</tt> section is what determines if you will be running a standalone or grid server. You want the default standalone variant to get started with.)
-#type: `<tt>cd config-include</tt>' you are now in <tt>/usr/src/opensim/bin/config-include</tt>
-#type: `<tt>cp StandaloneCommon.ini.example StandaloneCommon.ini</tt>' See [[Configuration]] for more information on configuring OpenSim.
-#type: `<tt>cd ..</tt>' to change directories back to <tt>/usr/src/opensim/bin</tt>
-#type: `<tt>mono OpenSim.exe</tt>'
-#The startup wizard will ask you a number of questions. The defaults are fine but you can fill these in to your taste:
-region name, estate name, owner first name, owner last name, owner password, and owner email
-Remember the external host name and port number, you need these to construct the login URI to connect to with your client. http://hostname:portnumber/
-Opensim will then finish starting and leave you at a prompt which looks like:
- Region (regionName) #
-----
-Where to go from here:
-*[[Connecting]] to your server using a client.
-*[[Upgrading]] to mySQL from mySQLite.
-*[[Server Commands]] for creating users and controlling the system.
-*Fix the bent knees bug: [[FAQ#Why_are_my_knees_bent_when_I_stand_idle.3F]]
+See [[Configuration]].
+[[Category:Users]]
 [[Category:Users]]
 [[Category:Getting Started]]