Minestom

This page describes how to integrate Lamp with Minestom, as well as what to expect out of it.

Setting up

Prerequisites

• Java 21 or newer

Adding Lamp dependency

To add Lamp to your project, add the following (depending on your project structure):

pom.xml

<dependencies>
  <!-- Required for all platforms -->
  <dependency>
      <groupId>io.github.revxrsal</groupId>
      <artifactId>lamp.common</artifactId> 
      <version>[VERSION]</version>
  </dependency>

  <!-- Sponge module -->
  <dependency>
      <groupId>io.github.revxrsal</groupId>
      <artifactId>lamp.minestom</artifactId>
      <version>[VERSION]</version>
  </dependency>  
</dependencies>

build.gradle

dependencies {
   // Required for all platforms
   implementation 'io.github.revxrsal:lamp.common:[VERSION]'
   
   // Sponge module
   implementation 'io.github.revxrsal:lamp.minestom:[VERSION]'
}

build.gradle.kts

dependencies {
    // Required for all platforms
    implementation("io.github.revxrsal:lamp.common:[VERSION]")
    
    // Velocity module
    implementation("io.github.revxrsal:lamp.minestom:[VERSION]")
}

Latest version:

Optional: Preserve parameter names

Lamp identifies parameters by their names and uses them to generate relevant command metadata. By default, Java does not preserve parameter names reflectively. You need to add the following to your project:

pom.xml

<plugins>
  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.8.0</version>
    <configuration>
      <compilerArgs>
        <!-- Preserves parameter names -->
        <arg>-parameters</arg>
      </compilerArgs>
    </configuration>
  </plugin>
</plugins>

build.gradle

compileJava { 
    // Preserve parameter names in the bytecode
    options.compilerArgs += ["-parameters"]
}

// optional: if you're using Kotlin
compileKotlin {
    kotlinOptions.javaParameters = true
}

build.gradle.kts

tasks.withType<JavaCompile> {
    // Preserve parameter names in the bytecode
    options.compilerArgs.add("-parameters")
}

// optional: if you're using Kotlin
tasks.withType<KotlinJvmCompile> {
    compilerOptions {
        javaParameters = true
    }
}

Minestom-specific annotations

@CommandPermission

Adds a command permission for the given command

Supported Minestom types

• net.minestom.server.command.CommandSender and its subclasses in place of CommandActor

• Player

• Instance

• EntityFinder

• ItemStack

• Component

• BinaryTag

• CompoundBinaryTag

Example

Java

public class MinestomServerTest {

    public static void main(String[] args) {
        createServer();
        var lamp = MinestomLamp.builder()
                .build();
        lamp.register(new TestCommands());
    }

    private static void createServer() {
        MinecraftServer minecraftServer = MinecraftServer.init();
        /*...*/
        minecraftServer.start("0.0.0.0", 25565);
    }

    public static class TestCommands {

        @Command("nbt")
        public void sendNBT(MinestomCommandActor actor, BinaryTag nbt) {
            actor.reply("NBT: " + nbt);
        }
    }
}

Kotlin

fun main(args: Array<String>) {
    createServer()
    val lamp = MinestomLamp.builder().build()
    lamp.register(TestCommands())
}

private fun createServer() {
    val minecraftServer = MinecraftServer.init()
    /*...*/
    minecraftServer.start("0.0.0.0", 25565)
}

class TestCommands {

    @Command("nbt")
    fun sendNBT(actor: MinestomCommandActor, nbt: BinaryTag) {
        actor.reply("NBT: $nbt")
    }
}