hevav / tchubbak

Powerful Open-Source Module-Based Music/Moderation bot for Discord

TchuBBak

Powerful Open-Source Module-Based Music/Moderation bot for Discord. Current version: v2.0.0
Invite bot to your server
Rate on top.gg

Current modules

• Moderation - moderation features like (temp/perm) warn, mute, ban
• Help - shows help page
• Voice - allows multiplugin voice, voice recognition
• Music - plays music from YouTube, SoundCloud, Twitch and more
• Status - shows debug info

Languages

TchuBBak is multilingual bot, and you can help to add more languages(by modifying dev.hevav.tchubbot.i18n.strings). Now TchuBBak is translated to these languages:

• Russian
• English
• Brazilian
• Indian
• Japanese
• Chinese

Requirements

• Docker
• Google speech-to-text API file
• MongoDB server
• Discord token
• YouTube Data API token

Installation

To run TchuBBak in production, it is recommended to use Docker. Just pull TchuBBak image from Docker Hub and run it with command:

 $ docker run --env pf_bot_token={{Discord bot token}} --env pf_yt_token={{YouTube Data API token}} --env pf_bot_prefix={{Modules commands prefix}} hevavdev/pfbot:latest

You can also use jar file from releases:

 $ java -jar TchuBBak.jar bot_token={{Discord bot token}} yt_token={{YouTube Data API token}} bot_token={{Modules commands prefix}} 

Logging

Use pf_log_level env variable in docker or log_level= in jar. You can set TRACE, DEBUG, INFO, WARN, ERROR and FATAL log level. Default is INFO.

Writing modules/plugins

Basic module

• Make a class that extends dev.hevav.tchubbot.modules.Module
• Add module to dev.hevav.tchubbot.Config.modules
• Profit

Basic plugin

Plugins are not supported yet.

Localization

TchuBBak has a LocalizedString class, which translates Strings by guild's region. It supports Russian, English, Brazilian, Indian, Japanese and Chinese language.

Embeds

TchuBBak has a EmbedHelper class, which makes modules' response in TchuBBak style.

Voice

TchuBBak has a VoiceAdapter class to change AudioHandlers (temp/perm)

Todo:

• Remove hardcode from Module(move onMessage and onVoice to Triggers)
• Simplify Music module

Used libraries

• log4j2 - Logging
• JSoup - Parsing YouTube Search
• JDA - Discord API implementation
• lavaplayer - Player for the Music module
• mongo-java-driver - Bot's database
• gson - Bot's database helper
• google-cloud-speech - For voice recognition

Thanks to

• meetinger
• lavaplayer demo