This is a Discord bot that will play clock sounds in voice chat every hour. It can be useful to remind you of the time, or just to annoy your friends :)
This project uses the Bun runtime and its SQLite driver. It also requires FFmpeg to be installed to play audio files.
You can use the Devcontainer configuration to easily develop this project in a containerized environment.
If you are on NixOS, you can use the provided flake.nix file to get a development environment with all the required dependencies by running the following command:
nix developTo run the project, you can use the following command:
bun run devIf you want to automatically reload the project when the source code changes, you can use the following command:
bun run watch:startYou must provide a volume to store the SQLite database file if you want to persist the data between runs.
This project requires the following environment variables to be set:
DISCORD_TOKEN: The Discord bot tokenDB_FILE_NAME: The SQLite database file name (default:database.sqlite)
You can copy the .env.example file to .env and set the values there.
You can build the Docker image for production with the following command:
docker build -t clockymcclockface .And then run the image with the following command:
docker run -d --name clockymcclockface -v /path/to/database.sqlite:/app/database.sqlite -e DISCORD_TOKEN=your_token clockymcclockface- Bun - A fast all-in-one toolkit and runtime for modern JavaScript
- Discord.js - A powerful library for interacting with the Discord API
- Sapphire Framework - A framework for building Discord bots with TypeScript
- Biome - Fast linter and formatter for the web
- Drizzle ORM - A fast and type-safe ORM for TypeScript
This project's source code is licensed under the MIT License - see the LICENSE file for details.
The audio files are from pixabay, and are licensed under the Pixabay License.