Skip to content

README.md

Latest commit

 

History

History
53 lines (35 loc) · 2.04 KB

README.md

File metadata and controls

53 lines (35 loc) · 2.04 KB
Raw

Sakamoto

Sakamoto is a modular Python Discord bot inspired by the Nichijou character. It focuses on voice features for small-to-medium communities.

It is a Python rewrite intended to apply stronger modular design than earlier projects.

Sakamoto icon
License Commit activity Dependencies

Run

See the setup guide and configuration reference for integration-specific tokens.

Docker Compose

export TOKEN='YOUR_DISCORD_BOT_TOKEN'
./init-docker.sh

Docker image

docker build -t sakamoto:latest .
docker run -e TOKEN='YOUR_DISCORD_BOT_TOKEN' sakamoto:latest

Prebuilt images are available as ghcr.io/taichikuji/sakamoto:latest; they can be used with Kubernetes, though this repository does not provide a Kubernetes manifest.

To enable the built-in updater, uncomment its service and the discord service labels in docker-compose.yml. CRON_SCHEDULE defaults to 0 0 * * * (daily).

Develop

pipenv install --dev
export TOKEN='YOUR_DISCORD_BOT_TOKEN'
pipenv run python main.py

Extensions live in extensions/, grouped by responsibility:

  • core/ contains always-on administration such as loading, syncing, and shutdown.
  • audio/, moderation/, community/, integrations/, and general/ contain user-facing domains.

See the contribution guide, domain context, and wiki.

Dependencies

Can be seen @ Pipfile