Skip to content

Stronghold's general purpose bot packaged with various features to help in Discord server tasks and the automation of other services.

License

Notifications You must be signed in to change notification settings

Splatoon-Stronghold/cas-stronghold-bot

Repository files navigation

Cas Bot

Running

Configure

Environment variables

Define the environment variables used in utils/env.py in your environment or .env (.env takes priority):

# For loading config file, not required
BOT_CONFIG_PATH=config_data.json

# Discord
DISCORD_TOKEN=...
GUILD_ID=...

# Twitch
TWITCH_CLIENT=...
TWITCH_SECRET=...
TWITCH_USER=...

# YouTube
YT_API_KEY=...
YT_CHANNEL_ID=...

# Logging Channel
LOGGING_CHANNEL_NAME=...

Setting up your own bot application

Follow instructions in BOT_INSTALLATION.md

Configuration files

Copy config_data-example.json, rename it to config_data.json and adjust the options as needed.

time.json will be created automatically when the bot starts.

Prepare & install dependencies

  1. Install pipx.
  2. Install poetry:
pipx install poetry
  1. Install dependencies:
poetry install
  1. Set up precommit hooks:
poetry run pre-commit install

Run

For overriding the .env guild you can set FORCE_GUILD_ID value

export FORCE_GUILD_ID="YOUR_TARGET_GUILD_ID"
poetry run task bot

For more tasks, see pyproject.toml.

Misc

List actually used direct dependencies

pipx install pipreqs
pipreqs .

Uninstall pre-commit hooks

poetry run pre-commit uninstall

About

Stronghold's general purpose bot packaged with various features to help in Discord server tasks and the automation of other services.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages