bot

README

Wavy is currently in alpha. This means that the bot is not yet ready for public use and things will break. ⚠️

The blazing-fast Discord bot.

Website • GitHub • Discord

Proudly hosted by Hostvio

Wavy

Wavy is an open-source Discord bot built with DisGo.

Feature requests

Want a new feature you think is missing? Please open an issue or join Wavy's Discord server and we'll look into it!

Community Standards

Please refer to the list of community standards below:

• README (this file)
• Code of Conduct
• License
• To-do list
• Clear roadmap (to be added)
• Contributing guidelines (to be added)
• Issue templates (to be added)
• Pull request templates (to be added)

Versioning and releases

Wavy uses Semantic Versioning. This means that the version number will be in the format of:

major.minor.patch

• Major: Breaking changes, the bot is no longer compatible with previous versions.
• Minor: New features, no breaking changes.
• Patch: Bug fixes and small improvements.

Next to that, any production-ready release will be pushed to the production branch, and any development release will be pushed to the development branch.

How to use

The following has been tested on Alpine linux 3.17.x.

Prerequisites:

• A terminal emulator or CMD (if on Windows).
• git
• Go, tested on 1.20.3
• An app on Discord with bot usage enabled
• A Lavalink instance
• A Sentry application

git clone https://github.com/Wavy-Bot/bot.git
cd bot

Then copy the .env.example file to .env and edit it using your preferred text editor.

Afterwards, rename the lavalink.example.json file to lavalink.json and also edit that.

Finally, start the bot with the following commands:

go get
go build -o wavy cmd/wavy/main.go
./wavy

Docker

If you want to use Docker instead, you can use the following commands:

docker volume create wavy-data
docker run -d --name wavy -v wavy-data:/wavy ghcr.io/wavy-wavy/wavy:production

License

See LICENSE.MD.