Editor Commands

Commands for using the HyperPerms web editor to visually manage permissions.

Command Summary

Permissions

Opening the Web Editor

/hp editor

Generate a link to open the web editor with your server's permission data.

Usage: /hp editor

Output:
[HyperPerms] Web editor session created!
[HyperPerms] Click to open: https://hyperperms.dev/editor/abc123xyz
[HyperPerms] Session expires in 24 hours.
[HyperPerms] Use /hp apply <code> to apply changes.

How It Works

1. Your current permission data is uploaded to a secure session
2. A unique URL is generated for this session
3. Click the link to open the web editor in your browser
4. Make changes visually in the editor
5. When ready, copy the apply code from the editor
6. Run the apply command in-game

Applying Changes

/hp apply

Apply changes made in the web editor to your server.

Usage: /hp apply <code>

Arguments:
  <code>  - The apply code from the web editor

Example:
/hp apply abc123xyz789

Output:
[HyperPerms] Applying changes from web editor...
[HyperPerms] Changes applied successfully:
[HyperPerms]   - 2 groups modified
[HyperPerms]   - 1 group created
[HyperPerms]   - 5 permissions added
[HyperPerms]   - 1 permission removed

Getting the Apply Code

In the web editor:

1. Make your changes (add groups, modify permissions, etc.)
2. Click the "Apply Changes" or "Save" button
3. The editor shows you a command like /hp apply abc123xyz789
4. Copy this command
5. Paste and run it in-game or in server console

The Web Editor Workflow

Step 1: Open a Session

# In-game or console
/hp editor

# Click the generated link or copy it to your browser

Step 2: Make Changes

In the web editor, you can:

• Create, modify, and delete groups
• Add and remove permissions
• Set up group inheritance
• Manage user permissions and groups
• Create and manage tracks
• Preview changes before applying

Step 3: Review Changes

The editor shows a diff view of all changes before applying:

Changes to be applied:
+ Created group: senior-mod
~ Modified group: mod
  + Added permission: mod.timeout
  - Removed permission: mod.legacy
~ Modified group: admin
  ~ Changed weight: 80 → 90

Step 4: Apply Changes

# Copy the command from the editor
/hp apply abc123xyz789

# Changes are applied immediately

Session Management

Session Expiration

Editor sessions expire after 24 hours by default. After expiration:

• The session URL no longer works
• Any unsaved changes are lost
• You need to create a new session with /hp editor

Session Security

• Sessions use unique, random identifiers
• Data is encrypted in transit (HTTPS)
• Sessions are automatically deleted after expiration
• Only you (and anyone you share the URL with) can access the session

Configuration

The web editor can be configured in config.json:

{
  "webEditor": {
    "enabled": true,
    "url": "https://hyperperms.dev/editor",
    "sessionTimeout": 86400
  }
}

• enabled - Enable or disable the web editor
• url - The web editor URL (change for self-hosting)
• sessionTimeout - Session duration in seconds (default: 24 hours)

Error Handling

Session Not Found

/hp apply invalid-code

[HyperPerms] Error: Session not found or expired.
[HyperPerms] Create a new session with /hp editor

Session Expired

/hp apply old-session-code

[HyperPerms] Error: This session has expired.
[HyperPerms] Create a new session with /hp editor

Conflict with Server Data

If the server data has changed since you opened the editor, the apply command will warn you:

/hp apply abc123xyz

[HyperPerms] Warning: Server data has changed since session was created.
[HyperPerms] Some changes may conflict. Review carefully:
[HyperPerms]   - Group 'mod' was modified on server
[HyperPerms] Apply anyway? Use /hp apply abc123xyz --force

Tips for Using the Editor

Best Practices

• Create a backup before making major changes
• Review the diff before applying
• Apply changes during low-traffic times
• Test permissions after applying

When to Use the Editor vs Commands

Use the editor for:

• Setting up a new server
• Major restructuring of groups
• Bulk permission changes
• Visual review of your permission structure

Use commands for:

• Quick, single permission changes
• Promoting/demoting players
• Temporary permission grants
• Scripted or automated changes

Self-Hosting

You can host your own instance of the web editor. See the self-hosting guide for instructions.

See Also

• Web Editor Overview
• Using the Editor
• Self-Hosting Guide
• Configuration