Using the Web Editor

A complete walkthrough of the HyperPerms web editor interface, from opening a session to applying your changes.

Opening a Session

Step 1: Generate the Editor Link

Run the editor command in-game or from your server console:

/hp editor

You'll receive a response like:

[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.

Step 2: Open the Editor

Click the link directly (if your chat supports clickable links) or copy and paste the URL into your browser.

Editor Interface

Navigation Tabs

The editor has three main tabs at the top:

• Groups - Manage permission groups
• Users - Manage individual player permissions
• Tracks - Manage promotion/demotion tracks

Sidebar

The left sidebar shows a list of items for the current tab. Click an item to select it and view/edit its details.

Detail Panel

The main area shows details for the selected item. This is where you make changes to permissions, properties, and relationships.

Changes Summary

As you make changes, they're tracked and shown in the changes panel. This helps you keep track of what will be modified when you apply.

Managing Groups

Creating a Group

1. Click the Groups tab
2. Click the + Create Group button
3. Enter the group name (lowercase, no spaces)
4. Optionally enter a display name
5. Click Create

Editing Group Properties

1. Select the group from the sidebar
2. Edit the properties in the detail panel:
   • Display Name - Human-readable name
   • Weight - Priority (higher = more important)
   • Prefix - Chat prefix (supports color codes)
   • Suffix - Chat suffix (supports color codes)
3. Changes are saved automatically to the session

Adding Permissions

1. Select the group
2. Scroll to the Permissions section
3. Click + Add Permission
4. Enter the permission node
5. Select the value (true/false)
6. Optionally add context restrictions
7. Click Add

Removing Permissions

1. Find the permission in the list
2. Click the X or trash icon next to it
3. Confirm the removal if prompted

Managing Inheritance

1. Select the group
2. Find the Parents section
3. Click + Add Parent to add inheritance
4. Select the parent group from the dropdown
5. Click the X next to a parent to remove it

Deleting a Group

1. Select the group
2. Click the Delete button (usually at the bottom)
3. Confirm the deletion

Managing Users

Finding a User

1. Click the Users tab
2. Use the search box to find the player by name
3. Click on the user to select them

Editing User Groups

1. Select the user
2. In the Groups section:
   • Click + Add Group to add a group membership
   • Click the star icon to set a group as primary
   • Click X to remove from a group

Adding User Permissions

1. Select the user
2. In the Permissions section, click + Add Permission
3. Enter the permission node and value
4. Click Add

Managing Tracks

Creating a Track

1. Click the Tracks tab
2. Click + Create Track
3. Enter the track name
4. Click Create

Adding Groups to a Track

1. Select the track
2. Click + Add Group
3. Select the group to add
4. The group is added to the end (top) of the track

Reordering Groups

1. Select the track
2. Drag and drop groups to reorder them
3. Or use the up/down arrows to move groups

Viewing Changes

Changes Panel

The changes panel shows all modifications you've made during this session:

• + Added - New items or permissions
• ~ Modified - Changed items
• - Removed - Deleted items or permissions

Diff View

Click on a change to see a detailed diff showing exactly what changed:

Group: admin
  Weight: 80 → 90
  + Added permission: admin.broadcast
  - Removed permission: admin.legacy

Reverting Changes

You can revert individual changes by clicking the undo button next to them, or revert all changes using the "Reset All" button.

Applying Changes

Step 1: Review

Before applying, review all changes in the changes panel. Make sure everything looks correct.

Step 2: Get the Apply Command

Click the Apply Changes button. The editor will show you a command to run:

/hp apply abc123xyz789

Step 3: Run the Command

Copy the command and run it in-game or in your server console:

/hp apply abc123xyz789

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

Step 4: Verify

After applying, verify your changes work as expected:

/hp group info admin
/hp user info Steve
/hp verbose

Tips and Best Practices

Before Editing

• Create a backup: /hp backup create before-editor
• Plan your changes before starting
• Edit during low-traffic times

While Editing

• Save your work regularly by applying incremental changes
• Use the preview to verify changes before applying
• Don't share your session URL

After Editing

• Test permissions in-game
• Use /hp verbose to debug any issues
• Create a backup of the new configuration

Troubleshooting

Session Expired

If your session expires, create a new one with /hp editor. Any unsaved changes will be lost.

Changes Not Appearing

If changes made via commands don't appear in the editor, the editor only loads data when the session is created. Create a new session to see recent changes.

Apply Command Fails

If the apply command fails:

• Check that the session hasn't expired
• Verify you have permission to use the command
• Check for conflicting changes made since opening the editor

See Also

• Web Editor Overview
• Self-Hosting Guide
• Editor Commands