Repository files navigation

OpenSim is a BSD Licensed Open Source project to develop a functioningvirtual worlds server platform capable of supporting multiple clientsand servers in a heterogeneous grid structure. OpenSim is written inC#, 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 keepboth pieces.

Please see BUILDING.md

You will need dotnet 8.0 runtime (https://dotnet.microsoft.com/en-us/download/dotnet/8.0)

To run OpenSim from a command prompt

• cd to the bin/ directory where you unpacked OpenSim
• review and change configuration files (.ini) for your needs. see the "Configuring OpenSim" section
• run OpenSim.exe

You will need

• dotnet 8.0 Runtime
• libgdiplus

if you have mono 6.x complete, you already have libgdiplus, otherwise you need to install itusing a package manager for your operating system, like apt, brew, macports, etcfor example on debian:

apt-get update && apt-get install -y apt-utils libgdiplus libc6-dev

To run OpenSim, from the unpacked distribution type:

• cd bin
• review and change configuration files (.ini) for your needs. see the "Configuring OpenSim" section
• run ./opensim.sh

When OpenSim starts for the first time, you will be prompted with aseries 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 acceptthe default if you want to connect using a client on the same machine or overyour local network.

You will then be asked "Do you wish to join an existing estate?". If you'restarting OpenSim for the first time then answer no (which is the default) andprovide 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 thesedetails, since initially only this account will be able to manage your regionin-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 estateaccount, then type "create user" on the OpenSim console and follow the prompts.

Helpful resources:

• http://opensimulator.org/wiki/Configuration
• http://opensimulator.org/wiki/Configuring_Regions

By default your sim will be available for login on port 9000. You can login byadding -loginurihttp://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 canalso 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 theone you set up using the "create user" command.

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

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

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

• description of what went wrong
• stack trace
• OpenSim.log (attach as file)
• OpenSim.ini (attach as file)

More extensive information on building, running, and configuringOpenSim, as well as how to report bugs, and participate in the OpenSimproject can always be found athttp://opensimulator.org.

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