🛖
Fox Hut
  • Introduction
    • Setting up
    • CommandActor, @Command and @Subcommand
    • Creating your first command
    • Improving our greet command
  • Platforms
    • Bukkit / Spigot / Paper
    • BungeeCord
    • Velocity
    • Sponge
    • Fabric
    • Brigadier
    • Minestom
    • JDA
    • Command line
  • How-to
    • Creating variants of /teleport
    • Custom parameter types
    • Suggestions and auto-completion
    • Context parameters
    • Command permissions
    • Parameter validators
    • Command conditions
    • Response handlers
    • Cooldowns
    • Help commands
    • Annotation replacers
    • Orphan command
    • Exception handling
    • Hooks
    • Dependency injection
    • Visitors
    • Customizing the dispatcher and failure behavior
Powered by GitBook
On this page
  • Setting up
  • Adding Lamp dependency
  • Bungee-specific annotations
  • @CommandPermission
  • Supported Bungee types
  • Example

Was this helpful?

Edit on GitHub
  1. Platforms

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>
dependencies {
   // Required for all platforms
   implementation 'io.github.revxrsal:lamp.common:[VERSION]'
   
   // Bungee module
   implementation 'io.github.revxrsal:lamp.bungee:[VERSION]'
}
dependencies {
    // Required for all platforms
    implementation("io.github.revxrsal:lamp.common:[VERSION]")
    
    // Bungee module
    implementation("io.github.revxrsal:lamp.bungee:[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
    }
}

Bungee-specific annotations

@CommandPermission

Adds a command permission for the given command

Supported Bungee types

  • net.md_5.bungee.api.CommandSender and its subclasses in place of CommandActor

  • net.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
        }
    }
}
import net.md_5.bungee.api.plugin.Plugin
import revxrsal.commands.BungeeLamp
import revxrsal.commands.Lamp
import revxrsal.commands.command.Command
import revxrsal.commands.command.CommandActor
import revxrsal.commands.command.CommandPermission

class MyPlugin : Plugin() {

    override fun onEnable() {
        val lamp: Lamp<BungeeCommandActor> = BungeeLamp.builder(this).build()
        lamp.register(MyCommand())
    }

    inner class MyCommand {

        @Command("hello")
        @CommandPermission("myplugin.hello")
        fun hello(actor: BungeeCommandActor) {
            // Command logic here
        }
    }
}
PreviousBukkit / Spigot / PaperNextVelocity

Last updated 4 months ago

Was this helpful?

Latest version: