This guide covers headless console commands, session management, mod loader setup, and troubleshooting for your Resonite server. For initial setup, see Resonite Headless Server Setup Guide.
1. Headless Console Commands
The Resonite headless server accepts commands via the GPanel console. The server responds to the shutdown command for graceful shutdown.
| Command | Description |
|---|---|
worlds |
List all active world sessions. |
focus <world_index> |
Focus on a specific world for commands. |
status |
Show status of the focused world. |
users |
List users in the focused world. |
kick <username> |
Kick a user from the focused world. |
ban <username> |
Ban a user from the focused world. |
silence <username> |
Mute a user in the focused world. |
unsilence <username> |
Unmute a user. |
respawn <username> |
Respawn a user to the world origin. |
role <username> <role> |
Set a user's role (Admin, Builder, Moderator, Guest, Spectator). |
name <session_name> |
Rename the focused session. |
accessLevel <level> |
Change who can join (Anyone, RegisteredUsers, Contacts, ContactsPlus, Private). |
maxUsers <count> |
Change the max user count for the focused world. |
save |
Save the focused world. |
close |
Close the focused world. |
restart |
Restart the focused world. |
invite <username> |
Invite a user to the focused world. |
message <text> |
Send a message to the focused world. |
shutdown |
Gracefully shut down the entire headless server. |
2. Access Levels
Control who can join your world sessions with the accessLevel setting:
| Level | Description |
|---|---|
| Anyone | Open to all Resonite users. |
| RegisteredUsers | Only registered Resonite accounts. |
| Contacts | Only users on the headless account's contact list. |
| ContactsPlus | Contacts and contacts of contacts. |
| Private | Invite-only. |
3. User Roles
Assign roles to control what users can do in your world:
| Role | Description |
|---|---|
| Admin | Full control over the world. |
| Builder | Can build and modify objects. |
| Moderator | Can kick/ban users and moderate chat. |
| Guest | Standard user access. |
| Spectator | Can observe but not interact. |
Set default roles in Config.json using defaultUserRoles or assign them per-user with the role console command.
4. Multiple Worlds
The headless server can host multiple worlds simultaneously. Add additional entries to the startWorlds array in Headless/Config/Config.json:
"startWorlds": [
{
"isEnabled": true,
"sessionName": "World 1",
"maxUsers": 16,
"accessLevel": "Anyone",
"loadWorldPresetName": "SpaceWorld"
},
{
"isEnabled": true,
"sessionName": "World 2",
"maxUsers": 8,
"accessLevel": "Contacts",
"loadWorldPresetName": "Grid"
}
]Use focus 0 and focus 1 in the console to switch between worlds.
5. Mod Loader
Resonite supports mods through ResoniteModLoader. To enable:
- Set
ENABLE_MODLOADERtotruein the Startup tab. - Reinstall or restart the server -- the mod loader DLLs will be downloaded automatically.
- Place mod DLLs in the
rml_mods/directory via SFTP. - Restart the server to load the mods.
Mod loader files:
Libraries/ResoniteModLoader.dll-- The main mod loader.rml_libs/0Harmony.dll-- Required dependency.rml_mods/-- Place your mod DLLs here.
6. Troubleshooting
- Server not starting: Verify the login credentials in
Config.jsonare correct. The headless must authenticate with a valid Resonite account. - World not appearing in browser: Check
hideFromPublicListingis not set totrue. EnsureaccessLevelallows the users searching. - "World running..." not appearing: Check for errors in the console. The world preset name may be incorrect.
- Mods not loading: Verify
ENABLE_MODLOADERistrueand mod DLLs are inrml_mods/. Check the console for mod loader errors. - High resource usage: Reduce
tickRateinConfig.jsonor lowermaxConcurrentAssetTransfers. Complex user-created content can be resource-intensive.
Related Articles
- Resonite Headless Server Setup Guide
- How to Find Your Server IP and Port
- How to Upload Files via SFTP
Need Help?
If you need further assistance, open a support ticket with your server details and any error messages from the GPanel console.
