Skip to content
Kweebedia logo Kweebedia
Quick Start: Your First Plugin

Quick Start: Your First Plugin

Build a plugin that adds a /hello command that responds in chat.

What You’ll Build

Section titled “What You’ll Build”

A simple plugin that:

  • Registers a /hello command
  • Responds with a message when used

Time: ~10 minutes

Before You Start

Section titled “Before You Start”

Make sure you have:

Step 1: Create Project

Section titled “Step 1: Create Project”

Create a new Java project with this structure:

hello-plugin/
├── src/main/java/
│   └── com/example/hello/
│       └── HelloPlugin.java
└── pom.xml

Step 2: Configure Maven

Section titled “Step 2: Configure Maven”

Create pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
         http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>


    <groupId>com.example</groupId>
    <artifactId>hello-plugin</artifactId>
    <version>1.0.0</version>
    <packaging>jar</packaging>


    <properties>
        <maven.compiler.source>25</maven.compiler.source>
        <maven.compiler.target>25</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>


    <dependencies>
        <dependency>
            <groupId>com.hypixel.hytale</groupId>
            <artifactId>Server</artifactId>
            <scope>provided</scope>
        </dependency>
    </dependencies>
</project>

Step 3: Write the Plugin

Section titled “Step 3: Write the Plugin”

Create HelloPlugin.java:

package com.example.hello;


// Note: API details are still being documented
// Check community resources for current examples
// Server is not obfuscated - decompile to explore the API


public class HelloPlugin {
    // Plugin implementation
    // Register a /hello command that sends a message
}

Step 4: Build

Section titled “Step 4: Build”

Run Maven to compile your plugin:

Terminal window
mvn package

This creates target/hello-plugin-1.0.0.jar.

Step 5: Install

Section titled “Step 5: Install”
  1. Copy hello-plugin-1.0.0.jar to your server’s mods/ folder
  2. Restart the server

Step 6: Test

Section titled “Step 6: Test”

In-game, type /hello - you should see a response message.

Troubleshooting

Section titled “Troubleshooting”

Plugin not loading?

Section titled “Plugin not loading?”
  • Check server console for errors
  • Verify Java version matches (Java 25)
  • Ensure .jar is in mods/ not a subdirectory

Command not working?

Section titled “Command not working?”
  • Decompile the server to check command registration API
  • Look at example plugins on GitHub

Getting errors?

Section titled “Getting errors?”
  • Make sure you’re using --disable-sentry during development
  • Check the FAQ for common issues

Next Steps

Section titled “Next Steps”