tsubot

tsubot

tsubot is a discord bot with user role automation and osu! score integration.

Installation and Usage

Running locally

You will need to install Go and create the config.yaml file

$ go build cmd/main.go
$ ./main -c=/path/to/config.yaml

Using Docker

You can also build and run the bot using the provided Dockerfile

$ docker build -t myCoolBot:1.0 .
$ docker run myCoolBot:1.0

Example Configuration File

apiKeys:
  discord: discord_api_key
  osu:
    clientID: osu_client_id
    clientSecret: osu_client_secret

guildID: server_guild_id

# roles you want users in the server to be able to add and remove to themselves
allowedRoles:
  - Pro-Players
  - Regulars
  - Streamers
  - Mappers
  - Developers
  - Youtubers
  - Osu-Players

# list of commands that users on the server can issue the bot
commands:
  - welcome
  - verify
  - ping
  - help
  - choose
  - roles
  - remove
  - rank
  - info

Commands

Role automation

• Available roles can be found with !roles
• Roles can be chosen with !choose role
• Roles can be removed with !remove role
• Pro-Player role can be added with !verfy osu-profile-url

osu!

• A user's basic info can be queried with !info username
• A user's top score info can be queried with !info -t username
• A user's most recent score info can be queried with !info -r username
• A user's most recent 1st place score can be queried with !info -f username

Usage Examples

!roles

!info -t Cookiezi

!info Woey