Go to file
Justin Clark-Casey (justincc) 4f2d2c4efa minor: add a line of documentation to the new ForwardOfflineGroupMessages [Messaging] switch 2010-01-12 20:52:44 +00:00
.nant Remove another lindenudp tests reference. Maybe this will make panda happy 2009-10-09 18:19:51 +01:00
OpenSim Add the option to reject duplicate region names 2010-01-11 22:52:05 +00:00
Prebuild Added VS2010 support to Prebuild and created runprebuild2010.bat 2009-10-22 17:03:13 -07:00
ThirdParty/SmartThreadPool * Allow SmartThreadPool to be initialized without setting max stack size (like the original implementation) 2009-10-22 01:30:12 -07:00
ThirdPartyLicenses * Adding Google.ProtocolBuffers.dll dependency (BSD licensed) 2009-12-27 14:34:41 +11:00
addon-modules minor: slightly improve README for building addon-modules within the main OpenSim build 2010-01-11 15:47:01 +00:00
bin minor: add a line of documentation to the new ForwardOfflineGroupMessages [Messaging] switch 2010-01-12 20:52:44 +00:00
doc
share in the spirit of cleanup, remove the old sql directory, as this stuff is 2009-01-26 15:42:21 +00:00
.gitignore additional log files to ignore, also ignoring TestResult.xml 2009-09-09 09:56:07 +02:00
.hgignore
CONTRIBUTORS.txt * Implements OSSL function: osGetSimulatorMemory - returns the current amount of memory allocated to the simulator process (Moderate Threat Level). 2009-12-13 03:04:16 +11:00
LICENSE.txt
Makefile
OpenSim.FxCop
README.txt Add some configuration hints and references to README.txt 2010-01-08 23:09:38 -08:00
TESTING.txt
nant-color
prebuild.xml * Added prebuild for previous commit. 2009-12-27 15:03:26 +11:00
runprebuild.bat
runprebuild.sh
runprebuild2010.bat Added VS2010 support to Prebuild and created runprebuild2010.bat 2009-10-22 17:03:13 -07:00

README.txt

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.

== Installation on Windows ==

Prereqs:
 * runprebuild.bat
 * Load OpenSim.sln into Visual Studio .NET and build the solution.
 * chdir bin
 * edit OpenSim.ini and appropriate files in bin/config-include
 * OpenSim.exe
 
 Helpful resources:
* http://opensimulator.org/wiki/Build_Instructions

See configuring OpenSim

== Installation on Linux ==

Prereqs:
 * Mono >= 2.4.2
 * Nant >= 0.86 beta 1 (if building with the .NET framework on Windows), 0.85 (if building with the mono framework)
 * sqlite3 or mysql 5.x (you'll need a backend database)

From the distribution type:
 * ./runprebuild.sh
 * nant
 * cd bin
 * edit OpenSim.ini and appropriate files in bin/config-include
 * mono ./OpenSim.exe

See configuring OpenSim

== Configuring OpenSim ==
 Helpful resources:
* http://opensimulator.org/wiki/Configuration
* http://opensimulator.org/wiki/Configuring_Regions
* http://opensimulator.org/wiki/Mysql-config

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

At each of these you must provide you own value or just hit enter to
take the default (in this case "OpenSim Test").

YOUR SIM WILL NOT BE STARTED UNTIL YOU ANSWER ALL QUESTIONS

Once you are presented with a prompt that looks like:

  Region# :

You have successfully started OpenSim.

== Connecting to your OpenSim ==

By default your sim will be running on http://127.0.0.1:9000.  To use
your OpenSim add -loginuri http://127.0.0.1:9000 to your second life
client (running on the same machine as your OpenSim).

== Bug reports ==

In the 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. You can find the OpenSim mantis system at

    http://opensimulator.org/mantis/main_page.php

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.