๐Ÿ“˜ HyPerms

Advanced Permission Management for Hytale Servers

๐Ÿ”‘ Permissions

Permission Description
hyperms.all Full access to all HyPerms commands (No OP required)

โŒจ๏ธ Commands

๐Ÿ‘ค User Commands

Command Description
/hyp user info <player> View player's permissions
/hyp user add <player> <permission> Add permission to player
/hyp user remove <player> <permission> Remove permission from player
/hyp user addgroup <player> <group> Add player to group
/hyp user removegroup <player> <group> Remove player from group
Adding a player to a group automatically removes them from the default group.

๐Ÿ‘ฅ Group Commands

Command Description
/hyp group list List all groups
/hyp group info <group> View group details
/hyp group create <group> Create new group
/hyp group delete <group> Delete a group
/hyp group add <group> <perm> Add permission to group
/hyp group remove <group> <perm> Remove permission from group
/hyp group inherit <group> <parent> Add inheritance
/hyp group uninherit <group> <parent> Remove inheritance
/hyp group prefix <group> <text> Set group prefix
/hyp group suffix <group> <text> Set group suffix
/hyp group default View default group
/hyp group default set <group> Set default group

๐Ÿ”„ Utility Commands

Command Description
/hyp reload Reload config & reapply permissions

๐Ÿ’ฌ Chat Formatting

Command Description
/hyp chat View current format
/hyp chat format <text> Set chat format

Placeholders

%player%

Player's name

%message%

Chat message content

%prefix%

Player's group prefix

%suffix%

Player's group suffix

Color Codes

Code Effect
&l Bold
&o Italic
&#FF0000 Hex color
&a &c &f Legacy colors
Use | instead of spaces in commands

Example

&#FF0000[%prefix%]|%player%|&7ยป|&f%message%

๐ŸŒ HyPerms Pro PRO

How to Get a License

  1. Purchase Pro in our Discord server
  2. Receive your key automatically via DM
  3. Activate with /hyp license <key>
  4. Restart your server

Pro Features

๐Ÿ–ฅ๏ธ Web GUI

Browser-based admin panel at
http://your-ip:8080

๐Ÿ“ก Remote Management

Manage groups & users without in-game access

๐Ÿ”’ Licensed

One active server per license key

License Commands

Command Description
/hyp license <key> Activate Pro license

Troubleshooting

Issue Solution
License already in use Stop other server or wait 5 min for timeout
Invalid license key Check for typos, contact Discord support
Web GUI not loading Ensure web.enabled: true and valid license

๐Ÿ”ง Developer API

Getting Started

import com.hytech.hyperms.api.HyPermsAPI;
import com.hytech.hyperms.api.HyPermsProvider;

HyPermsAPI api = HyPermsProvider.get();
if (api != null) {
    boolean hasPerm = api.hasPermission(uuid, "myplugin.admin");
}

Permission Methods

hasPermission(UUID uuid, String permission) โ†’ boolean

Check if player has permission (including inherited)

getEffectivePermissions(UUID uuid) โ†’ Set<String>

Get all permissions (direct + inherited from groups)

addPermission(UUID uuid, String permission)

Add a permission directly to a player

removePermission(UUID uuid, String permission)

Remove a direct permission from a player

Group Methods

getGroups() โ†’ Set<String>

Get all available group names

isInGroup(UUID uuid, String group) โ†’ boolean

Check if player is in a specific group

addToGroup(UUID uuid, String group) โ†’ boolean

Add player to a group. Returns false if group doesn't exist.

setGroup(UUID uuid, String group) โ†’ boolean

Set player's primary group (removes from all others)

Prefix & Suffix

getPrefix(UUID uuid) โ†’ String

Get effective prefix (includes group inheritance)

getSuffix(UUID uuid) โ†’ String

Get effective suffix

Utility

reload()

Reload from disk and reapply to all online players

refreshPlayer(UUID uuid)

Reapply permissions to a specific player

Dependency

{
  "dependencies": ["HyTech:HyPerms"]
}