Mirror of the OpenSimulator source code, just because it isn't on a server with a nice frontend!

Robert Adams 5444b3b1a5 BulletSim: fix problem with walking up stairs that are oriented 11 years ago
.nant 70e46ba815 Change nant distbin target to also remove ThirdParty/ source code when making binary distribution 12 years ago
OpenSim 5444b3b1a5 BulletSim: fix problem with walking up stairs that are oriented 11 years ago
Prebuild 90c6d2e50c Stop Prebuild from generating <copy> statements which unnecessarily copy files into bin/Debug or bin/Release 12 years ago
ThirdParty 319069d193 Assign the SmartThreadPool name in the constructor 11 years ago
ThirdPartyLicenses cb4949fc15 * Added third party license for Bullet-xna. 12 years ago
addon-modules b776e06f0d minor: slightly improve README for building addon-modules within the main OpenSim build 15 years ago
bin 921f911b21 vh: remove unused and error generating BulletXNA DLLs 11 years ago
doc c4fd1c6297 updating config properties added during upgrade process, adding error log file to doxygen config, adding doxygen output directory & error log to .gitignore 12 years ago
share d698df1f37 Remove out-of-date and unused xsd schemas 12 years ago
.gitignore c4fd1c6297 updating config properties added during upgrade process, adding error log file to doxygen config, adding doxygen output directory & error log to .gitignore 12 years ago
.hgignore e719bd4d5c additional patterns for .hgignore 16 years ago
BUILDING.md df3914c7cd renaming to markdown file 12 years ago
CONTRIBUTORS.txt 50ee50bcd5 Revert "Whitespace change to trigger bot" 12 years ago
LICENSE.txt fbd4222533 Last time? 14 years ago
Makefile 01242c5ccb making Makefile a bit more robust: can now cope with missing ruby in a 15 years ago
OpenSim.FxCop 2a3c79df83 changed to native line ending encoding 17 years ago
README.md df3914c7cd renaming to markdown file 12 years ago
TESTING.txt d1ef7ee5ca Add note about setting up test databases 13 years ago
nant-color a3183b2025 in case ruby is somewhere else in the path (just used for coloring output) 15 years ago
prebuild.xml 10a1a6ad3c vh: Remove BulletXNA from sources. 11 years ago
runprebuild.bat f9ff986908 Switch runprebuild.bat from VS2005 to VS2008. Remove runprebuild2008.bat. 15 years ago
runprebuild.sh 6ee17f5b36 Add autoclean for scripted use 12 years ago
runprebuild2010.bat 31125a5fd2 Add execute permission to runprebuild2010.bat 13 years ago

README.md

Welcome to OpenSim!

Overview

OpenSim is a BSD Licensed Open Source project to develop a functioning virtual worlds server platform capable of supporting multiple clients and servers in a heterogeneous grid structure. OpenSim is written in C#, and can run under Mono or the Microsoft .NET runtimes.

This is considered an alpha release. Some stuff works, a lot doesn't. If it breaks, you get to keep both pieces.

Compiling OpenSim

Please see BUILDING.md if you downloaded a source distribution and need to build OpenSim before running it.

Running OpenSim on Windows

We recommend that you run OpenSim from a command prompt on Windows in order to capture any errors.

To run OpenSim from a command prompt

  • cd to the bin/ directory where you unpacked OpenSim
  • run OpenSim.exe

Now see the "Configuring OpenSim" section

Running OpenSim on Linux

You will need Mono >= 2.4.3 to run OpenSim. On some Linux distributions you may need to install additional packages. See http://opensimulator.org/wiki/Dependencies for more information.

To run OpenSim, from the unpacked distribution type:

  • cd bin
  • mono OpenSim.exe

Now see the "Configuring OpenSim" section

Configuring OpenSim

When OpenSim starts for the first time, you will be prompted with a series of questions that look something like:

[09-17 03:54:40] DEFAULT REGION CONFIG: Simulator Name [OpenSim Test]:

For all the options except simulator name, you can safely hit enter to accept the default if you want to connect using a client on the same machine or over your local network.

You will then be asked "Do you wish to join an existing estate?". If you're starting OpenSim for the first time then answer no (which is the default) and provide an estate name.

Shortly afterwards, you will then be asked to enter an estate owner first name, last name, password and e-mail (which can be left blank). Do not forget these details, since initially only this account will be able to manage your region in-world. You can also use these details to perform your first login.

Once you are presented with a prompt that looks like:

Region (My region name) #

You have successfully started OpenSim.

If you want to create another user account to login rather than the estate account, then type "create user" on the OpenSim console and follow the prompts.

Helpful resources:

Connecting to your OpenSim

By default your sim will be available for login on port 9000. You can login by adding -loginuri http://127.0.0.1:9000 to the command that starts Second Life (e.g. in the Target: box of the client icon properties on Windows). You can also login using the network IP address of the machine running OpenSim (e.g. http://192.168.1.2:9000)

To login, use the avatar details that you gave for your estate ownership or the one you set up using the "create user" command.

Bug reports

In the very likely event of bugs biting you (err, your OpenSim) we encourage you to see whether the problem has already been reported on the OpenSim mantis system.

If your bug has already been reported, you might want to add to the bug description and supply additional information.

If your bug has not been reported yet, file a bug report ("opening a mantis"). Useful information to include:

  • description of what went wrong
  • stack trace
  • OpenSim.log (attach as file)
  • OpenSim.ini (attach as file)
  • if running under mono: run OpenSim.exe with the "--debug" flag:

    mono --debug OpenSim.exe

More Information on OpenSim

More extensive information on building, running, and configuring OpenSim, as well as how to report bugs, and participate in the OpenSim project can always be found at http://opensimulator.org.

Thanks for trying OpenSim, we hope it is a pleasant experience.