Basic Examples

Commands

Here is a small introduction how to make a command called 'coinflip'.

import com.ryifestudios.twitch.annotations.commands.*; // Only ArgumentAno, BasisCommand and Command are needed
import com.ryifestudios.twitch.commands.CommandContext; // CommandContext is used to reply to a command or get information's like user
import com.ryifestudios.twitch.commands.models.Argument;

// This Annotation describe the command
@Command(name = "coinflip", description = "flip a coin :<|", aliases={"cf"})
public class CoinsflipCommand {

    // Just an instance of random, because we need a random number
    private final Random random;

    public CoinsflipCommand() {
        random = new Random();
    }

    // This annotation marks the basis method - this is executed, when no sub command is entered
    @BasisCommand(arguments = {
            @ArgumentAno(name = "bet", description = "bet if head or tail") // Argument of this base method
    })
    public void onCoinsflip(CommandContext ctx, Argument[] args) {
        int v = random.nextInt(10);

        // Say if the value is head (over 5)
        boolean head = v > 5;

        // Get the first argument's value and check if it's head and the bool head is true then ...
        if(args[0].getValue().equals("head") && head){
            ctx.reply("You have won");
            return;
        }

        ctx.reply("You haven't won");
    }

}

Subcommands

Here is a small introduction to make a command with a sub command¹. In this case we have two sub commands, called tel & shutdown. Both Sub Commands have the Annotation @SubCommand to declare the method that should be executed.

¹: Sub Commands are basically under commands of a main command.

import com.ryifestudios.twitch.annotations.commands.*; // Only SubCommand, BasisCommand and Command are needed
import com.ryifestudios.twitch.commands.CommandContext; // CommandContext is used to reply to a command or get information's like user

// This Annotation describe the command
@Command(name = "abc", description = "THIS IS THE AWESOME ABC COMMAND")
public class ABCCommand  {

    // This annotation marks the basis method - this is executed, when no valid sub command is entered
    @BasisCommand()
    public void call(CommandContext ctx){
        ctx.send("abc command called");
    }

    // This is a SubCommand, parameter name is required
    @SubCommand(name = "tel")
    public void tel(CommandContext ctx){
        System.out.println("tel");
        ctx.send(STR."@\{ctx.getUser().getDisplayName()} has entered this subcommand.");
    }

    // This is also a sub Command
    @SubCommand(name="shutdown")
    public void shutdown(CommandContext ctx){
        ctx.reply("Bot will now shutdown! Bye bye");
        System.exit(1000);
    }

}

Events

Executing an event is easy like 1 + 1, the only thing that is needed is the Annotation @Event and the Event as a method parameter like so:

import com.ryifestudios.twitch.annotations.event.Event; // Required Event Annotation 

// Importing the Events u want
import com.ryifestudios.twitch.events.impl.commands.CommandErrorEvent;
import com.ryifestudios.twitch.events.impl.commands.CommandExecutedEvent;
import com.ryifestudios.twitch.events.impl.commands.CommandNotFoundEvent;

public class Test {

    /**
     * This Event is triggered when a Command failed while executing
     * @param error
     */
    @Event
    public void onCommandError(CommandErrorEvent error){
        error.ctx().reply("error concurred");
    }

    /**
     * The event is triggered if a command is not found
     * @param c
     */
    @Event
    public void onCommandNotFound(CommandNotFoundEvent c){
        c.ctx().reply(STR."Command \{c.getCommandName()} not found");
    }

    /**
     * This Event is triggered when a command is successfully executed
     * @param c
     */
    @Event
    public void executed(CommandExecutedEvent c){
        System.out.println(STR."\{c.getCommand()} executed");
    }
    
}

Last modified: 25 June 2024