This guide covers how to set up and configure your Resonite headless server hosted with Legion Hosting. Resonite is a social VR platform where users can build, create, and socialize in user-generated worlds. For session management and admin commands, see Resonite Server Admin Guide.
1. Accessing Your Server
- Log in to GPanel.
- Select your Resonite server from the server list.
- Your server is managed through the Console tab in GPanel and the Resonite headless configuration.
2. Startup Variables
Configure these settings from the Startup tab in GPanel:
| Variable | Env Name | Default | Description |
|---|---|---|---|
| Enable Mod Loader | ENABLE_MODLOADER |
false | Enable ResoniteModLoader for custom mods (true/false). |
| Auto Update | AUTO_UPDATE |
1 | Automatically update the server on startup (1=yes, 0=no). |
/headlessCode) is required for installation. This is configured by the hosting provider.
3. Configuration File
The main configuration file is Headless/Config/Config.json. Edit it via SFTP. Key settings:
{
"tickRate": 60.0,
"maxConcurrentAssetTransfers": 4,
"loginCredential": "your_username",
"loginPassword": "your_password",
"startWorlds": [
{
"isEnabled": true,
"sessionName": "My World",
"maxUsers": 32,
"accessLevel": "Anyone",
"loadWorldPresetName": "SpaceWorld",
"autoRecover": true,
"autoSleep": true,
"saveOnExit": false
}
]
}4. Config.json Settings Reference
| Setting | Default | Description |
|---|---|---|
tickRate | 60.0 | Server simulation tick rate. |
maxConcurrentAssetTransfers | 4 | Maximum simultaneous asset downloads. |
loginCredential | (empty) | Resonite account username for the headless. |
loginPassword | (empty) | Resonite account password. |
5. World Configuration
Each entry in the startWorlds array defines a world session. Key world settings:
| Setting | Default | Description |
|---|---|---|
isEnabled | true | Whether this world should start. |
sessionName | null | Display name for the session. |
maxUsers | 32 | Maximum users in the world. |
accessLevel | Anyone | Who can join: Anyone, RegisteredUsers, Contacts, ContactsPlus, Private. |
loadWorldPresetName | SpaceWorld | Preset world to load (e.g. SpaceWorld, Grid, BasicEmpty). |
loadWorldURL | null | URL of a custom world to load instead of a preset. |
autoRecover | true | Automatically recover the world after a crash. |
autoSleep | true | Put the world to sleep when no users are present. |
saveOnExit | false | Save the world state when the server shuts down. |
autosaveInterval | -1.0 | Autosave interval in seconds (-1 = disabled). |
hideFromPublicListing | null | Hide this session from the public listing. |
awayKickMinutes | -1.0 | Minutes before AFK users are kicked (-1 = disabled). |
idleRestartInterval | -1.0 | Restart the world after this many seconds of being empty (-1 = disabled). |
forcedRestartInterval | -1.0 | Force restart after this many seconds regardless of users (-1 = disabled). |
6. Connecting to Your Server
- Launch Resonite on your PC or VR headset.
- Open the Session Browser (Dash Menu > Worlds).
- Search for your server by session name.
- Click Join to enter the world.
For private sessions, the headless account must invite users or use autoInviteUsernames in the config.
7. First-Time Setup Checklist
- Edit
Headless/Config/Config.jsonto setloginCredentialandloginPasswordfor your Resonite account. - Set a
sessionNamefor your world. - Choose a
loadWorldPresetNameor provide aloadWorldURLfor a custom world. - Set the
accessLevelto control who can join. - Start the server and verify it shows
World running...in the console.
Related Articles
Need Help?
If you run into issues with your Resonite server, open a support ticket and include your server details, a description of the problem, and any error messages from the GPanel console.
