[0.8.2] lyra package update

Signed-off-by: Michael Czyż <mike@c2yz.com>

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "lyra"
-version = "0.8.0"
+version = "0.8.2"
 authors = ["Michał Czyż <mike@c2yz.com>"]
 edition = "2021"
 description = "A featureful Discord bot written in Rust."
@@ -15,19 +15,31 @@ keywords = ["discord", "bot", "rust", "music", "featureful"]
 dotenv = "0.15.0"
 fancy-regex = "0.13.0"
 json = "0.12.4"
-openssl = { version = "0.10.63", features = ["vendored"] }
+openssl = { version = "0.10.66", features = ["vendored"] }
 owoify = "0.1.5"
 poise = "0.6.1"
 rand = "0.8.5"
-regex = "1.10.3"
-reqwest = { version = "0.11.23", features = ["json"]}
-serde = { version = "1.0.197", features = ["derive"] }
-serde_json = "1.0.114"
-serenity = { version = "0.12.0", features = ["cache", "framework", "standard_framework", "voice"] }
-songbird = { version = "0.4.0", features = ["builtin-queue", "serenity"] }
-symphonia = { version = "0.5.3", features = ["aac", "adpcm", "alac", "flac", "mpa", "isomp4"] }
-tokio = { version = "1.35.1", features = ["macros", "full", "signal"] }
+regex = "1.10.6"
+reqwest = { version = "0.11.27", features = ["json"] }
+serde = { version = "1.0.204", features = ["derive"] }
+serde_json = "1.0.122"
+serenity = { version = "0.12.2", features = [
+    "cache",
+    "framework",
+    "standard_framework",
+    "voice",
+] }
+songbird = { version = "0.4.3", features = ["builtin-queue", "serenity"] }
+symphonia = { version = "0.5.4", features = [
+    "aac",
+    "adpcm",
+    "alac",
+    "flac",
+    "mpa",
+    "isomp4",
+] }
+tokio = { version = "1.39.2", features = ["macros", "full", "signal"] }
 tracing = "0.1.40"
 tracing-futures = "0.2.5"
 tracing-subscriber = "0.3.18"
-url = "2.5.0"
+url = "2.5.2"

Dockerfile

@@ -1,19 +0,0 @@
-FROM rust:1.75.0-alpine
-
-RUN apk add --update \
-    alpine-sdk \
-    ffmpeg \
-    youtube-dl \
-    pkgconfig \
-    cmake \
-    openssl-dev \
-    musl-dev \
-    openssl
-
-WORKDIR /app
-
-COPY . .
-
-RUN cargo build --release
-
-CMD ["./target/release/lyra"]

LICENSE.md

@@ -1,7 +1,21 @@
-# License
+MIT License
 
-Copyright (C) 2024 Michał Czyż
+Copyright (c) 2024 Michał Czyż
 
-All Rights Reserved.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-This build is private and shall not be distributed nor modified without permission.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -3,10 +3,79 @@
 ![](assets/lyra-256.png)
 
 Lyra is a music bot written in Rust.
-More features coming soon!
 
 ## Getting Started
 
-## Building
+Lyra is an open source, discord music bot written in Rust.
+
+The idea behind this project is to allow a user to self-host one's own instance of the bot.
+
+User no longer has to rely on 3rd parties to provide them an invite link.
+
+The bot can be run even on a desktop or a phone because after compilation, it's just a simple binary.
+
+As of now, the bot supports spotify url track recognition through a separate nodejs script. I plan to write the actual parser inside the bot iteself but as of now I postponed it into future release.
+
+Slash commands are still work in progress! Currently bot is still heavily in development!
+
+## Setting up
+
+To compile the source code on your own, you need `rust` and `cargo`
+
+To run a dev version use
+```bash
+$ cargo run
+```
+
+To build a production version use
+```bash
+$ cargo build --release
+```
+
+If you need an ARM version and just don't want to wait for ages for the program to compile, use
+```bash
+$ cross build -r --target aarch64-unknown-linux-gnu
+```
+
+To run a program, just type
+```bash
+$ ./lyra
+```
+
+if you want to disown it from the shell, I recommend using the script I provided in `scripts` folder
 
 ## Commands
+
+As of now, working commands are:
+
+```
+Music:
+  /deafen       Deafens itself while in a voice channel; aliases: deafen, undeaden, shuush
+  /join         Joins your voice channel
+  /leave        Leaves the voice channel; aliases: leave, qa!
+  /mute         Mutes itself while in a voice channel; aliases: mute, unmute, shhh
+  /pause        Pauses the currently playing song
+  /play         Plays a song; you can search by query or paste an url; aliases: play, p, enqueue
+  /queue        Shows next tracks in queue; aliases: queue, q
+  /repeat       Loops currently playing song provided amount of times; aliases: repeat, loop, while, for
+  /resume       Resumes currently paused song
+  /seek         Seeks a track by provided seconds
+  /skip         Skips the currently playing song
+  /stop         Stops playback and destroys the queue; aliases: stop, end
+  /volume       Changes output volume
+  /effect       Plays one of available audio effects
+  /stream       Hijacks output and plays audio; search by query or paste an url; aliases: stream, override, hijack
+
+Tools:
+  /ai           Asks AI
+  /dice         Rolls a dice
+  /owoify       Owoifies whatever you want uwu
+  /ping         Pings you backs with a response time
+  /posix        Prints current time in POSIX format
+  /qr           Creates a qr code from text
+  /verse        Reference Bible by verse
+
+Help:
+  /help         Prints this help message; aliases: help, huh, welp
+
+```

docker-compose.yaml

@@ -1,6 +0,0 @@
-version: '2'
-
-services:
-  lyra:
-    container_name: lyra
-    build: .

src/commands/music/skip.rs

@@ -12,8 +12,14 @@ use serenity::{
 };
 use songbird::{input::AuxMetadata, tracks::TrackHandle};
 
-/// Skips the currently playing song
-#[poise::command(prefix_command, slash_command, category = "Music")]
+/// Skips the currently playing song; \
+/// aliases: skip, :skipper:
+#[poise::command(
+    prefix_command, 
+    slash_command, 
+    aliases("skipper:"),
+    category = "Music"
+)]
 pub async fn skip(ctx: Context<'_>) -> Result<(), Error> {
     let guild_id = ctx.guild_id().unwrap();