Latest revision as of 11:39, 15 May 2024

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.

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

dotnet 8.0 SDK

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.

[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

.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

[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

Run "runprebuild.bat"
Open the resulting "OpenSim.sln" in Visual Studio IDE.
Select Debug or Release configuration
Menu Build -> Build Solution.

[edit] Compiling at the Command Prompt

Run "runprebuild.bat".
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.

Views

Build Instructions

From OpenSimulator

Latest revision as of 11:39, 15 May 2024

Contents

[edit] Obtaining the Source Code

[edit] Building

[edit] Version 0.9.3.0 and above

[edit] Get source code

[edit] Building on Windows

[edit] Building on Linux / Mac

[edit] Older Versions

[edit] Requirements

[edit] MS Windows

[edit] Supported Compilers

[edit] Compiling in an IDE

[edit] Compiling at the Command Prompt

[edit] Linux and Other Mono Platforms

[edit] Install dotnet under Debian/Ubuntu

[edit] Prepare to compile

[edit] Compile with Nant

[edit] Compile with xbuild

[edit] Compile with msbuild

[edit] Ahead of Time compilation (AOT)

[edit] 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.
-==MS Windows==
+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]].
-OpenSim requires either the .Net framework version 2.0, or the latest Mono. It supports the following compilers:
+= Building =
-* [http://msdn2.microsoft.com/en-us/express/aa700756.aspx Microsoft Visual C# Express Edition] (note: not Visual C++)
-* [http://www.mono-project.com/ mono]
-Additional note: any Microsoft C# Express edition should work (2005 or 2008)
-Additional note: Microsoft C# Express v9 may install .Net 3.5 with resultant path error.
+Although this page is long, building is generally quite simple.  See the BUILDING.txt file in the distribution itself for simplified instructions.
-# To avoid install .Net framework version 2.0
-Additional note: It is possible to develop on Windows Vista 64 bits with the following tweaks:
+== Version 0.9.3.0 and above ==
-# Select OpenSim project properties from solution and choose platform to be x86. Rebuild solution.
+Microsoft stopped the development of .Net Framework and Mono, replacing them by new dotnet
-# Select OpenSim.exe properties under solution bin folder and choose windows xp sp 2 compatibility mode + run as administrator.
+This is a significant breaking change that we try to follow on 0.9.3.0.
-=== Building ===
+=== Get source code ===
-* In the top-level directory, run the '<tt>runprebuild.bat</tt>' file. This will create a VS2005 solution file, a nant build file and a '<tt>compile.bat</tt>' file.
+get or update source from git
-* If you prefer VS2008, run the '<tt>runprebuild2008.bat</tt>' instead.
-* Open the resulting sln file with visual studio and build it there, or
+ git clone git://opensimulator.org/git/opensim
-* 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.
-If you don't care about physics (walking on prims, etc), ignore the rest of this section.
+=== Building on Windows ===
+To building under Windows, the following is required:
-=== Running ===
+* [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 dotnet 8.0 SDK]
-Recent versions of OpenSim come without an <tt>OpenSim.ini</tt> file. Copy the <tt>OpenSim.ini.example</tt> file to <tt>OpenSim.ini</tt> before making any changes.
+optionally also
-Double-click on the <tt>OpenSim.exe</tt> executable file in the <tt>bin</tt> directory. This will start up OpenSim in standalone mode.
+* Visual Studio .NET, version 2022 or later
-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 "<tt>chmod 777 *</tt>" from the <tt>bin</tt> directory solves this.
-Physics can be invoked by adding the appropriate line to the [Startup] section of <tt>OpenSim.ini</tt>.  For ODE, that would be:
+Create the project files running:
-  physics = OpenDynamicsEngine
+  runprebuild.bat
-You can also add a command line option to a shortcut, or run from a command prompt with:
+Load the generated OpenSim.sln into Visual Studio and build the solution, or just run
+ compile.bat
- -physics=OpenDynamicsEngine
+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
-'''''Windows Vista'''''
-Some people have reported that to run on Windows Vista, you must first disable Windows Firewall.  Under the new "Start" button of Vista, select "Control panel".  Then double-click "Windows Firewall".  In the window that pops up, on the left column, select "Turn Windows Firewall on or off".  You will have to give permission for this to run, then select the option "Off (not recommended)".  Click "OK" and exit from the Windows Firewall window.
+Configure, See [[Configuration]].
-If you have McAfee SecurityCenter, see the description below.
-Once all the security features are disabled, right click on <tt>OpenSim.exe</tt> and select "Run as administrator".  This will pop up a window asking permission, select "Allow".  Your OpenSim server should run in a DOS-like window and accept connections.
+Now just run OpenSim.exe from the bin folder, and set up the region.
+=== Building on Linux / Mac ===
-'''''McAfee Security'''''
+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
-McAfee Security does not allow applications to listen on ports not explicitly specified.  You have two options: 1) disable firewall protection all together, 2) enable <tt>OpenSim.exe</tt> to be able to open ports.
-''Disable firewall''
+Create the project files, run:
-Open McAfee SecurityCenter.  Select "Internet & Network".  In the lower left corner is a small link to "Configure...".  Select this.  In the right side of the window, select the bar that says "Firewall protection is enabled".  Here you can select "Off".
+  ./runprebuild.sh
-''Enable <tt>OpenSim.exe</tt> to open ports''
+then run
+ dotnet build --configuration Release OpenSim.sln
-Open McAfee SecurityCenter.  Select "Internet & Network".  In the lower left corner is a small link to "Configure...".  Select this.  In the right side of the window, select the bar that says "Firewall protection is enabled".  Select the "Advanced..." button.  This will pop up a new window.
+or just
+  ./compile.sh
-In the new window, on the left side, select "Program Permissions."  In the middle on the right side of the window, select the "Add Allowed Program" button.  Use the browser that pops up to find the OpenSim executable and select it.
-Finally, select "OK" and exit the McAfee SecurityCenter window.
+Configure. See [[Configuration]].
-==Linux/Mac OS X/FreeBSD==
-The easiest plaform to get running on the Linux side is Ubuntu 8.10, 32bit.  This is what most of the developers running Linux use.  If you are looking for the quick path, start there.
+run ./opensim.sh from the bin folder, and set up the region
-=== Ubuntu 8.04 / 8.10 ===
+== 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.
-For Ubuntu users on older distributions (7.10, 8.04, etc.) '''you need''' to upgrade your mono to at least 1.9.1.  Mono 2.2 is currently the preferred version to run OpenSim with.
+== Requirements ==
-You can use the built in packages for mono.  However, for better performance, you may want to [http://xyzzyxyzzy.net/2008/05/08/updated-mono-build-script-for-hardy-heron-and-mono-191/ upgrade mono to 1.9.1] ([http://tempvariable.blogspot.com/2008/04/installing-mono-191-on-ubuntu-804-hardy.html Other simple method])
+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.
- sudo apt-get install subversion nant mono-gmcs libmono-microsoft8.0-cil \
-      libmono-system-runtime2.0-cil libgdiplus libmono-i18n2.0-cil libmono-oracle2.0-cil ruby
- [[Download]] opensim
- cd opensim
- ./runprebuild.sh
- nant
-To upgrade the Mono version to the latest stable build Mono 2.0.1, read this page [[Build Instructions/Ubuntu-Mono-2.0.1 | Ubuntu on Mono 2.0.1]]
+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.
-=== openSUSE 10.3/11/11.1 ===
+Other platforms may have own mono distributions, or may need to compile mono on them.
-Install an openSUSE 11.1, 11 or 10.3 with its default options, add the online repositories
+Other libraries used by OpenSimulator can be found at our opensim-libs git repo:
-when finished installing do an online update with all the latest packages.
-In yast install these packages, for running Opensim in standalone mode.
+git clone git://opensimulator.org/git/opensim-libs
-(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
+libOpenMetaVerse used can be found at https://bitbucket.org/opensimulator/
-  sudo zypper install mono-data-oracle
+You may need to compile them for your platform, in particular the unmanaged ones like Bullet or ODE native code libraries
-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:
+== MS Windows ==
-  sudo zypper install nant
+=== 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.
+* 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 you just want to use SQLite then jump to last section
+=== Compiling in an IDE ===
-within this post.
+# Run "runprebuild.bat"
+# Open the resulting "OpenSim.sln" in Visual Studio IDE.
+# Select Debug or Release configuration
+# Menu Build -> Build Solution.
-* Optional mysql - for Opensim running in Grid mode:
+===Compiling at the Command Prompt ===
-Install these mysql packages via yast
+# Run "runprebuild.bat".
-  mysql
+# Run the resulting "compile.bat" file.
-  mysql-client
-  mysql-administrator
-  mysql-gui-tools
-  mysql-query-browser
-(note that selecting mysql in the Yast2 Installer will select the other packages automatically)
+== Linux and Other Mono Platforms ==
-Before building create the mysql database.
+=== Install dotnet under Debian/Ubuntu ===
- /etc/init.d/mysql start
- mysql -u root -p -h localhost
- (when asked for password just hit enter)
- mysql> create database opensim;
+For Ubuntu 22.04 LTS and higher, dotnet is available in the distribution's repos.
- mysql> use opensim;
- 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.
+For Ubuntu 20.04 LTS and lower, and for all versions of Debian, add Microsoft repository to your installation :
-On current builds set the connection string inside bin/OpenSim.ini after coppying the OpenSim.ini.example file.
+<source lang="bash">
-If you are changing to MySQL from SQLite, the connection string for mysql also exists in the bin/Region/*xml files.
+# Get OS version info
-* It is '''important''' to remember this if you start out using the built-in SQLite database engine.
+source /etc/os-release
-Build after installation of above in bash terminal. I save it in /opt
+# Download Microsoft signing key and repository
+wget https://packages.microsoft.com/config/$ID/$VERSION_ID/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
- su -
+# Install Microsoft signing key and repository
- cd /opt
+sudo dpkg -i packages-microsoft-prod.deb
- [[Download]] opensim
- cd opensim
- ./runprebuild.sh
- nant
-Or, if you have a current (0.6+), you can simply execute:
+# Clean up
+rm packages-microsoft-prod.deb
- make
+# Update packages
+sudo apt update
+</source>
-After this you should be able to continue on starting the diffrent Servers, look in the mysql-config section,or
+Then :
-just run your OpenSim as a Standalone. By - eagleFX
-=== Mac OS X 10.5/10.4 ===
+<source lang="bash">
-* OpenSim is now working on PowerPC Macs! Thanks to DrScofield and those who helped him. Current nightly builds for PowerPC are not working, not sure about Intel so use the 0.5 Build. OpenSim works on Intel Macs. I'm testing on PowerBook G4. Tested these step on 10.5, but not 10.4 but should work --[[User:Mokele|Mokele]] 22:36, 14 February 2008 (PST) (Works on iMac G5 with OS 10.4.11, including expanding to local grid mode. --[[User:Magnuz|Magnuz]] 2008-12-15 10:50 (CET))
+sudo apt update
-* Install XCode Developers Tools from DVD/CD Installation Disk or download  from http://developer.apple.com/. You have to create an Apple account to access the downloads if you don't have an Apple account.
+sudo apt install dotnet-sdk-8.0
-* Install X11 for 10.4 from the Optional Install from the DVD/CD Installation Disk. X11 for 10.5 is installed by default.
+</source>
-* Install Mono 1.2.5 from http://ftp.novell.com/pub/mono/archive/1.2.5/macos-10-universal/5/MonoFramework-1.2.5_5.macos10.novell.universal.dmg (The more recent releases Mono 1.2.6, 1.9.1 and 2.0.1 do not appear to work with these installation instructions. --[[User:Magnuz|Magnuz]] 2008-12-14 15:56 (CET)) and in Terminal or X11 edit the .profile file  and add the following line:
- export PKG_CONFIG_PATH="/Library/Frameworks/Mono.framework/Versions/Current/lib/pkgconfig/:${PKG_CONFIG_PATH}"
-* Compile OpenSim
- svn co http://opensimulator.org/svn/opensim/tags/0.5.0-release opensim
- cd opensim
- ./runprebuild.sh
- nant
-* Download and Compile libopenjpeg-libsl-2.1.2.0.dylib and libsecondlife.dll
+https://learn.microsoft.com/en-us/dotnet/core/install/linux-ubuntu<br/>
-* libopenjpeg-libsl-2.1.2.0.dylib:
+https://learn.microsoft.com/en-us/dotnet/core/install/linux-debian<br/>
- svn co http://opensimulator.org/svn/opensim-libs/old/libsl1550 opensim-libs
- cd opensim-libs/openjpeg-libsl
- make -f Makefile.osx
- cp libopenjpeg-libsl-2.1.2.0.dylib ../../bin
-* Note: The Makefile that creates the libopenjpeg-libsl-2.1.2.0.so does not compile on PowerPC, but works properly on Intel Macs. Looks like a gcc issue with compile options. (It appears to work on iMac G5 with OS X 10.4.11. --[[User:Magnuz|Magnuz]] 2008-12-14 15:55 (CET))
-* libsecondlife.dll: (for PowerPC Only, see  details on this step [http://xyzzyxyzzy.net/2008/02/12/installing-opensim-on-powerpcor-of-eggs-and-virtual-worlds installing OpenSim on PowerPC…or: of eggs and virtual worlds])
+=== Prepare to compile ===
- cd .. (back into opensim-libs)
+To create the several project files run on the folder opensim:
- nant
- cp bin/libsecondlife.dll ../bin
-* Edit the libsecondlife.dll.config (PowerPC Only). Remove the cpu="x86" tag in the last dllmap line.
+  ./runprebuild.sh
-Here is what worked for me (OS X 10.5.7, Intel):
+==== 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:
-* make sure you have X11 installed
-* grab the Apple Dev Tools from [http://developer.apple.com/]
-* install Mono Framework 2.4 from [http://www.go-mono.com/mono-downloads/download.html]
-* Get OpenSim source:
-  svn co http://opensimulator.org/svn/opensim/tags/0.6.5-post-fixes opensim
-* Compile OpenSim:
-  cd opensim
-  ./runprebuild.sh
    nant
---[[User:Kusako|Kusako]] 08:06, 19 June 2009 (UTC)
-=== FreeBSD 6.2 ===
+==== Compile with xbuild ====
- 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: [http://opensimulator.org/wiki/OpenSim:FAQ#System.DllNotFoundException:_..2Flibopenjpeg-libsl-2.1.2.0.so|Follow the instructions on the FAQ to fix the]
+On mono versions you can just use xbuild. ''(msbuild is recommended for 0.9.1.0.0+)''
- "System.DllNotFoundException: ./libopenjpeg-libsl-2.1.2.0.so" issue, but use "gmake" instead of "make"
-For ODE Physics you must do the following:
+  xbuild
- 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/
-=== RedHat Enterprise Linux 4 ===
+xbuild is no longer recommended on mono 5.x, but currently still works (5.12)
- sudo vi /etc/yum.repos.d/mono.repo
-  [mono]
+''>>>> xbuild tool is deprecated and will be removed in future updates, use msbuild instead <<<<''
-  name=Mono for rhel-4-i386 (stable)
-  baseurl=http://ftp.novell.com/pub/mono/download-stable/rhel-4-i386/
-  enabled=1
-  gpgcheck=0
- sudo yum install mono-complete monodoc-core nant
+On more recent mono versions Release configuration may give some performance gain, but you do lose some debug capabilities.
- [[Download]] opensim
+to compile Release configuration:
- cd opensim
+  xbuild /p:Configuration=Release
- ./runprebuild.sh
- nant
-=== RedHat Enterprise Linux 5 ===
+==== 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 )
-The instructions below also work on other RedHat Linux flavors such as CentOS or maybe Fedora.
+Use xbuild on the other cases as a last resort.
-. Put the [http://download.opensuse.org/repositories/Mono/RHEL_5/Mono.repo Mono.repo] file in the /etc/yum.repo.d/ directory:
+Recent improvements, specially on JIT runtime, justify compiling in Release configuration, but you do lose some debug capabilities.
- $ sudo su -
- $ cd /etc/yum.repos.d/
- $ wget http://download.opensuse.org/repositories/Mono/RHEL_5/Mono.repo
-Naturally use the most [http://download.opensuse.org/repositories/Mono up-to-date link for your distribution].
-. Install Mono and related tools with yum:
+to compile with Debug configuration:
- $ yum install mono nant mono-jscript mono-nunit
+   msbuild
-Make sure to use nunit-console2 to run your tests.
-=== Fedora 5 ===
+to compile with Release configuration:
-* I needed to build latest mono and nant from sources to build OpenSim successfully, the ones available in yum repository didn't work so I had to uninstall and build and configure the packages.
+   msbuild /p:Configuration=Release
-For detailed instructions go [http://ruakuu.blogspot.com/2008/06/installing-and-configuring-opensim-on.html here]
+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
-=== Debian 4 ===
+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].
-For detailed instructions please see [[Debian 4 Build Instructions]]
+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.
-=== CentOS 5.2 32bit ===
+== 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 detailed instructions please see [[CentOS 5.2 Build Instructions]]
+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>
-=== 64bit ===
+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>
-Please note that only 32bit binaries are provided in the bin/ directory of subversion.  If you want to use 64bit, you'll need to rebuild these shared objects.  See [[Installing and running on x86-64]]
+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>
-=== Physics (Open Dynamics Engine ODE) ===
+In practical use, don't expect much more than a bit faster loading.<br>
-As installed from svn, ODE will work on most 32 bit platforms.  If you get an ODE-related crash, and/or a <i>libode.so not found</i> type of error, you will need to build libode from source.
+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>
-Remove <tt>libode.so</tt> from the <tt>./bin</tt> folder.  (Note that subsequent svn updates may replace it again; best fix is to copy your built <tt>libode.so</tt> to <tt>bin</tt>).  Do NOT remove <tt>ode.net.dll</tt>!  Download the latest source from:
+= Configuration =
- svn co http://opensimulator.org/svn/opensim-libs/trunk/unmanaged/OpenDynamicsEngine
+See [[Configuration]].
-OpenSim requires a couple of patches on top of ODE which are not yet included upstream.  When compiling, make sure to use the following configure options:
- --with-trimesh=gimpact
- --enable-shared
-Make sure the configure script confirms these choices, and always compile with single precision (I believe that's the default).  Try <code> make -k </code> if you get errors relating to drawstuff, test*, or openGL.  <code> make install </code> should put <tt>libode.so</tt> in the proper place (usually <tt>/usr/local/lib</tt>), and it should be seen by opensim (<tt>ode.net.dll</tt>)
-'''''Note:''' if OpenSim fails to launch with <tt>Exception: System.DllNotFoundException: ode</tt>, after compiling ODE, just copy <tt>libode.so</tt> from its usual place (probably <tt>/usr/local/lib/</tt>) to ./bin/, as per [http://metafuturing.net/index.php/OpenSim_Notebook_1 this suggestion]''
-==== Setting up ODE for 64 Bits systems: ====
-HOWTO on setting up and Install OpenSim on SLES10 - SP1 64Bit
-. I installed Mono 2.01, added this installation source in Yast2
-    This distro supports installing packages via YaST. Add the following installation source to YaST:
-    * http://ftp.novell.com/pub/mono/download-stable/SLE_10 [^]
-    For assistance with using repositories and installing packages with YaST, visit the Yast help page.
-    "nant" was installed also via this operation.
-. I installed subversion from http://software.opensuse.org/search [^]
-   SLES/SLED10 ->
-   subversion-1.5.2-34.2.x86_64.rpm
-. I downloaded and installed the lastest SVN version of opensim as usual (like a 32 bit system):
-   http://opensimulator.org/wiki/Build_Instructions [^]
-. I downloaded and installed the Open Dynamics Engine (ODE) to replace the 32 bit version of ODE with a 64 bit version.
-   I did that with the following linux commands:
-  (it is expected that you have all required Linux building tools installed):
-   # cd
-   # svn co http://opensimulator.org/svn/opensim-libs/trunk/unmanaged/OpenDynamicsEngine [^]
-   # cd OpenDynamicEngine
-   # chmod a+x ou/bootstrap
-   # sh autogen.sh
- I installed/updated SLES10 with these rpm's for autogen.sh to run properly. http://software.opensuse.org/search [^]
-   SLES/SLED10 ->
-   - autoconf-2.61-168.1.x86_64.rpm
-   - automake-1.10.1-5.3.x86_64.rpm
-   # CFLAGS="-m64" ./configure --enable-shared
-   # make
- I installed gtk2-devel via yast2, and all its dependancies, because make keept failing.
-   # cp ./ode/src/.libs/libode.so /opt/opensim/bin/
- note:
- in this directory it had made several versions of the "libode.so" because of running the previous commands several times
- so i had to copy libode.so.1.0.0 to /opt/opensim/bin/libode.so
-   # vi ../opensim/bin/OpenSim.ini (change av_capsule_standup_tensor_linux to 1700000)
-The 'chmod' command is required to fix permissions that are wrong.
-The change in OpenSim.ini is required to avoid that avatars have bend legs and/or their feet are in the ground.
-==== Running ====
-Recent versions of OpenSim come without an <tt>OpenSim.ini</tt> file. Copy the <tt>OpenSim.ini.example</tt> file to <tt>OpenSim.ini</tt> before making any changes.
-<code>
- cd bin
- mono OpenSim.exe
-</code>
-Note: if you are running a 32bit Server such as Ubuntu 8.0.4 you need the alternative launcher:
-<code>
-mono OpenSim.32BitLaunch.exe
-</code>
-* To invoke ODE, add the option:
- -physics=OpenDynamicsEngine
-to the <tt>mono OpenSim.exe</tt> line
-or add <code>  physics = OpenDynamicsEngine </code> to the [Startup] section of <tt>OpenSim.ini</tt>.  Same deal for other physics engines, when available.
-On mono 1.2.6, some distributions may see
- Unhandled Exception: System.NotSupportedException: CodePage 1252 not supported
-on startup when using mysql.  This can be resolved by installing the package libmono-i18n2.0-cil (see http://bugs.mysql.com/bug.php?id=33938).
-=== Additional Items ===
-* [[GC_NO_EXPLICIT|GC NO EXPLICIT]] - Enable Large Heap in Mono, this has been known to help performance and stability
-== Hardware selection guide ==
-An often-asked question is "what kind of hardware do I need to successfully run OpenSim?"  Unfortunately, the answer is "it depends".  The number of regions hosted on a given machine, number of simultaneous avatars on those regions, number of prims, use of scripts, etc., all affect hardware requirements.  So, to help you make a more informed selection, some examples of hardware used are listed in the [[Hardware_Selection_Guide|hardware selection guide]].
+[[Category:Users]]
 [[Category:Users]]
 [[Category:Getting Started]]