Build Instructions

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m (→‎MS Windows)
m (→‎Install dotnet under Debian/Ubuntu)
 
(258 intermediate revisions by 24 users not shown)
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]].
  
−
UPDATED: Feb.15.2010
+
= Building =
  
−
OpenSim requires either the .Net Framework version 3.51, or Mono 2.4.2.3 or newer. It supports the following compilers:
 
  
−
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]
+
Although this page is long, building is generally quite simple. See the BUILDING.txt file in the distribution itself for simplified instructions.
  
−
*[http://msdn2.microsoft.com/en-us/express/aa700756.aspx Microsoft Visual C# Express Edition] (note: not Visual C++)
+
== Version 0.9.3.0 and above ==
−
New URL: http://www.microsoft.com/express/Windows/ ( The Visual Studio® 2010 Express )
+
Microsoft stopped the development of .Net Framework and Mono, replacing them by new dotnet
−
*[http://www.mono-project.com/ mono]
+
This is a significant breaking change that we try to follow on 0.9.3.0.
  
−
Additional note: If you like IDE's you will need C# express 2008 or VS 2008.
+
=== Get source code ===
  
−
Additional note: Microsoft C# Express v9 may install .Net 3.5 with resultant path error.
+
get or update source from git
  
−
#To avoid install .Net framework version 2.0 (installed by default in Windows XP & newer)
+
git clone git://opensimulator.org/git/opensim
  
−
Additional note: It is possible to develop on Windows Vista 64 bits with the following tweaks:  
+
=== Building on Windows ===
 +
To building under Windows, the following is required:
  
−
#Select OpenSim project properties from solution and choose platform to be x86. Rebuild solution.  
+
* [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 dotnet 8.0 SDK]
−
#Select OpenSim.exe properties under solution bin folder and choose windows xp sp 2 compatibility mode + run as administrator.
+
  
−
=== Building  ===
+
optionally also
  
−
*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.
+
* Visual Studio .NET, version 2022 or later
  
−
*Open the resulting sln file with visual studio and build it there, or
 
−
*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.
 
  
−
Note that only a limited number of directories and files are actually required for a working system,the rest are just used for source code and the build process:
+
Create the project files running:
−
  addon-modules
+
−
  bin
+
−
  doc
+
−
  share
+
−
  ThirdParty
+
−
  ThirdPartyLicences
+
−
  BUILDING.txt
+
−
  CONTRIBUTORS.txt
+
−
  LICENSE.txt
+
−
  README.txt
+
−
  TESTING.bat
+
  
−
=== Running ===
+
  runprebuild.bat
  
−
Copy the <tt>bin/OpenSim.ini.example</tt> file to <tt>bin/OpenSim.ini</tt> before making any changes.  
+
Load the generated OpenSim.sln into Visual Studio and build the solution, or just run
 +
compile.bat
  
−
Assuming you initially want to create an Opensim Standalone setup, the example Opensim.ini already has the appropriate [Architecture] setting for that in place referring to an include file at <tt>bin/config-include/StandaloneCommon.ini.example</tt>.
+
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
  
−
Copy the <tt>bin/config-include/StandaloneCommon.ini.example</tt> file to <tt>bin/config-include/StandaloneCommon.ini</tt> before making any changes to that too. A cache is recommended to make Opensim run in a more stable and efficient manner.  Choose a cache as described in <tt>bin/config-include/StandaloneCommon.ini</tt>.
 
  
−
Double-click on the <tt>OpenSim.exe</tt> executable file in the <tt>bin</tt> directory. This will start up OpenSim in standalone mode.  
+
Configure, See [[Configuration]].
  
−
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.
 
  
−
'''''Windows Vista'''''
+
Now just run OpenSim.exe from the bin folder, and set up the region.
  
−
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.
+
=== Building on Linux / Mac ===
  
−
If you have McAfee SecurityCenter, see the description below.  
+
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
  
−
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.
 
  
−
<br>'''''McAfee Security'''''
+
Create the project files, run:
  
−
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.  
+
./runprebuild.sh
  
−
''Disable firewall''
+
then run
 +
dotnet build --configuration Release OpenSim.sln
  
−
Open McAfee SecurityCenter. Select "Internet &amp; 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".  
+
or just
 +
./compile.sh
  
−
''Enable <tt>OpenSim.exe</tt> to open ports''
 
  
−
Open McAfee SecurityCenter. Select "Internet &amp; 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.  
+
Configure. See [[Configuration]].
  
−
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.
+
run ./opensim.sh from the bin folder, and set up the region
  
−
==Linux/Mac OS X/FreeBSD==
+
== 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.
  
−
The easiest platform to get running on the Linux side is Ubuntu 10.04, 32bit.  This is what most of the developers running Linux use.  If you are looking for the quick path, start there.
+
== Requirements ==
  
−
'''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.'''
+
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 ===
 
  
−
For Ubuntu users on older distributions (7.10, 8.04, etc.) '''you need''' to upgrade your version of mono to at least 2.4. For anyone who needs to upgrade their Mono, see [[Update Mono on Ubuntu]].
+
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.
  
−
Ubuntu Karmic (9.10) includes mono 2.4.2.3 packages.
+
Other platforms may have own mono distributions, or may need to compile mono on them.
  
−
Ubuntu Lucid (10.04) includes mono 2.4.4 packages
+
Other libraries used by OpenSimulator can be found at our opensim-libs git repo:
  
−
Ubuntu Maverick (10.10) includes mono 2.6.7 packages
+
git clone git://opensimulator.org/git/opensim-libs
  
−
To build:
+
libOpenMetaVerse used can be found at https://bitbucket.org/opensimulator/
  
−
sudo apt-get install nant mono-gmcs libmono-microsoft8.0-cil \
+
You may need to compile them for your platform, in particular the unmanaged ones like Bullet or ODE native code libraries
−
      libmono-system-runtime2.0-cil libgdiplus libmono-i18n2.0-cil libmono-oracle2.0-cil
+
−
[[Download]] opensim
+
−
cd opensim
+
−
./runprebuild.sh
+
−
nant
+
  
−
=== openSUSE 10.3/11/11.1 ===
+
== MS Windows ==
  
−
Install an openSUSE 11.1, 11 or 10.3 with its default options, add the online repositories
+
=== Supported Compilers ===
−
when finished installing do an online update with all the latest packages.
+
* [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
  
−
In yast install these packages, for running Opensim in standalone mode.
+
=== Compiling in an IDE ===
−
(there is a slight diffrence between 10.3 and 11/11.1 but following should be same)
+
# Run "runprebuild.bat"
−
subversion
+
# Open the resulting "OpenSim.sln" in Visual Studio IDE.
−
nant
+
# Select Debug or Release configuration
−
mono-jscript
+
# Menu Build -> Build Solution.
−
- check that mono-core is installed
+
  
−
just in case you do not already have it installed
+
===Compiling at the Command Prompt ===
 +
# Run "runprebuild.bat".
 +
# Run the resulting "compile.bat" file.
  
−
  sudo zypper install mono-data-oracle
+
== Linux and Other Mono Platforms ==
  
−
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:
+
=== Install dotnet under Debian/Ubuntu ===
  
−
  sudo zypper install nant
+
For Ubuntu 22.04 LTS and higher, dotnet is available in the distribution's repos.
  
−
If you just want to use SQLite then jump to last section
+
For Ubuntu 20.04 LTS and lower, and for all versions of Debian, add Microsoft repository to your installation :
−
within this post.
+
  
−
* Optional mysql - for Opensim running in Grid mode:
+
<source lang="bash">
−
Install these mysql packages via yast
+
# Get OS version info
−
  mysql
+
source /etc/os-release
−
  mysql-client
+
−
  mysql-administrator
+
−
  mysql-gui-tools
+
−
  mysql-query-browser
+
  
−
(note that selecting mysql in the Yast2 Installer will select the other packages automatically)
+
# Download Microsoft signing key and repository
 +
wget https://packages.microsoft.com/config/$ID/$VERSION_ID/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
  
−
Before building create the mysql database.
+
# Install Microsoft signing key and repository
−
/etc/init.d/mysql start
+
sudo dpkg -i packages-microsoft-prod.deb
−
mysql -u root -p -h localhost
+
−
(when asked for password just hit enter)
+
  
−
mysql> create database opensim;
+
# Clean up
−
mysql> use opensim;
+
rm packages-microsoft-prod.deb
−
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.
+
# Update packages
 +
sudo apt update
 +
</source>
  
−
On current builds set the connection string inside bin/OpenSim.ini after coppying the OpenSim.ini.example file.
+
Then :
−
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
+
<source lang="bash">
 +
sudo apt update
 +
sudo apt install dotnet-sdk-8.0
 +
</source>
  
−
su -
+
https://learn.microsoft.com/en-us/dotnet/core/install/linux-ubuntu<br/>
−
cd /opt
+
https://learn.microsoft.com/en-us/dotnet/core/install/linux-debian<br/>
−
[[Download]] opensim
+
−
cd opensim
+
−
./runprebuild.sh
+
−
nant
+
  
−
Or, if you have a current (0.6+), you can simply execute:
+
=== Prepare to compile ===
 +
To create the several project files run on the folder opensim:
  
−
make
 
−
 
−
After this you should be able to continue on starting the diffrent Servers, look in the mysql-config section,or
 
−
just run your OpenSim as a Standalone.
 
−
 
−
=== Mac OS X 10.5/10.4 ===
 
−
* 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 (Works on iMac G5 with OS 10.4.11, including expanding to local grid mode.
 
−
* 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.
 
−
* Install X11 for 10.4 from the Optional Install from the DVD/CD Installation Disk. X11 for 10.5 is installed by default.
 
−
* 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 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
 
−
* libopenjpeg-libsl-2.1.2.0.dylib:
 
−
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.
 
−
 
−
* 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])
 
−
cd .. (back into opensim-libs)
 
−
nant
 
−
cp bin/libsecondlife.dll ../bin
 
−
 
−
* Edit the libsecondlife.dll.config (PowerPC Only). Remove the cpu="x86" tag in the last dllmap line.
 
−
 
−
You might find it work for your environment (OS X 10.5.7, Intel):
 
−
 
−
* 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
 
   ./runprebuild.sh
−
  nant
 
  
−
You might find it work for your environment (OS X 10.5.7 and 10.6, Intel) on (8/9/09):
+
==== 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
 
−
* Very important to grab the latest Apple Dev Tools (3.2.1 on 8/9/09) (from [http://developer.apple.com/] - You will need a developer account, it is free.
 
−
* install Mono Framework 2.4 (version 2.4.2.3 on 8/9/09) from [http://www.go-mono.com/mono-downloads/download.html]
 
−
* install Mac Ports from [http://www.macports.org/]
 
−
* Mac Ports should update its packages on install, but to be safe, type the following at the Terminal:
 
−
  sudo port -v selfupdate
 
−
* Use mac ports to install nant. (This should pull in everything you need. I think this will also try to install mono, but since I already had it installed, that errored on me. Don't worry about it though, it should install everything else you need.) At the Terminal type:
 
−
  sudo port install nant
 
−
   
 
−
* Get OpenSim source. I downloaded 0.6.6 from [http://opensimulator.org/wiki/Download]
 
−
* Uncompress the download.
 
−
* Compile OpenSim:
 
−
  cd opensim
 
−
  ./runprebuild.sh
 
 
   nant
 
   nant
−
 
 
−
*Then of course the issue with the 0.6.6 release.
 
−
This release had some bugs with default automatic configuration on the first startup of OpenSim.exe.  bin/Regions/default.xml (region configuration file) is not automatically created in the main directory.  Therefore, you must manually create this file.  Here is an example.
 
−
<pre>
 
−
<Root>
 
−
  <Config sim_UUID="UUID" sim_name="NAME" sim_location_x="1000" sim_location_y="1000"
 
−
internal_ip_address="IP_ADDRESS_OF_SERVER" internal_ip_port="9000" allow_alternate_ports="false"
 
−
external_host_name="DNS_NAME_OF_SERVER" master_avatar_uuid="00000000-0000-0000-0000-000000000000"
 
−
estate_covanant_uuid="00000000-0000-0000-0000-000000000000" master_avatar_first="FIRST_NAME"
 
−
master_avatar_last="SECOND_NAME" master_avatar_pass="PASSWORD" />
 
−
</Root>
 
−
</pre>
 
−
You must change UUID, NAME, IP_ADDRESS_OF_SERVER, DNS_NAME_OF_SERVER, FIRST_NAME, SECOND_NAME and PASSWORD to your own values.
 
−
(I noticed than IP_ADDRESS_OF_SERVER should be set to real IP not to 127.0.0.1)
 
  
−
'''Summary''':
+
==== Compile with xbuild ====
  
−
*Run OpenSim0.6.6Setup.exe and install OpenSim in Windows
+
On mono versions you can just use xbuild. ''(msbuild is recommended for 0.9.1.0.0+)''
−
*Run OpenSim.exe and enter default values - record them!
+
−
*Shutdown simulator (command: shutdown)
+
−
*Create default.xml with copy of above
+
−
*Change values in default.xml with recoded values
+
−
*Be sure default.xml be in main directory (same with OpenSim.ini)
+
−
*Run again OpenSim.exe
+
−
*Connect with viewer
+
  
−
=== FreeBSD 6.2 ===
+
  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]
+
xbuild is no longer recommended on mono 5.x, but currently still works (5.12)
−
"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 tool is deprecated and will be removed in future updates, use msbuild instead <<<<''
−
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 ===
+
On more recent mono versions Release configuration may give some performance gain, but you do lose some debug capabilities.
−
sudo vi /etc/yum.repos.d/mono.repo
+
to compile Release configuration:
 +
  xbuild /p:Configuration=Release
  
−
  [mono]
+
==== Compile with msbuild ====
−
  name=Mono for rhel-4-i386 (stable)
+
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 )
−
  baseurl=http://ftp.novell.com/pub/mono/download-stable/rhel-4-i386/
+
−
  enabled=1
+
−
  gpgcheck=0
+
  
−
sudo yum install mono-complete monodoc-core nant
+
Use xbuild on the other cases as a last resort.
−
[[Download]] opensim
+
−
cd opensim
+
−
./runprebuild.sh
+
−
nant
+
  
−
=== RedHat Enterprise Linux 5 ===
+
Recent improvements, specially on JIT runtime, justify compiling in Release configuration, but you do lose some debug capabilities.
  
−
The instructions below also work on other RedHat Linux flavors such as CentOS or maybe Fedora.
+
to compile with Debug configuration:
 +
  msbuild
  
−
1. Put the [http://download.opensuse.org/repositories/Mono/RHEL_5/Mono.repo Mono.repo] file in the /etc/yum.repo.d/ directory:
+
to compile with Release configuration:
−
$ sudo su -
+
  msbuild /p:Configuration=Release
−
$ 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].
+
  
−
2. Install Mono and related tools with yum:
+
to compile with the debug configuration and detailed opensim.log file can then be read with a text editor:
−
$ yum install mono nant mono-jscript mono-nunit
+
  msbuild /p:Configuration=Debug /fileLogger /flp:logfile=opensim.log /v:d
−
Make sure to use nunit-console2 to run your tests.
+
  
−
=== Fedora 12 &amp; 13  ===
+
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].
  
−
Fedora 12 and 13 installs are fairly simple. Nant and Mono now work out of the box with OpenSim. Incase you are completley new to this, here is a complete step by step guide to run OpenSim on a base install of Fedora (bare minimum of packages). It will also work on GUI installs.
+
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.
  
−
1. yum install wget nano nant libgdiplus mono-devel mono-jscript
+
== 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>
  
−
2. [[Download]] opensim (wget [http://dist.opensimulator.org/opensim-0.7.0.1-source.tar.gz http://dist.opensimulator.org/opensim-0.7.0.1-source.tar.gz])
+
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>
  
−
3. tar -xf opensim-0.7.0.1-source.tar.gz
+
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>
  
−
4. mv opensim-0.7.0.1-source opensim
+
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>
  
−
5. cd opensim
+
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>
  
−
6. ./runprebuild.sh
+
= Configuration =
  
−
7. nant
+
See [[Configuration]].
−
 
+
−
8. cd /bin
+
−
 
+
−
9. cd /config-include/
+
−
 
+
−
10. cp StandaloneCommon.ini.example StandaloneCommon.ini
+
−
 
+
−
11. cd ..
+
−
 
+
−
12. cp OpenSim.ini.example OpenSim.ini
+
−
 
+
−
13. mono OpenSim.exe
+
−
 
+
−
=== Fedora 5 ===
+
−
* 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.
+
−
 
+
−
For detailed instructions go [http://ruakuu.blogspot.com/2008/06/installing-and-configuring-opensim-on.html here]
+
−
 
+
−
=== Debian 4 ===
+
−
 
+
−
For detailed instructions please see [[Debian 4 Build Instructions]]
+
−
 
+
−
=== Debian 5 ===
+
−
 
+
−
1. 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.
+
−
 
+
−
2. Log in as your root user make sure it works.
+
−
 
+
−
3. type: aptitude update (or apt-get update)
+
−
 
+
−
4. type: aptitude install nant and answer 'y' to 'Do you want to continue'- This will install nant and all of its dependancies.
+
−
 
+
−
5. type: apt-get install git-core and answer 'y' to 'Do you want to continue'.
+
−
 
+
−
6. 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'
+
−
 
+
−
7. type: wget http://ftp.novell.com/pub/mono/sources/mono/mono-2.4.3.tar.bz2 to download mono
+
−
 
+
−
8. type: tar xf mono-2.4.3.tar.bz2 to extract the mono source code to a directory (substitute the latest build)
+
−
 
+
−
9. type: cd mono-2.4.3 to change int the directory you just created
+
−
 
+
−
10. type: ./configure --with-libgdiplus=yes - wait for it to finish
+
−
 
+
−
11. type: make - and wait some more as this takes a bit - moreso on older machines
+
−
 
+
−
12. type: make install
+
−
 
+
−
13. type: cd /
+
−
 
+
−
14 type: git clone git://opensimulator.org/git/opensim
+
−
 
+
−
15 type: cd opensim
+
−
 
+
−
16. type: git checkout -b 0.6.8-post-fixes origin/0.6.8-post-fixes (substitute the latest build)
+
−
 
+
−
17. type: git pull
+
−
 
+
−
18. 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)
+
−
 
+
−
19. Reboot, just to make sure it all comes up cleanly (type: shutdown -r now)
+
−
 
+
−
20. Login, type: cd /
+
−
 
+
−
21. type: cd opensim
+
−
 
+
−
22. type: ./runprebuild.sh
+
−
 
+
−
23 type: nant - wait for this to finish
+
−
 
+
−
24. type: cd bin
+
−
 
+
−
25. type: cp OpenSim.ini.example OpenSim.ini
+
−
 
+
−
26. type: mono OpenSim.exe
+
−
 
+
−
27. 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.
+
−
 
+
−
=== CentOS 5.2 32bit ===
+
−
 
+
−
For detailed instructions please see [[CentOS 5.2 Build Instructions]]
+
−
 
+
−
=== CentOS 5.3 32bit ===
+
−
 
+
−
For detailed installation and configuration instructions please see this [http://www.linuxtraining.org.uk/blogger4.html blog]
+
−
 
+
−
=== 64bit ===
+
−
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]]
+
−
 
+
−
 
+
−
=== Physics (Open Dynamics Engine ODE) ===
+
−
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.
+
−
 
+
−
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:
+
−
 
+
−
svn co http://opensimulator.org/svn/opensim-libs/trunk/unmanaged/OpenDynamicsEngine
+
−
 
+
−
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
+
−
 
+
−
1. 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.
+
−
 
+
−
2. I installed subversion from http://software.opensuse.org/search [^]
+
−
 
+
−
  SLES/SLED10 ->
+
−
  subversion-1.5.2-34.2.x86_64.rpm
+
−
 
+
−
3. I downloaded and installed the lastest SVN version of opensim as usual (like a 32 bit system):
+
−
  http://opensimulator.org/wiki/Build_Instructions [^]
+
−
 
+
−
4. 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).
+
  
 +
[[Category:Users]]
 
[[Category:Users]]
 
[[Category:Users]]
 
[[Category:Getting Started]]
 
[[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