Improve installation process and add README

README.md

@@ -0,0 +1,55 @@
+# ![](.media/icon.png) Angy Bot
+
+Music player bot for Discord supporting unusual formats and features, intended for use in the [RYG community](https://www.ryg.one/).
+
+> **Warning**
+>
+> Very hastily developed with no regards to security or code quality, use it at your own risk!
+
+## Links
+
+*No links available right now.*
+
+## Screenshots
+
+![The bot being summoned, a Plex track being played, and playback being stopped in a Discord chat.](.media/screenshot-slash.png)
+
+## Features
+
+Currently supports playing from:
+
+- local filesystem
+- yt-dlp
+- local Plex instance
+
+> **Warning**
+> 
+> The bot currently supports only the playback of a single track at a time.
+
+## Commands
+
+The bot registers the following Slash Commands:
+
+- `/summon channel:...` · Makes the bot connect to a channel
+- `/play file what:...` · If you are the bot owner, plays the file at the given path.
+- `/play ytdl what:...` · Tries to download and play the given string with yt-dlp, falling back to `ytsearch:` if it is not a valid URL.
+- `/play plex what:...` · Queries a Plex Media Server for a track name, and plays the first result returned.
+- `/stop` · Stops playback of any track.
+
+## Installation
+
+Use the provided Docker image:
+
+- [`ghcr.io/ryghub/angybot`](https://github.com/RYGhub/angybot/pkgs/container/angybot)
+
+The following environment variables must be set to configure the bot:
+
+- `ANGY_TOKEN` · The Discord bot token to use.
+- `ANGY_APPID` · The Discord application id to use.
+- `ANGY_PLEX_SERVER` · The Plex server to use.
+- `ANGY_PLEX_TOKEN` · The Plex token to use.
+- `ANGY_PLEX_LIBRARY` · The Plex library to use.
+- `ANGY_PLEX_REPLACE_FROM` · The string to remove from the media file path for Plex files.
+- `ANGY_PLEX_REPLACE_TO` · The string to add in the media file path for Plex files.
+- `ANGY_DEV_GUILD_ID` · The guild id to register Slash Commands in.
+- `ANGY_DEV_USER_ID` · The user id allowed to use `/play file`.

src/config.rs

@@ -1,5 +1,6 @@
 use std::env;
 use lazy_static::lazy_static;
+use serenity::model::id::{UserId, GuildId};
 
 
 lazy_static! {
@@ -25,11 +26,25 @@ lazy_static! {
     pub static ref PLEX_LIBRARY: String = env::var("ANGY_PLEX_LIBRARY")
         .expect("ANGY_PLEX_LIBRARY to be set");
 
-    /// The string to remove from the media file path.
+    /// The string to remove from the media file path for Plex files.
     pub static ref PLEX_REPLACE_FROM: String = env::var("ANGY_PLEX_REPLACE_FROM")
         .expect("ANGY_PLEX_REPLACE_FROM to be set");
 
-    /// The string to add in the media file path.
+    /// The string to add in the media file path for Plex files.
     pub static ref PLEX_REPLACE_TO: String = env::var("ANGY_PLEX_REPLACE_TO")
         .expect("ANGY_PLEX_REPLACE_TO to be set");
+
+    /// The guild id to register Slash Commands in.
+    pub static ref DEV_GUILD_ID: GuildId = env::var("ANGY_DEV_GUILD_ID")
+        .expect("ANGY_DEV_GUILD_ID to be set")
+        .parse::<u64>()
+        .expect("ANGY_DEV_GUILD_ID to be a valid u64")
+        .into();
+
+    /// The user id allowed to use `/play file`.
+    pub static ref DEV_USER_ID: UserId = env::var("ANGY_DEV_USER_ID")
+        .expect("ANGY_DEV_USER_ID to be set")
+        .parse::<u64>()
+        .expect("ANGY_DEV_USER_ID to be a valid u64")
+        .into();
 }

src/handler/commands/play.rs

@@ -1,4 +1,3 @@
-use std::env;
 use std::ffi::OsString;
 use serenity::prelude::*;
 use serenity::model::prelude::*;
@@ -27,11 +26,7 @@ pub async fn play(ctx: &Context, guild: &GuildId, member: &Member, opts: Options
 		}
 		// play file
 		else if option_optional_string(&opts, "file").is_some() {
-			let dev_user_id: UserId = env::var("ANGY_DEV_USER_ID")
-				.map_err(|_| AngyError::Bot("`ANGY_DEV_USER_ID` is not set."))?
-				.parse::<u64>()
-				.map_err(|_| AngyError::Bot("`ANGY_DEV_USER_ID` is not a valid ID."))?
-				.into();
+			let dev_user_id: UserId = crate::config::DEV_USER_ID.clone();
 
 			match member.user.id.eq(&dev_user_id) {
 				false => Err(AngyError::User("This command can be used only by the bot's owner."))?,

src/main.rs

@@ -1,14 +1,4 @@
-//! # Angy Bot
-//!
-//! Music player bot for Discord supporting unusual formats and features, intended primarly for usage in the [RYG community](https://www.ryg.one/).
-//!
-//! ## Supported players
-//!
-//! Currently supports playing from:
-//! - local filesystem
-//! - yt-dlp
-//! - local Plex instance
-
+//! Main function of Angy Bot.
 
 mod schema;
 mod error;