uwubot

Build Status Latest Version Rust Documentation

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:

  1. create a new bot in the [discord developer portal]
  2. copy the client-id and bot token from the new bot
  3. run uwubot with uwubot <bot-token> --client-id <client-id>
  4. create a url with the applications.commands oauth2 scope on the OAuth2 tab of the developer portal
  5. navigate to the generated URL to register your bot on your server of choice

If you'd like to use the instance of uwubot that I'm running you can use this url to register it on your server. Note: I don't make any sort of uptime guarantees for this instance, as of writing this README I'm running it on my laptop, so it will almost certainly be offline, though eventually I hope to run it on my desktop...

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.