BungeeCord
This page describes how to integrate Lamp with BungeeCord, 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>
<!-- BungeeCord module -->
<dependency>
<groupId>io.github.revxrsal</groupId>
<artifactId>lamp.bungee</artifactId>
<version>[VERSION]</version>
</dependency>
</dependencies>
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>
Bungee-specific annotations
@CommandPermission
@CommandPermission
Adds a command permission for the given command
Supported Bungee types
net.md_5.bungee.api.CommandSender
and its subclasses in place of CommandActornet.md_5.bungee.api.connection.ProxiedPlayer
Example
public class MyPlugin extends Plugin {
@Override
public void onEnable() {
Lamp<BungeeCommandActor> lamp = BungeeLamp.builder(this).build();
lamp.register(new MyCommand());
}
public class MyCommand {
@Command("hello")
@CommandPermission("myplugin.hello")
public void hello(BungeeCommandActor actor) {
// Command logic here
}
}
}
Last updated
Was this helpful?