Sponge
This page describes how to integrate Lamp with Sponge 8+, as well as what to expect out of it.
Setting up
Adding Lamp dependency
To add Lamp to your project, add the following (depending on your project structure):
<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.sponge</artifactId>
<version>[VERSION]</version>
</dependency>
</dependencies>dependencies {
// Required for all platforms
implementation 'io.github.revxrsal:lamp.common:[VERSION]'
// Sponge module
implementation 'io.github.revxrsal:lamp.sponge:[VERSION]'
}dependencies {
// Required for all platforms
implementation("io.github.revxrsal:lamp.common:[VERSION]")
// Velocity module
implementation("io.github.revxrsal:lamp.sponge:[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:
<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>compileJava {
// Preserve parameter names in the bytecode
options.compilerArgs += ["-parameters"]
}
// optional: if you're using Kotlin
compileKotlin {
kotlinOptions.javaParameters = true
}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
}
}Sponge-specific annotations
@CommandPermission
@CommandPermissionAdds a command permission for the given command
Supported Sponge types
org.spongepowered.api.command.CommandCauseand its subclasses in place of CommandActornet.kyori.adventure.audience.Audienceand its subclasses in place of CommandActororg.spongepowered.api.service.permission.Subjectand its subclasses in place of CommandActororg.spongepowered.api.world.server.ServerWorldorg.spongepowered.api.entity.living.player.server.ServerPlayerorg.spongepowered.api.command.selector.Selector
Example
@Plugin(id = "myplugin", name = "MyPlugin", version = "1.0")
public class MyPlugin {
@Listener
private void onConstructPlugin(ConstructPluginEvent event) {
Lamp<SpongeCommandActor> lamp = SpongeLamp.builder(this).build();
lamp.register(new MyCommand());
}
public class MyCommand {
@Command("hello")
@CommandPermission("myplugin.hello")
public void hello(SpongeCommandActor actor) {
// Command logic here
}
}
}@Plugin(id = "myplugin", name = "MyPlugin", version = "1.0")
class MyPlugin {
@Listener
private fun onConstructPlugin(event: ConstructPluginEvent) {
val lamp: Lamp<SpongeCommandActor> = SpongeLamp.builder(this).build()
lamp.register(MyCommand())
}
class MyCommand {
@Command("hello")
@CommandPermission("myplugin.hello")
fun hello(actor: SpongeCommandActor) {
// Command logic here
}
}
}Last updated
Was this helpful?