OpenSimulator · EN

Standalone installation from start to finish

Your first region and avatar with the fewest services to maintain.

Learning path for OpenSimulator 0.9.3.1 / .NET 8. Adapt domains, secrets, versions and ports to your installation. Verify source files before production.

Who is this for?

Use Standalone for learning, testing or a small independent world without a separate ROBUST process. For multiple simulator processes sharing one grid, choose Grid.

Basic preparation

Follow Start here for .NET 8 requirements and source compilation. Work in the built bin directory as an unprivileged user. Back up configuration files before editing.

Copy the two required templates

BUILDING.md requires creating OpenSim.ini from OpenSim.ini.example and StandaloneCommon.ini from its template. Check for existing files first; never overwrite an existing setup blindly.

Adapt this example: verify paths, hostnames, permissions and settings.

cd bin
test ! -e OpenSim.ini && cp OpenSim.ini.example OpenSim.ini
test ! -e config-include/StandaloneCommon.ini && cp config-include/StandaloneCommon.ini.example config-include/StandaloneCommon.ini

Select Standalone

Under [Architecture] in OpenSim.ini, enable exactly one Include-Architecture setting. Start with Standalone.ini without Hypergrid. Hypergrid needs StandaloneHypergrid.ini and additional network checks.

Adapt this example: verify paths, hostnames, permissions and settings.

[Architecture]
Include-Architecture = "config-include/Standalone.ini"

Start with SQLite

The StandaloneCommon.ini.example template uses SQLite storage by default. This allows a first launch without a MySQL account. MySQL is an option for later operational needs, but data migration is a separate task.

Optional MySQL setup

If choosing MySQL, create a dedicated database and restricted SQL account; configure [DatabaseService] in the loaded StandaloneCommon.ini. Verify authentication compatibility with the installed MySQL client. Do not use documentation passwords in production.

Adapt this example: verify paths, hostnames, permissions and settings.

[DatabaseService]
StorageProvider = "OpenSim.Data.MySQL.dll"
ConnectionString = "Data Source=localhost;Database=opensim;User ID=opensim;Password=REPLACE_WITH_PRIVATE_SECRET;Old Guids=true;"

Ports, access and DNS

For a first local test, repository examples use port 9000 as the login URI. For remote clients, the region's advertised external address and actual TCP/UDP ports must be reachable; do not confuse listening addresses and published addresses.

Interactive first start

Start OpenSim from bin. You may be prompted for region name, coordinates, port, estate and estate owner credentials. Securely record estate owner credentials. Do not force public addresses before DNS and firewall checks.

Adapt this example: verify paths, hostnames, permissions and settings.

cd bin
./opensim.sh

Check console readiness

A prompt such as Region (region name) # indicates the startup reached its console. It does not prove external connectivity. Check URI, logs and then follow the first-login guide.

Adapt this example: verify paths, hostnames, permissions and settings.

help
show region
stats show

Growing beyond standalone

Migrating to Grid is not just changing Include-Architecture: services and databases move. Plan OAR/IAR backups, users, assets, regions and rollback.

Next steps and references

Switch from Standalone to Standalone Hypergrid