First Setup

This guide walks you through setting up your first groups, creating a rank hierarchy, and assigning permissions to players.

Understanding the Default State

After installation, HyperPerms creates a single group called default. All new players are automatically assigned to this group. Let's build on this foundation.

You can use either in-game commands or the web editorto manage permissions. This guide uses commands, but the web editor is often easier for complex setups.

Planning Your Rank Structure

Before creating groups, plan your rank hierarchy. A typical server might have:

text
Owner (weight: 100)
  ↑
Admin (weight: 90)
  ↑
Moderator (weight: 50)
  ↑
VIP (weight: 20)
  ↑
Default (weight: 0)

Higher weight means higher priority. When a player has multiple groups, the highest-weight group determines their prefix/suffix display.

Step 1: Create Your Groups

Let's create a basic rank hierarchy:

CommandDescription
/hp group create vipCreate VIP rank
/hp group create modCreate Moderator rank
/hp group create adminCreate Admin rank
/hp group create ownerCreate Owner rank

Step 2: Set Group Weights

Assign weights to establish priority (higher = more important):

CommandDescription
/hp group setweight default 0Default at base level
/hp group setweight vip 20VIP above default
/hp group setweight mod 50Moderator above VIP
/hp group setweight admin 90Admin near top
/hp group setweight owner 100Owner at top

Step 3: Set Up Inheritance

Make each rank inherit from the one below. This way, admins automatically get all moderator permissions, moderators get all VIP permissions, and so on.

CommandDescription
/hp group addparent vip defaultVIP inherits from default
/hp group addparent mod vipMod inherits from VIP
/hp group addparent admin modAdmin inherits from Mod
/hp group addparent owner adminOwner inherits from Admin
With inheritance, you only need to add new permissions at the appropriate level. Higher ranks automatically receive permissions from lower ranks.

Step 4: Configure Display Names and Prefixes

Make your ranks visually distinct in chat:

CommandDescription
/hp group setdisplayname default DefaultSet display name
/hp group setprefix default "&7"Gray prefix for default
/hp group setdisplayname vip VIPSet VIP display name
/hp group setprefix vip "&a[VIP] "Green VIP prefix
/hp group setdisplayname mod ModeratorSet Mod display name
/hp group setprefix mod "&9[Mod] "Blue Mod prefix
/hp group setdisplayname admin AdminSet Admin display name
/hp group setprefix admin "&c[Admin] "Red Admin prefix
/hp group setdisplayname owner OwnerSet Owner display name
/hp group setprefix owner "&4[Owner] "Dark red Owner prefix
Color codes use the & symbol. See the color codes referencefor all available colors including hex colors like &#FF5555.

Step 5: Add Basic Permissions

Default Group Permissions

Basic permissions for all players:

CommandDescription
/hp group addpermission default chat.use trueAllow chatting
/hp group addpermission default teleport.spawn trueAllow /spawn
/hp group addpermission default home.use trueAllow /home

VIP Group Permissions

Extra perks for VIP players:

CommandDescription
/hp group addpermission vip chat.color trueColored chat messages
/hp group addpermission vip home.multiple trueMultiple homes
/hp group addpermission vip teleport.delay.bypass trueNo teleport delay

Moderator Group Permissions

Moderation tools:

CommandDescription
/hp group addpermission mod mod.kick trueKick players
/hp group addpermission mod mod.mute trueMute players
/hp group addpermission mod mod.warn trueWarn players
/hp group addpermission mod teleport.player trueTeleport to players

Admin Group Permissions

Server administration:

CommandDescription
/hp group addpermission admin mod.ban trueBan players
/hp group addpermission admin admin.gamemode trueChange gamemode
/hp group addpermission admin admin.fly trueToggle flight
/hp group addpermission admin hyperperms.user trueManage user permissions

Owner Group Permissions

Full server control:

CommandDescription
/hp group addpermission owner * trueAll permissions (wildcard)
The * wildcard grants ALL permissions. Only give this to fully trusted players.

Step 6: Assign Players to Groups

Now add players to their appropriate ranks:

CommandDescription
/hp user addgroup Steve vipAdd Steve to VIP
/hp user setprimarygroup Steve vipSet VIP as primary group
The primary group determines the player's display prefix. A player can belong to multiple groups and inherit permissions from all of them.

Step 7: Test Your Setup

Verify permissions are working correctly:

CommandDescription
/hp user info SteveView Steve's permissions
/hp verboseEnable verbose mode to see permission checks

With verbose mode enabled, you'll see every permission check in chat, making it easy to debug issues.

Example: Complete Setup Script

Here's all the commands in order for a fresh server:

text
# Create groups
/hp group create vip
/hp group create mod
/hp group create admin
/hp group create owner

# Set weights
/hp group setweight default 0
/hp group setweight vip 20
/hp group setweight mod 50
/hp group setweight admin 90
/hp group setweight owner 100

# Set up inheritance
/hp group addparent vip default
/hp group addparent mod vip
/hp group addparent admin mod
/hp group addparent owner admin

# Set prefixes
/hp group setprefix default "&7"
/hp group setprefix vip "&a[VIP] "
/hp group setprefix mod "&9[Mod] "
/hp group setprefix admin "&c[Admin] "
/hp group setprefix owner "&4[Owner] "

# Default permissions
/hp group addpermission default chat.use true
/hp group addpermission default teleport.spawn true

# VIP permissions
/hp group addpermission vip chat.color true
/hp group addpermission vip home.multiple true

# Mod permissions
/hp group addpermission mod mod.kick true
/hp group addpermission mod mod.mute true

# Admin permissions
/hp group addpermission admin mod.ban true
/hp group addpermission admin hyperperms.user true

# Owner permissions
/hp group addpermission owner * true

Common Setup Patterns

Donor Ranks Separate from Staff

Keep donation ranks and staff ranks in separate inheritance chains so donors don't automatically get staff permissions:

text
# Staff track
default → helper → mod → admin → owner

# Donor track
default → vip → vip+ → mvp

# Player can have both: mod + vip+
# They get permissions from both chains

World-Specific Permissions

Use contexts for permissions that only apply in certain worlds:

text
# Allow building only in creative world
/hp group addpermission default build.place true world=creative
/hp group addpermission default build.break true world=creative

# Deny building in spawn
/hp group addpermission default build.place false world=spawn

Next Steps