Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Wavy-Bot/bot
The blazing-fast Discord bot.
https://github.com/Wavy-Bot/bot
bot discord discord-bot docker docker-compose docker-image mongodb pycord python python-3 python3
Last synced: 5 days ago
JSON representation
The blazing-fast Discord bot.
- Host: GitHub
- URL: https://github.com/Wavy-Bot/bot
- Owner: Wavy-Bot
- License: gpl-3.0
- Created: 2021-06-13T10:02:33.000Z (over 3 years ago)
- Default Branch: production
- Last Pushed: 2023-08-07T04:12:48.000Z (over 1 year ago)
- Last Synced: 2024-10-30T05:56:46.209Z (8 days ago)
- Topics: bot, discord, discord-bot, docker, docker-compose, docker-image, mongodb, pycord, python, python-3, python3
- Language: Go
- Homepage: https://wavybot.com
- Size: 557 KB
- Stars: 6
- Watchers: 3
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-blazingly-fast - bot - The blazing-fast Discord bot. (Python)
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.
Proudly hosted by Hostvio
# Wavy
Wavy is an open-source Discord bot built with [DisGo](https://github.com/disgoorg/disgo).
## Feature requests
Want a new feature you think is missing? Please [open an issue](https://github.com/Wavy-Bot/bot/issues/new) or join [Wavy's Discord server](https://discord.wavybot.com) and we'll look into it!
## Community Standards
Please refer to the list of community standards below:
- [README](https://github.com/Wavy-Bot/bot/blob/main/README.md) (this file)
- [Code of Conduct](https://github.com/Wavy-Bot/bot/blob/main/CODE_OF_CONDUCT.md)
- [License](https://github.com/Wavy-Bot/bot/blob/main/LICENSE.md)
- [To-do list](https://github.com/Wavy-Bot/bot/projects/2)
- 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](https://semver.org/). 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](https://git-scm.com/downloads)
- [Go, tested on 1.20.3](https://www.python.org/downloads/)
- [An app on Discord](https://discord.com/developers/applications) with bot usage enabled
- [A Lavalink instance](https://github.com/freyacodes/Lavalink)
- [A Sentry application](https://sentry.io)
```bash
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:
```bash
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:
```bash
docker volume create wavy-data
docker run -d --name wavy -v wavy-data:/wavy ghcr.io/wavy-wavy/wavy:production
```
## License
See [LICENSE.MD](LICENSE.md).