uwubot
| Crates.io | uwubot |
| lib.rs | uwubot |
| version | 0.3.0 |
| created_at | 2021-03-26 04:50:50.576816+00 |
| updated_at | 2021-03-28 16:05:33.231491+00 |
| description | discord bot for uwuifying text |
| homepage | |
| repository | https://github.com/yaahc/uwubot |
| max_upload_size | |
| id | 373667 |
| size | 86,239 |
Jane Losare-Lusby (yaahc)
documentation
README
uwubot
This crate defines a discord bot using serenity for uwuifying text via uwuify.
Installation
You can install uwubot from source or from crates.io
cargo install uwubot
Usage / Bot Setup
You can setup your own instance of uwubot using the following steps:
- create a new bot in the discord developer portal
- copy the client-id and bot token from the new bot
- run uwubot with
uwubot <bot-token> --client-id <client-id> - create a url with the
applications.commandsoauth2 scope on theOAuth2tab of the developer portal - navigate to the generated URL to register your bot on your server of choice
Docker Instance
Alternatively you can try to run uwubot with the provided Dockerfile. The bot-token and client-id args can be set via the BOT_TOKEN or CLIENT_ID environment variables.
docker build -t uwubot .
docker run -it --rm --env BOT_TOKEN="<bot-token>" --env CLIENT_ID=<client-id> --name uwubot-running uwubot
Additional Details
uwubot allows you to either register global commands or guild commands. To register a guild command you'll need to figure out your discord server's guild ID. I'll try to add an easy way to export this in uwubot in the future but for now you're on you're own, I'm sowwy >_<.
Guild commands have the advantage of being instantly updated, where as global commands are cached with a 1 hour update rate.
License
Licensed under either of Apache License, Version 2.0 or MIT license at your option.Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.