dootBot

README

DootBot

About • Features • Commands • Setup • Todo

About

This project is made for and is intended to be a fun learning exercise.

The purpose of the bot is to allow members of a Discord channel to engage with the bot and earn money. This bot is inspired by and is very similar to idle games. The user can interact with the bot to earn and spend fake money. Actions as well as rewards are locked behind a cooldown/timer, some of which require the user to interact with the bot daily to receive their reward.

Features

• Easy to use! Uses buttons, emojis and color-coding in conjunction with updating messages to provide a clear and user-friendly experience

• Engaging the users by providing daily tasks

• User activities with progression

• Music player with queue with cache system to reduce YouTube API calls

Commands

• Work - Allows the user to earn a random amount of money [6 hour cooldown]
• Daily - Gives the user a random amount of money daily [24 hour cooldown]
• Farm - Allows the user to plant crops with can be harvested for a monetary reward. Crops must be watered within a timeframe for them to not perish. Includes crop unlocking system.
• Play - Plays a youtube song in the voice channel. Provide an url or search for a song.

Setup

The first time the bot is run, a config.json file is created. This JSON file requires some information in order to make the bot function.

1. The bot token [Token]
2. The owners (your) Discord ID [OwnerID]
3. The bots Discord ID [AppID]
4. (optional) Youtube API key(s) if you want to use music [youtubeAPIKeys]

Note: If multiple YouTube API keys are provided, the program will alternate between them.

Requirements

Needs to be available in the PATH

For the music

• ffmpeg
• yt-dlp

Additional requirements

• GCC

Configuration

The bot is fully customizable through the config.json file, where most if not all variables can be customised.

Running

You're able to build and run the bot with the included makefile.

Run make or make build or make b to build the bot

Run make run or make r to just run the bot

The makefile can also be used to build/run the bot for different operating systems such as Windows, Mac, and Linux

It is also possible to build or run it yourself with the go run main.go and go build main.go command, respectively.

Todo