Skip to content

PhazonicRidley/Terrygon

Repository files navigation

Terrygon, a multipurpose discord bot

A modular discord bot written in Python

Notice: This repo is a rewrite of this repo. This bot is currently underconstruction

Features:

Fully featured bot including but not limited to: User warning system with optional punishments Customizable word filter Moderation commands to handle any situation (if they worked /s) Approval system to prevent raiding and keep private servers private Allow some users to have access to more features if they are trusted in a community Customizable self roles Colors for either each user or communally used colors depending on how a server wishes to configure And much much more!

How to use:

Manually:

  1. Install Python 3.9+ and postgresql 13.
  2. Create a postgres user (By default the schema expects a user called terrygon. If you plan to use a different name, change the first line in schema.sql).
  3. Clone the project locally and cd into it.
  4. Create a venv python3 -m venv virtualenv, and activate it source virtualenv/bin/activate.
  5. Run python -m pip install --upgrade pip and then python -m pip install -r requirements.txt.
  6. Next, run cp config.toml.example config.toml if you are on linux or macos, copy config.toml.example config.toml if you are on windows.
  7. Edit the config.toml fields with your information. Each field is labled on what it does, if you need help making a bot token, you can check here for instructions on making it and adding it to your server.
  8. Change the paths in terrygon.service for where your bot is located, and where the virtualenv is located.
  9. Copy terrygon.service to ~/.config/systemd/user.
  10. Run commands systemctl --user daemon-reload and then finally systemctl --user start terrygon.service. You may also choose to enable this at start up.

Docker:

  1. Install Docker and then clone this repository.
  2. Enter the cloned repo directory in a terminal.
  3. Run cp config.toml.example config.toml if you are on linux or macos, copy config.toml.example config.toml if you are on windows.
  4. Edit the config.toml fields with your information. Each field is labled on what it does, if you need help making a bot token, you can check here
  5. Run docker compose up -d and docker will automatically make a containerized bot. The data folder is a volume into the container.

Requirements

Credits

About

A modular discord bot written in Python

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages