Omnisight docs

Permissions

Home

Permissions

Permission modes, nodes, and legacy migration behavior.

Permissions

OmniSight uses a flexible permission system controlled by the permissionMode field in config.json.

Permission Modes

ModeBehavior
"none"No restrictions. All players can use all commands. (default)
"op"Only server operators (OP group) can use OmniSight commands
"custom"Uses Hytale's PermissionsModule for per-node permission checks

Permission Nodes

NodeRequired ForDescription
omnisight.use/omni on, /omni offBasic HUD toggle access
omnisight.settings/omni settingsAccess to the settings GUI
omnisight.profiler/omni profilerAccess to the performance profiler

How Each Mode Works

"none" (default)

All players have unrestricted access to all OmniSight commands. No permission checks are performed.

{
  "permissionMode": "none"
}

"op"

Only players in the OP group (as defined by Hytale's PermissionsModule) can use OmniSight. All permission nodes are effectively gated behind OP status.

{
  "permissionMode": "op"
}

"custom"

Each command checks its specific permission node against Hytale's PermissionsModule. This allows granular control, for example: all players can toggle HUD (omnisight.use) but only admins can access profiler (omnisight.profiler).

{
  "permissionMode": "custom"
}

To assign permissions in custom mode, use Hytale's built-in permission system to grant nodes to players or groups.

Permission Check Flow

  1. Player runs /omni <subcommand>
  2. omnisight.use is checked first (required for all subcommands)
  3. If subcommand has its own node (example: omnisight.settings), that node is checked additionally
  4. If any check fails, player sees: [Omnisight] No permission.

Migration from requiresOp

If config.json still contains legacy requiresOp:

  • requiresOp: true is automatically converted to permissionMode: "op"
  • requiresOp: false is ignored (current permissionMode is kept)
  • requiresOp is removed from the file on next save

No manual action is needed. Migration happens automatically on server start.