Skip to content

Latest commit

 

History

History
74 lines (55 loc) · 3.21 KB

README.md

File metadata and controls

74 lines (55 loc) · 3.21 KB
Raw

Spring Boot Twitch Bot

Twitch all-purpose bot, made using Spring Boot, WebFlux, JPA, Hibernate, REST, HikariCP and Project Reactor.

TravisCI
travis-icon

Requirements for connection

Find the file app.properties in the resources folder and change following variables:

  • prefix: The prefix for all command
  • oauthToken: OAuth Token of the bot with at least the scopes chat:read and chat:edit, https://twitchtokengenerator.com/
  • nickname: Twitch username of the bot account
  • channel: The name of the channel in which the bot should join

Adding a Command

Every bot command should be a part of the com.motyldrogi.bot.command package and implement the CommandExecutor class, implementing the execute() method at bare-minimum. The execute() method expectes two arguments:

  • tMessage (TwitchMessage): The TwitchMessage object which contains the full information about the message
  • commandSender (CommandSender): The class for sending messages and also for localization

The execute() method needs a CommandInfo() annotation to work, the CommandInfo() annotation can have the following arguments:

  • value: The value that triggers the command, i.e. after the prefix
  • minArguments: Minimum arguments count for the command, defaults to 0
  • maxArguments: Maximum arguments count for the command, defaults to 0
  • usage: Text that gets displayed if the command was not used correctly

For example, the following command echos back the message received, tagging the person that sent it:

package com.motyldrogi.bot.command;

import com.motyldrogi.bot.command.defaults.CommandExecutor;
import com.motyldrogi.bot.command.defaults.CommandInfo;
import com.motyldrogi.bot.command.defaults.CommandSender;
import com.motyldrogi.bot.component.TwitchMessage;

public class EchoCommand implements CommandExecutor {

    @CommandInfo(value = "echo", minArguments = 1, maxArguments = 1, usage = "<message>")
    @Override
    public void execute(TwitchMessage tMessage, CommandSender commandSender) {

        commandSender.sendRawMessage("@" + tMessage.getSentBy() + " " + tMessage.getData());
    }
}

If you created a command, you have to register it:

this.commandRegistry.registerByExecutors(
    [...],
    new EchoCommand()
);

Features

  • Easy to add commands
  • Database Storage
  • Twitch API Access
  • Public rest api without oauth

Endpoints

Method Optional query parameters Success status codes Error status codes
GET /api/counters page, size 200
GET /api/counters/by-name/{name} 200 404