From 9474577233123fa3bf4f0a9c33ea594774d725d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Czy=C5=BC?= Date: Thu, 22 Feb 2024 13:55:11 +0100 Subject: [PATCH] Lyra is now open source! --- Cargo.toml | 2 +- LICENSE.md | 22 +++++++++++++--- README.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 3 files changed, 90 insertions(+), 7 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 0732ff2..adb9b64 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "lyra" -version = "0.8.0" +version = "0.8.1" authors = ["Michał Czyż "] edition = "2021" description = "A featureful Discord bot written in Rust." diff --git a/LICENSE.md b/LICENSE.md index a1332ca..5736698 100644 --- a/LICENSE.md +++ b/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. diff --git a/README.md b/README.md index 8950642..3960186 100644 --- a/README.md +++ b/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 + +```