dependencies {// Required for all platforms implementation 'io.github.revxrsal:lamp.common:[VERSION]'// JDA module implementation 'io.github.revxrsal:lamp.jda:[VERSION]'}
dependencies {// Required for all platformsimplementation("io.github.revxrsal:lamp.common:[VERSION]")// JDA moduleimplementation("io.github.revxrsal:lamp.jda:[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:
compileJava { // Preserve parameter names in the bytecode options.compilerArgs += ["-parameters"]}// optional: if you're using KotlincompileKotlin { kotlinOptions.javaParameters =true}
tasks.withType<JavaCompile> {// Preserve parameter names in the bytecode options.compilerArgs.add("-parameters")}// optional: if you're using Kotlintasks.withType<KotlinJvmCompile> {compilerOptions { javaParameters =true }}
JDA-specific annotations
@Choices
Defines up to 25 predefined choices for the parameter. The user can only provide one of the choices and cannot specify any other value.
@CommandPermission
Annotation for specifying the required Permissions for JDA slash commands
@GuildOnly
Marks a command as executable in guilds only.
@NSFW
Marks a command as NSFW
Supported JDA types
SlashCommandInteractionEvent and its subclasses in place of CommandActor
User and its subclasses in place of CommandActor
Member and its subclasses in place of CommandActor
MessageChannel and its subclasses in place of CommandActor
Role
User
Member
TextChannel
VoiceChannel
StageChannel
NewsChannel
ThreadChannel
ScheduledEvent
Category
Emoji
Example
publicstaticvoidmain(String[] args) {JDA jda =JDABuilder.createDefault(args[0]).build();var lamp =JDALamp.builder().build();// register all our commands herelamp.register(newModerationCommands());lamp.register(newLevelCommands());lamp.register(newRoleCommands());lamp.register(newSupportCommands());// after we register all commands, we *must* call this to// send our commands as slash commands//// slashCommands is JDAVisitors#slashCommands. We// use static imports for brevity.lamp.accept(slashCommands(jda));}
funmain(args: Array<String>) {val jda = JDABuilder.createDefault(args[0]).build()val lamp = JDALamp.builder().build()// Register all our commands here lamp.register(ModerationCommands()) lamp.register(LevelCommands()) lamp.register(RoleCommands()) lamp.register(SupportCommands())// After we register all commands, we *must* call this to// send our commands as slash commands//// slashCommands is JDAVisitors#slashCommands. We// use static imports for brevity. lamp.accept(slashCommands(jda))}
Example: /ban command
@Command("ban")@Description("Bans the given user")@CommandPermission(Permission.BAN_MEMBERS)publicvoidban(SlashCommandActor actor,Member target, @Range(min =1) long days) {actor.replyToInteraction("User **"+target.getEffectiveName() +"** has been banned!").queue();}
@Command("ban")@Description("Bans the given user")@CommandPermission(Permission.BAN_MEMBERS)funban( actor: SlashCommandActor, target: Member,@Range(min =1) days: Long) { actor.replyToInteraction("User **${target.effectiveName}** has been banned!").queue()}