chore: release 0.10.1

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: eRgo35

.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: ci
+
+on:
+  push:
+    branches: [senpai]
+  pull_request:
+    branches: [senpai]
+
+env:
+  RUST_BACKTRACE: 1
+  RUST_LOG: trace
+
+jobs:
+  test:
+    name: test
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          profile: minimal
+          override: true
+
+      - name: Set up cache
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Build projectable
+        run: cargo build --verbose
+
+      - name: Run tests
+        run: cargo test --verbose

.github/workflows/release.yml

@@ -0,0 +1,119 @@
+name: release
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+
+permissions: write-all
+
+jobs:
+  # Creates a release and outputs the url
+  create-release:
+    name: create-release
+    runs-on: ubuntu-latest
+    outputs:
+      upload_url: ${{ env.RELEASE_UPLOAD_URL }}
+      version: ${{ env.VERSION }}
+    steps:
+      - name: Get the release version from the tag
+        shell: bash
+        if: env.VERSION == ''
+        run: |
+          echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
+          echo "version is: ${{ env.VERSION }}"
+      - name: Create GitHub release
+        uses: actions/github-script@v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+          script: |
+            try {
+              const response = await github.rest.repos.createRelease({
+                draft: false,
+                generate_release_notes: true,
+                name: process.env.VERSION,
+                owner: context.repo.owner,
+                prerelease: false,
+                repo: context.repo.repo,
+                tag_name: process.env.VERSION,
+              });
+
+              core.exportVariable('RELEASE_ID', response.data.id);
+              core.exportVariable('RELEASE_UPLOAD_URL', response.data.upload_url);
+            } catch (error) {
+              core.setFailed(error.message);
+            }
+
+  build-and-upload:
+    name: Build and upload
+    needs: create-release
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        build: [linux-gnu, linux-aarch64-gnu]
+        include:
+          - build: linux-gnu
+            os: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+            use-cross: true
+
+          - build: linux-aarch64-gnu
+            os: ubuntu-latest
+            target: aarch64-unknown-linux-gnu
+            use-cross: true
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          profile: minimal
+          override: true
+          target: ${{ matrix.target }}
+
+      - name: Build
+        uses: actions-rs/cargo@v1
+        with:
+          use-cross: ${{ matrix.use-cross }}
+          command: build
+          args: --verbose --release --target ${{ matrix.target }}
+
+      - name: Strip release binary (linux and macos)
+        if: matrix.build == 'linux-gnu' || matrix.build == 'linux-musl' || matrix.build == 'macos' || matrix.build == 'linux-aarch64-gnu'
+        run: strip "target/${{ matrix.target }}/release/lyra"
+
+      - name: Build archive
+        shell: bash
+        run: |
+          dirname="lyra-${{ needs.create-release.outputs.version }}-${{ matrix.target }}"
+          mkdir "$dirname"
+          if [ "${{ matrix.os }}" = "windows-latest" ]; then
+            mv "target/${{ matrix.target }}/release/lyra.exe" "$dirname"
+          else
+            mv "target/${{ matrix.target }}/release/lyra" "$dirname"
+          fi
+          mv LICENSE.md "$dirname"
+
+          if [ "${{ matrix.os }}" = "windows-latest" ]; then
+            7z a "$dirname.zip" "$dirname"
+            echo "ASSET=$dirname.zip" >> $GITHUB_ENV
+          else
+            tar -czf "$dirname.tar.gz" "$dirname"
+            echo "ASSET=$dirname.tar.gz" >> $GITHUB_ENV
+          fi
+
+      - name: Upload archive
+        uses: actions/upload-release-asset@v1.0.1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.create-release.outputs.upload_url }}
+          asset_path: ${{ env.ASSET }}
+          asset_name: ${{ env.ASSET }}
+          asset_content_type: application/octet-stream

Cargo.lock

@@ -149,21 +149,6 @@ version = "0.22.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6"
 
-[[package]]
-name = "bit-set"
-version = "0.5.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0700ddab506f33b20a03b13996eccd309a48e5ff77d0d95926aa0210fb4e95f1"
-dependencies = [
- "bit-vec",
-]
-
-[[package]]
-name = "bit-vec"
-version = "0.6.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "349f9b6a179ed607305526ca489b34ad0a41aed5f7980fa90eb03160b69598fb"
-
 [[package]]
 name = "bitflags"
 version = "1.3.2"
@@ -642,17 +627,6 @@ version = "0.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "af9673d8203fcb076b19dfd17e38b3d4ae9f44959416ea532ce72415a6020365"
 
-[[package]]
-name = "fancy-regex"
-version = "0.13.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "531e46835a22af56d1e3b66f04844bed63158bc094a628bec1d321d9b4c44bf2"
-dependencies = [
- "bit-set",
- "regex-automata 0.4.7",
- "regex-syntax 0.8.4",
-]
-
 [[package]]
 name = "fastrand"
 version = "2.1.0"
@@ -1352,7 +1326,6 @@ name = "lyra"
 version = "0.10.0"
 dependencies = [
  "dotenv",
- "fancy-regex",
  "json",
  "lib-spotify-parser",
  "once_cell",

Cargo.toml

@@ -1,10 +1,10 @@
 [package]
 name = "lyra"
-version = "0.10.0"
+version = "0.10.1"
 authors = ["Michał Czyż <mike@c2yz.com>"]
 edition = "2021"
 description = "A featureful Discord bot written in Rust."
-documentation = "https://lyra.c2yz.com/docs"
+documentation = "https://github.com/eRgo35/lyra"
 readme = "README.md"
 homepage = "https://lyra.c2yz.com"
 license-file = "LICENSE.md"
@@ -13,7 +13,6 @@ keywords = ["discord", "bot", "rust", "music", "featureful"]
 [dependencies]
 lib-spotify-parser = { path = "./libs/spotify-parser" }
 dotenv = "0.15.0"
-fancy-regex = "0.13.0"
 json = "0.12.4"
 openssl = { version = "0.10.66", features = ["vendored"] }
 owoify = "0.1.5"
@@ -34,7 +33,6 @@ serenity = { default-features = true, features = [
     "http",
     "rustls_backend",
 ], version = "0.12" }
-
 symphonia = { version = "0.5.4", features = [
     "aac",
     "adpcm",

README.md

@@ -1,52 +1,82 @@
-# Lyra
+<h2 align="center">
-
+  <a href="https://lyra.c2yz.com" target="blank_">
-![](assets/lyra-256.png)
+    <img height="256" alt="Lyra" src="assets/lyra-256.png" />
-
+  </a>
-Lyra is a music bot written in Rust.
+  <br />
-
+  Lyra: a discord music bot written in rust :crab:
-## Getting Started
+</h2>
 
 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 a service.
+The bot can be run on a desktop, a vps or a phone as it's just a simple binary.
 
-User no longer has to rely on 3rd parties to provide them an invite link.
+Currently bot is still heavily in development!
 
-The bot can be run even on a desktop or a phone because after compilation, it's just a simple binary.
+## Getting started
 
-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.
+Before you start, you need to create a discord bot and get a token.
+You can do it [here](https://discord.com/developers/applications).
 
-Slash commands are still work in progress! Currently bot is still heavily in development!
+After you create a bot, you need to invite it to your server.
 
-## Setting up
+Then, head to download section and download the latest release (or compile it yourself).
+
+After you download the binary, you need to create a `.env` file in the same directory as the binary.
+Example can be found in `.env.example` file.
+
+```
+DISCORD_TOKEN=<YOUR_DISCORD_TOKEN>
+PREFIX=<YOUR_PREFIX>
+```
+
+DISCORD_TOKEN is the token you got from discord developers page and PREFIX is the prefix you want to use for your bot.
+
+Bot by default reacts only to the prefix. To enable slash commands, while the bot is running type `:register` in the chat (where `:` is your bot prefix).
+
+## Features
+
+- Music playback
+- Audio effects (soon)
+- Some multipurpose commands
+- Slash commands
+- Self-hosted
+
+## Compilation
 
 To compile the source code on your own, you need `rust` and `cargo`
 
-To run a dev version use
+To run a dev version, `cd` into the project directory and type
+
 ```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
+If you need a version for a different system or architecture, you can use `cross` crate
+
 ```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
+Remember to provide a `.env` file in the same directory as the binary.
+
+If you want to disown the bot from the shell, I recommend using the script I provided in `scripts` folder
 
 ## Commands
 
-As of now, working commands are:
+As of now, the commands are:
 
 ```
 Music:
@@ -60,7 +90,7 @@ Music:
   /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
+  /skip         Skips the currently playing song; aliases: skip, :skipper:
   /stop         Stops playback and destroys the queue; aliases: stop, end
   /volume       Changes output volume
   /effect       Plays one of available audio effects
@@ -69,13 +99,22 @@ Music:
 Tools:
   /ai           Asks AI
   /dice         Rolls a dice
+  /dictionary   Explains provided query
+  /ip           Shows IP information
+  /metar        Prints metar for provided airport
   /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
+  /taf          Returns taf for provided airport
+  /uptime       Checks how long the bot has been running
   /verse        Reference Bible by verse
+  /weather      Shows weather for provided location
 
 Help:
   /help         Prints this help message; aliases: help, huh, welp
 
+Use /help command for more info on a command.
+You can edit you message to the bot and the bot will edit its response.
+
 ```