ToastBot

ToastBot is a lightweight Discord bot designed exclusively for the Toasted's Den Discord server.

This repository contains the streamlined source code for ToastBot, now operating in read-only mode. Commands, experimental features, and unused packages have been removed for simplicity.

New members will receive a unique welcome message in the specified welcome channel. Join, Leave, and Message Delete events are logged in the designated logs channel and a local log file located in ./logs. Both the welcome channel and log settings are configured in the .env file.

Development

ToastBot was originally developed by Toasted Den in 2021, with significant contributions from sydneyn3308. Special thanks to Belt_Buckle, eitanshaul, walterblack5, kindman_, jarr012, and others for their help with beta testing.

Self-hosting

Prerequisites

• "Presence Update Events", "GUILD_MEMBERS", and "Message Contents" must be enabled for your bot through the Discord Developer Portal.

Getting Started

Running ToastBot with Node.js

Ensure you have the following installed:

• Node.js (v16.11.0 or higher, we use v22 LTS)

1. Clone the repository:

   git clone https://github.com/toastedden/toastbot.git
   cd toastbot

2. Install dependencies:

   npm install

3. Edit the .env.example file with your guild's channel info, logging details, and bot token from the Discord Developer Portal. For detailed descriptions of each environment variable, refer to the comments within the .env.example file.

   TOKEN=your_discord_bot_token
   

4. Run the bot:

   node src/toastbot.js

Running ToastBot with Docker Compose

Ensure Docker Engine and Docker Compose are installed on your system.

1. Clone the repository:

   git clone https://github.com/toastedden/toastbot.git
   cd toastbot

2. Edit the .env.example file with your guild's channel info, logging details, and bot token from the Discord Developer Portal. For detailed descriptions of each environment variable, refer to the comments within the .env.example file.

   TOKEN=your_discord_bot_token
   

3. Run the bot with Docker Compose in detached mode:

   docker compose up --build -d

This will build the Docker image, install dependencies, and run the bot inside a Docker container named ToastBot.

Contributing

Pull requests are welcome, though ToastBot is currently quite minimal and may not need many additional features.