Build Instructions

2007-10-22T20:16:07Z

Chrisc: /* Running */

=Installing from source=

==MS Windows==

OpenSim requires either the .Net framework version 2.0, or the latest Mono. It supports the following compilers:
* [http://msdn2.microsoft.com/en-us/express/aa700756.aspx Microsoft Visual C# Express Edition] (note: not Visual C++)
* [http://www.mono-project.com/ mono]

Note for people who just downloaded the sources from http://dist.opensimulator.org/ (the "Downloads" link on the left) be advised that some important things are missing (like MySQL template scripts). For such features, you must download using svn!

=== Subversion Repository ===

1. Get the source code from the svn repository:

http://opensimulator.org/svn/opensim/trunk

=== Building ===

2. In the top-level directory, run the '<tt>runprebuild.bat</tt>' file. This will create both a VS2005 solution file, and a nant build file.

3. Open the resulting sln file with visual studio, and build it there, or if you prefer to use nant, run nant in the same top-level directory. This will build the executables.

If you don't care about physics (walking on prims, etc), ignore the rest of this section.

==== Physics ====

===== Open Dynamics Engine (ODE) =====

If you want to implement collision-based physics, OpenDynamicsEngine (ODE) is the furthest along at the moment (9/07). It is not fully supported, but is starting to work somewhat reliably using a small number of regions per sim.

As installed from svn, ODE does not work on all platforms. If you get an ODE-related crash, and/or an ode.dll not found type of error (which can occur even though the dll is present!), try using the debug version of the dll, available here:

http://www.squiggle.com/opensim/ode-debug.dll 

Rename it <tt>ode.dll</tt> and put it in <tt>.\bin</tt>, replacing the stock <tt>ode.dll</tt>. You can also try building <tt>ode.dll</tt> from the latest version of the source (http://www.ode.org/; make sure to enable trimesh)

=== Running ===

Double-click on the <tt>OpenSim.exe</tt> executable file in the <tt>bin</tt> directory. This will start up OpenSim in standalone mode.

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:

physics = OpenDynamicsEngine

You can also add a command line option to a shortcut, or run from a command prompt with:

-physics=OpenDynamicsEngine

'''''Windows Vista'''''

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.

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.

'''''McAfee Security'''''

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

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

''Enable <tt>OpenSim.exe</tt> to open ports''

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.

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.

==Linux/Mac OS X==

=== Subversion Repository ===

To check out the latest revision:

svn co http://opensimulator.org/svn/opensim/trunk opensim

Note: The <tt>libopenjpeg-libsl-...so</tt> is not really working. For this reason you should download the newest libsecondlife from http://www.libsecondlife.org/, and build your own libopenjpeg library. If you use this instead of the SVN version, your sim will work fine.

Notes to Mac OS X users:

* OS X does not come packaged with subversion, so you will need to either install it or access the repository from a computer that does have subversion.
* You'll also need to install Mono.
* The version of Mono in MacPorts (formerly DarwinPorts) seems to be out of date and produced compilation errors on my system. You may have better luck installing the newest package from http://www.mono-project.com/Downloads
* Even with the newer version, there's a config problem with NAnt. There's a blog post here: http://bleepsoft.com/tyler/index.php?itemid=82 which explains how to fix the script (the blog post shows the path for 1.1.18 -- you'll need to replace this with 1.2.5 if you install the latest version from mono-project.com).

=== Building (Mono) ===

cd opensim
./runprebuild.sh
nant

If you encounter any errors while trying this, check the [[Troubleshooting]] page for help.

==== Physics (Unix) ====

If you want to implement collision-based physics, OpenDynamicsEngine (ODE) is the furthest along at the moment (9/07). It is not fully supported, but is starting to work somewhat reliably using a small number of regions per sim.

===== Open Dynamics Engine (ODE) =====

As installed from svn, ODE does not work on all platforms. If you get an ODE-related crash, and/or a libode.so not found 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 packages from http://www.ode.org/. 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>)

=== Running (Mono) ===

cd bin
mono OpenSim.exe

to invoke ODE, add the option:
-physics=OpenDynamicsEngine

or add <code> physics = OpenDynamicsEngine </code> to the [Startup] section of <tt>OpenSim.ini</tt>. Same deal for other physics engines, when available.

=Binary releases=

Nightly builds, in tar-gzip format:

http://ruth.petitbe.be/build/

Talk:Main Page

2007-09-05T04:13:47Z

Chrisc: What we need to compile OpenSim

Just hoping someone updates the IRC channels soon.
I want to become a part of the development community soon.

Just a note, hoping someone can fix this problem. When I attempt to use the SVN Browser link, I get the following error:

-snip-

An Exception Has Occurred
Python Traceback

Traceback (most recent call last):
File "/usr/local/viewvc-1.0.3/lib/viewvc.py", line 3629, in main
request.run_viewvc()
File "/usr/local/viewvc-1.0.3/lib/viewvc.py", line 253, in run_viewvc
import vclib.svn
File "/usr/local/viewvc-1.0.3/lib/vclib/svn/__init__.py", line 25, in ?
from svn import fs, repos, core, delta
ImportError: No module named svn

-snip-

[[User:Tildeampersand|Tilde]] 19:44, 7 August 2007 (PDT)

== What we need to compile OpenSim ==

I seem to remember the old Wiki had a list of all the products required to compile OpenSim. For example, I believe Python needs to be installed as well as at least Visual Studio 2005 Express. Each had a link to where the download could be found.

I can't remember all the tools required, and I haven't been able to navigate Microsoft's web page to find the free download of Visual Studio 2005 Express.

It'd be great if this could be made available again.

Thanks,
Chrisc

Talk:Main Page

2007-08-05T02:41:32Z

Chrisc:

Just hoping someone updates the IRC channels soon.
I want to become a part of the development community soon.

OpenSimulator - User contributions [en]

Build Instructions

Talk:Main Page

Talk:Main Page