This guide covers headless console commands, world management, user roles, the NeosModLoader, and troubleshooting for your NeosVR dedicated server. NeosVR is a social VR metaverse with powerful creation tools. For initial setup, Config.json configuration, and connection instructions, see NeosVR Server Setup Guide.
1. Accessing the Console
Manage your NeosVR headless server through the Console tab in GPanel. All commands are typed directly into the console.
2. Headless Console Commands
World Management
| Command | Description |
|---|---|
worlds | List all running worlds with their indices. |
focus <world_index> | Switch focus to a specific world by index. |
startWorldURL <record_url> | Start a new world from a Neos record URL. |
startWorldTemplate <template> | Start a world from a built-in template (e.g. SpaceWorld). |
save | Save the currently focused world. |
close | Close the currently focused world. |
restart | Restart the currently focused world. |
Session Management
| Command | Description |
|---|---|
sessionURL | Show the session URL for the focused world. |
sessionID | Show the session ID for the focused world. |
name <new_name> | Change the session name of the focused world. |
accessLevel <level> | Change access level: Anyone, RegisteredUsers, ContactsPlus, Contacts, Private. |
maxUsers <count> | Set the maximum number of users for the session. |
hideFromListing <true/false> | Toggle visibility in the public session browser. |
description <text> | Set the session description. |
User Management
| Command | Description |
|---|---|
users | List all users in the focused world. |
kick <username> | Kick a user from the world. |
ban <username> | Ban a user from the world. |
silence <username> | Silence a user (mute their voice). |
unsilence <username> | Unsilence a previously muted user. |
respawn <username> | Respawn a user at the world's spawn point. |
role <username> <role> | Assign a role to a user (see Section 3). |
Server Control
| Command | Description |
|---|---|
status | Show server status and resource usage. |
shutdown | Gracefully shut down the headless server. |
gc | Force garbage collection to free memory. |
tickRate <rate> | Change the server tick rate at runtime. |
3. User Roles
NeosVR uses a role hierarchy for world permissions:
| Role | Description |
|---|---|
Admin | Full world control. Can modify anything, manage users, and change world settings. |
Builder | Can create and edit objects in the world. |
Moderator | Can kick/ban users and manage session settings. |
Guest | Basic access. Can interact with existing objects but cannot build. |
Spectator | View-only access. Cannot interact with the world. |
Assign roles via the console: role <username> Admin
You can also set default roles in Config.json using the defaultUserRoles setting.
4. NeosModLoader
NeosModLoader allows loading community-made mods into the headless server.
- Set ENABLE_MODLOADER to
truein GPanel Startup variables. - Download mods from the NeosModLoader GitHub.
- Upload mod
.dllfiles to thenml_mods/directory via SFTP. - Restart the server to load the mods.
5. Troubleshooting
Server Not Starting
- Verify your STEAM_USER and STEAM_PASS are correct.
- Ensure the SRCDS_BETAPASS (headless beta password) is up to date from the Neos Patreon Discord.
- If using Steam Guard 2FA, provide the code in STEAM_AUTH and restart promptly.
World Not Loading
- Check that
Config.jsonis valid JSON (no trailing commas, proper brackets). - Verify the
loginCredentialandloginPasswordare set correctly inConfig/Config.json. - Ensure the world URL or preset name is valid.
Users Cannot Join
- Check the
accessLevelis not set toPrivateunless intended. - Verify
maxUsershas not been reached. - Ensure the headless is logged in (check console output for login confirmation).
Related Articles
Need Help?
If you run into issues with your NeosVR server that are not covered here, open a support ticket and include your server IP, a description of the problem, and any relevant error messages from the GPanel console.