Installation

Get HyperPerms up and running on your Hytale server in just a few minutes.

Prerequisites

Before installing HyperPerms, ensure your server meets the following requirements:

  • Java 21 or higher - HyperPerms is built for modern Java
  • Hytale Dedicated Server - Latest version recommended
  • 512MB+ available RAM - For optimal performance
  • Read/write access - To the plugins folder
Not sure which Java version you have? Run java -version in your terminal to check.

Download

Download the latest version of HyperPerms from our official sources:

Always download HyperPerms from official sources. Third-party downloads may contain malware or outdated versions.

Installation Steps

Step 1: Download the Plugin

Download the HyperPerms-X.X.X.jar file from the releases page. Choose the latest stable version unless you have a specific reason to use an older release.

Step 2: Stop Your Server

For a clean installation, stop your server before adding the plugin. While hot-loading is possible, a restart ensures all components initialize correctly.

Step 3: Install the Plugin

Place the downloaded JAR file in your server's plugins folder:

text
your-server/
├── plugins/
│   └── HyperPerms-1.0.0.jar  ← Place the JAR file here
├── config/
├── worlds/
└── HytaleServer.jar

Step 4: Start Your Server

Start your Hytale server. HyperPerms will automatically generate its configuration files and create the default group structure.

text
java -Xmx2G -jar HytaleServer.jar

Step 5: Verify Installation

Once the server has started, verify HyperPerms is working by running:

text
/hp info

You should see output similar to:

text
[HyperPerms] HyperPerms v1.0.0
[HyperPerms] Storage: JSON
[HyperPerms] Groups loaded: 1
[HyperPerms] Users loaded: 0
[HyperPerms] Tracks loaded: 0
Check your server console during startup for any error messages. A successful installation will show:[HyperPerms] Successfully loaded HyperPerms vX.X.X

First Run Output

On first run, HyperPerms will:

  1. Create the plugins/HyperPerms/ directory
  2. Generate the default configuration file
  3. Create a default group with basic settings
  4. Initialize the storage backend
  5. Register all commands and permissions

Generated Files

After first startup, HyperPerms creates the following directory structure:

text
plugins/
└── HyperPerms/
    ├── config.json           # Main configuration file
    ├── default-groups.json   # Default group hierarchy template
    ├── data/                  # Data storage (JSON backend)
    │   ├── groups/           # Group definitions
    │   │   ├── default.json
    │   │   ├── member.json
    │   │   ├── builder.json
    │   │   ├── moderator.json
    │   │   ├── admin.json
    │   │   └── owner.json
    │   ├── users/            # User data (by UUID)
    │   │   └── <uuid>.json
    │   └── tracks/           # Promotion track definitions
    │       └── staff.json
    └── backups/              # Automatic backup storage
By default, HyperPerms creates a sample group hierarchy (default → member → builder → moderator → admin → owner) to help you get started. You can customize these groups or delete them and create your own structure.

Troubleshooting Installation

Plugin won't load

  • Verify you're using Java 21 or higher
  • Check for error messages in the server console
  • Ensure the JAR file isn't corrupted (re-download if needed)
  • Check file permissions on the plugins folder

Commands not recognized

  • Confirm the plugin loaded successfully with /plugins
  • Check that you have the required permissions
  • Try using the full command: /hyperperms instead of /hp

Next Steps

Now that HyperPerms is installed, continue with:

Having trouble with installation or found a bug?

Send us feedback →