serenity
Serenity is a Rust library for the Discord API.
View the examples on how to make and structure a bot.
Serenity supports bot login via the use of Client::new
.
You may also check your tokens prior to login via the use of
validate_token
.
Once logged in, you may add handlers to your client to dispatch Event
s,
by implementing the handlers in a trait, such as EventHandler::message
. This will cause your handler to be called
when a Event::MessageCreate
is received. Each handler is given a
Context
, giving information about the event. See the
client's module-level documentation.
The Shard
is transparently handled by the library, removing
unnecessary complexity. Sharded connections are automatically handled for
you. See the gateway's documentation for more information.
A Cache
is also provided for you. This will be updated automatically for
you as data is received from the Discord API via events. When calling a
method on a Context
, the cache will first be searched for relevant data
to avoid unnecessary HTTP requests to the Discord API. For more information,
see the cache's module-level documentation.
Note that - although this documentation will try to be as up-to-date and accurate as possible - Discord hosts official documentation. If you need to be sure that some information piece is accurate, refer to their docs.
Example Bot
A basic ping-pong bot looks like:
extern crate serenity;
use Client;
use EventHandler;
use StandardFramework;
use env;
;
command!;
Full Examples
Full examples, detailing and explaining usage of the basic functionality of the
library, can be found in the examples
directory.
Installation
Add the following to your Cargo.toml
file:
[]
= "0.5"
and to the top of your main.rs
:
extern crate serenity;
Serenity supports a minimum of Rust 1.25.
Features
Features can be enabled or disabled by configuring the library through Cargo.toml:
[]
= false
= ["pick", "your", "feature", "names", "here"]
= "0.5"
The default features are: builder
, cache
, client
, framework
, gateway
,
http
, model
, standard_framework
, and utils
.
The following is a full list of features:
- builder: The builders used in conjunction with models' methods.
- cache: The cache will store information about guilds, channels, users, and other data, to avoid performing REST requests. If you are low on RAM, do not enable this;
- client: A manager for shards and event handlers, abstracting work away handling shard events and updating the cache, if enabled.
- framework: Enables the framework, which is a utility to allow simple command parsing, before/after command execution, prefix setting, and more;
- gateway: A Shard, used as a higher-level interface for communicating with the Discord gateway over a WebSocket client.
- http: Functions providing a wrapper over Discord's REST API at a low enough level that optional parameters can be provided at will via a JsonMap.
- model: Method implementations for models, acting as helper methods over the HTTP functions.
- standard_framework: A standard, default implementation of the Framework
- utils: Utility functions for common use cases by users.
- voice: Enables compilation of voice support, so that voice channels can be connected to and audio can be sent/received.
If you want all of the default features except for cache
for example, you can
list all but that:
[]
= false
= [
"builder",
"client",
"framework",
"gateway",
"http",
"model",
"standard_framework",
"utils",
]
= "0.5"
Dependencies
Serenity requires the following dependencies:
- openssl
Voice
The following dependencies all require the voice feature to be enabled in your Cargo.toml:
- libsodium (Arch:
community/libsodium
) - opus (Arch:
extra/opus
)
Voice+ffmpeg:
- ffmpeg (Arch:
extra/ffmpeg
)
Voice+youtube-dl:
- youtube-dl (Arch:
community/youtube-dl
)
Building the voice
-feature on Windows can be done by following these instructions: https://github.com/serenity-rs/serenity/wiki/Voice-on-Windows