From 7e892b778b4e152c1adc6e8c80c0c9b1e3eb1ab6 Mon Sep 17 00:00:00 2001 From: GrpeApple Date: Tue, 27 Jul 2021 21:32:43 +0800 Subject: [PATCH] Remove trailing whitespace --- README.md | 306 ++++++++++++++++---------------- readme/CREATE_FIRST_BOT.md | 20 +-- readme/LAVALINK_INSTALLATION.md | 38 ++-- readme/changelogs/0.1.1.md | 2 +- readme/changelogs/0.1.2.md | 2 +- readme/changelogs/0.1.3.md | 2 +- 6 files changed, 185 insertions(+), 185 deletions(-) diff --git a/README.md b/README.md index 465eeae..a821dee 100644 --- a/README.md +++ b/README.md @@ -5,24 +5,24 @@ ## Features: -✓ High quality -✓ Support filters -✓ Auto resume -✓ Stable -✓ Suport 8 music sources -✓ Feature-rich -✓ per guild prefix configuration -✓ and of course, adorable shipgirl +✓ High quality +✓ Support filters +✓ Auto resume +✓ Stable +✓ Suport 8 music sources +✓ Feature-rich +✓ per guild prefix configuration +✓ and of course, adorable shipgirl ## Current version: -- 0.1.3 (latest) [Release](https://github.com/Weeb-Devs/Laffey/releases/tag/0.1.3) | [Change Log](https://github.com/Weeb-Devs/Laffey/blob/main/readme/changelogs/0.1.3.md) -- 0.1.2 [Release](https://github.com/Weeb-Devs/Laffey/releases/tag/0.1.2) | [Change Log](https://github.com/Weeb-Devs/Laffey/blob/main/readme/changelogs/0.1.2.md) -- 0.1.1 [Release](https://github.com/Weeb-Devs/Laffey/releases/tag/0.1.1) | [Change Log](https://github.com/Weeb-Devs/Laffey/blob/main/readme/changelogs/0.1.1.md) -- 0.1.0 [Release](https://github.com/Weeb-Devs/Laffey/releases/tag/0.1.0) | [Change Log](https://github.com/Weeb-Devs/Laffey/blob/main/readme/changelogs/0.1.0.md) +- 0.1.3 (latest) [Release](https://github.com/Weeb-Devs/Laffey/releases/tag/0.1.3) | [Change Log](https://github.com/Weeb-Devs/Laffey/blob/main/readme/changelogs/0.1.3.md) +- 0.1.2 [Release](https://github.com/Weeb-Devs/Laffey/releases/tag/0.1.2) | [Change Log](https://github.com/Weeb-Devs/Laffey/blob/main/readme/changelogs/0.1.2.md) +- 0.1.1 [Release](https://github.com/Weeb-Devs/Laffey/releases/tag/0.1.1) | [Change Log](https://github.com/Weeb-Devs/Laffey/blob/main/readme/changelogs/0.1.1.md) +- 0.1.0 [Release](https://github.com/Weeb-Devs/Laffey/releases/tag/0.1.0) | [Change Log](https://github.com/Weeb-Devs/Laffey/blob/main/readme/changelogs/0.1.0.md) ## Requirements: ### Lavalink server -You need dev lavalink version to use our filters. You can get it by clicking [Here](https://ci.fredboat.com/viewLog.html?buildId=8767&buildTypeId=Lavalink_Build&tab=artifacts&branch_Lavalink=refs%2Fheads%2Fdev) and then, click on `Lavalink.jar` files [How to setup](https://github.com/Weeb-Devs/Laffey/blob/main/readme/LAVALINK_INSTALLATION.md) +You need dev lavalink version to use our filters. You can get it by clicking [Here](https://ci.fredboat.com/viewLog.html?buildId=8767&buildTypeId=Lavalink_Build&tab=artifacts&branch_Lavalink=refs%2Fheads%2Fdev) and then, click on `Lavalink.jar` files [How to setup](https://github.com/Weeb-Devs/Laffey/blob/main/readme/LAVALINK_INSTALLATION.md) All required OS and other for lavalink server available [here](https://github.com/freyacodes/Lavalink#requirements) ### Server for the bot to run @@ -43,9 +43,9 @@ All required OS and other for lavalink server available [here](https://github.co - Identifier `Name for your node. Default to its url` - Retry amount `retry amount when the node encounted error. Default is 3` - Retry delay `delay for each retry. Default is 1000 (1s)` - - Secure `wether your node use ssl connection. Default is false` + - Secure `wether your node use ssl connection. Default is false` -**Note** +**Note** - Why use ksoft.si API and not other? Because other modules are bad and we have to provide a very specific title which is ksoft.si didn't ## Available music sources: @@ -58,7 +58,7 @@ All required OS and other for lavalink server available [here](https://github.co - spotify - deezer - **Note:** + **Note:** - `*` is depend on your lavalink's configuration ## Configuration & Starting the bot: @@ -90,9 +90,9 @@ All required OS and other for lavalink server available [here](https://github.co } ``` 2. Go to your console, and type `cd "path to laffey's file"` and install all dependencies by typing `npm i` -3. You're ready to go, use `node .` or `npm start` to start the bot +3. You're ready to go, use `node .` or `npm start` to start the bot + - ### With .env
1. Create a `.env` file in the root directory of your project.
2. Copy the text below and paste it in .env file and change the value with required data. **You must use config.json for nodes. So it'll be like this**
@@ -108,7 +108,7 @@ All required OS and other for lavalink server available [here](https://github.co AUTO_RESUME_DELAY=2000 DEBUG=true LOG_USAGE=false - ``` + ``` #### config.json file ```json { @@ -126,169 +126,169 @@ All required OS and other for lavalink server available [here](https://github.co } ``` 3. Go to your console, and type `cd "path to laffey's file"` and install all dependencies by typing `npm i` -4. You're ready to go, use `node .` or `npm start` to start the bot -
+4. You're ready to go, use `node .` or `npm start` to start the bot +
**Note:** - + - `DEBUG` is to see more data when your bot starting and other warning - `LOG_USAGE` is to log all command usage by user. Default to false because it'll be annoying - `AUTO_RESUME_DELAY` is how many ms do you want to add a delay between guild on auto resume

-## Screenshots - +## Screenshots +


## Commands - music - - play `play music from 7 music sources` - -aliases: p - -example: `?play https://www.youtube.com/playlist?list=PL0jh16Vp3NzVjEjKbZ3pV4f15Jze5EANV` - - - forceplay `same like play, but this will force the player to play specific song` - -aliases: fp - -example: `?forceplay https://www.youtube.com/watch?v=dQw4w9WgXcQ` - - - loop `toggle track/queue loop` - -aliases: l - -example: `?loop` - - - lyrics `Get specific/current playing song's lyrics` - -aliases: ly - -example: `?lyrics [ song's title ]` - - - volume `Set player's volume. 0-1000` - -aliases: v - -example: `?volume 1000` - - - nowplaying `see current playing song` - -aliases: np - -example: `?nowplaying` - - - move `Move song` - -aliases: - - -example: `?move 2` | `?move 4 3` - - - queue `check all songs inside queue` - -aliases: q - -example: `?queue` - - - skip `skip the song` - -aliases: s - -example: `?skip` - - - skipto `skip to specific song` - -aliases: st, jump, jumpto - -example: `?skipto 3` - - - join `Join a voice channel` - -aliases: - - -example: `?join` - - - leave `Leave a voice channel` - -aliases: stop - -example: `?leave` - - - shuffle `Shuffle queue` - -aliases: - - -example: `?shuffle` - - - clear `Clear the queue` - -aliases: - - -example: `?clear` - - - bassboost `Set bassboost filter for the player` - -aliases: bb - -example: `?bassboost [reset | 1 - 2000]` - - - 24h `whether the bot to leave vc when there's no user or not` - -aliases: - - -example: `?24h` - - - vaporwave `Set vaporwave filter for the player` - -aliases: - - -example: `?vaporwave` - - - nightcore `Set nightcore filter for the player` - -aliases: nc - -example: `?nightcore` - - - 8d `Set 8d filter for the player` - -aliases: - - -example: `?8d` - - - speed `Set speed for the player` - -aliases: - + - play `play music from 7 music sources` + -aliases: p + -example: `?play https://www.youtube.com/playlist?list=PL0jh16Vp3NzVjEjKbZ3pV4f15Jze5EANV` + + - forceplay `same like play, but this will force the player to play specific song` + -aliases: fp + -example: `?forceplay https://www.youtube.com/watch?v=dQw4w9WgXcQ` + + - loop `toggle track/queue loop` + -aliases: l + -example: `?loop` + + - lyrics `Get specific/current playing song's lyrics` + -aliases: ly + -example: `?lyrics [ song's title ]` + + - volume `Set player's volume. 0-1000` + -aliases: v + -example: `?volume 1000` + + - nowplaying `see current playing song` + -aliases: np + -example: `?nowplaying` + + - move `Move song` + -aliases: - + -example: `?move 2` | `?move 4 3` + + - queue `check all songs inside queue` + -aliases: q + -example: `?queue` + + - skip `skip the song` + -aliases: s + -example: `?skip` + + - skipto `skip to specific song` + -aliases: st, jump, jumpto + -example: `?skipto 3` + + - join `Join a voice channel` + -aliases: - + -example: `?join` + + - leave `Leave a voice channel` + -aliases: stop + -example: `?leave` + + - shuffle `Shuffle queue` + -aliases: - + -example: `?shuffle` + + - clear `Clear the queue` + -aliases: - + -example: `?clear` + + - bassboost `Set bassboost filter for the player` + -aliases: bb + -example: `?bassboost [reset | 1 - 2000]` + + - 24h `whether the bot to leave vc when there's no user or not` + -aliases: - + -example: `?24h` + + - vaporwave `Set vaporwave filter for the player` + -aliases: - + -example: `?vaporwave` + + - nightcore `Set nightcore filter for the player` + -aliases: nc + -example: `?nightcore` + + - 8d `Set 8d filter for the player` + -aliases: - + -example: `?8d` + + - speed `Set speed for the player` + -aliases: - -example: `?speed [reset | 0-5]` - - - pitch `Set pitch for the player` - -aliases: - + + - pitch `Set pitch for the player` + -aliases: - -example: `?pitch [reset | 0-5]` - - - reset `Reset the filters` - -aliases: - + + - reset `Reset the filters` + -aliases: - -example: `?reset` - - - filters `Get all filters status` - -aliases: - + + - filters `Get all filters status` + -aliases: - -example: `?filters` - - - remove `Remove song from queue` - -aliases: - - -example: `?remove 3` - - - previous `Play song that played previously` - -aliases: pr - -example: `?previous` - - - resume `Resume the player` - -aliases: r - -example: `?resume` - - - pause `Pause the player` - -aliases: - - -example: `?pause` + + - remove `Remove song from queue` + -aliases: - + -example: `?remove 3` + + - previous `Play song that played previously` + -aliases: pr + -example: `?previous` + + - resume `Resume the player` + -aliases: r + -example: `?resume` + + - pause `Pause the player` + -aliases: - + -example: `?pause` - config - - prefix `get, set, or reset prefix on guild` - -aliases: - - -example: `?prefix set !` | `?prefix reset` | `?prefix get` + - prefix `get, set, or reset prefix on guild` + -aliases: - + -example: `?prefix set !` | `?prefix reset` | `?prefix get` - misc - - ping `get bot's ping` - -aliases: - - -example: `?ping` + - ping `get bot's ping` + -aliases: - + -example: `?ping` - - help `Show list of available commands` - -aliases: h - -example: `?help play` + - help `Show list of available commands` + -aliases: h + -example: `?help play` - - eval `to evaluate code` - -aliases: - - -example: `?eval message.channel.send('hello')` + - eval `to evaluate code` + -aliases: - + -example: `?eval message.channel.send('hello')` - - about `Give information about this project` - -aliases: - - -example: `?about` + - about `Give information about this project` + -aliases: - + -example: `?about` - - stats `Give bot's stats` - -aliases: - - -example: `?stats adv` + - stats `Give bot's stats` + -aliases: - + -example: `?stats adv` - - node `Give lavalink's stats` - -aliases: - - -example: `?node` + - node `Give lavalink's stats` + -aliases: - + -example: `?node` - - invite `Invite your bot to another guild` - -aliases: - - -example: `?invite` + - invite `Invite your bot to another guild` + -aliases: - + -example: `?invite` ## Description & About -Created at: Friday, 2 April 2021 -Published at: Sunday, 11 April 2021 +Created at: Friday, 2 April 2021 +Published at: Sunday, 11 April 2021 [Laffey](https://github.com/Weeb-Devs/Laffey) is [Weeb-Devs](https://github.com/Weeb-Devs) 's first project. Was created by our first member aka owner, Takiyo. He really wants to make his first open source project ever. Because he wants more for coding experience. In this project, he was challenged to make project with less bugs. Hope you enjoy using Laffey! diff --git a/readme/CREATE_FIRST_BOT.md b/readme/CREATE_FIRST_BOT.md index 6b4d20f..10eae71 100644 --- a/readme/CREATE_FIRST_BOT.md +++ b/readme/CREATE_FIRST_BOT.md @@ -3,30 +3,30 @@ ## Step by step: 1. Go to [Discord Developer Portal](https://discord.com/developers/applications) and you will see all your application(s) - +
2. If you don't have any, click on `New Application` - +
3. Give your new bot with nice name, here's the example and click create - +
4. You will be redirected into page like this. You can rename your bot, change avatar, and more here. - +
5. Now, go into `Bot` section and click `add bot` button. - +
- +
6. Now, your bot was created into discord bot family. You can change the bot into public or not, change the Privileged Gateway Intents, and generate code for bot's permissions - +
7. Now, let us go into OAuth2 section to invite our new bot into guild. - +
8. Check the bot scopes and permission that your bot will need. It depend on what is your bot's function in the future. After that, click on copy. Paste it into your browser and invite it like how you invite other bot and your wild bot will appear - +
-### Found something wrong? Feel free to make a pull request or submitting an issue from this tutorial. Thank you \ No newline at end of file +### Found something wrong? Feel free to make a pull request or submitting an issue from this tutorial. Thank you diff --git a/readme/LAVALINK_INSTALLATION.md b/readme/LAVALINK_INSTALLATION.md index a59d9dd..7050c41 100644 --- a/readme/LAVALINK_INSTALLATION.md +++ b/readme/LAVALINK_INSTALLATION.md @@ -3,37 +3,37 @@ ## Step by Step 1. Go to [Lavalink's Github](https://github.com/freyacodes/Lavalink) and change the branch into dev - +
2. Scroll down and click highlighted ` the CI server ` text. - +
3. If you're asked to login, just search `login by guest` button and click it. 4. Go to lavalink path to see all available branch - +
-5. Click on `refs/heads/dev` in build - +5. Click on `refs/heads/dev` in build +
-6. Search for the latest build. - +6. Search for the latest build. +
-7. Click on artifacts - +7. Click on artifacts +
-8. Click on `Lavalink.jar` file and your download will start automatically - +8. Click on `Lavalink.jar` file and your download will start automatically +
-9. Now, create folder and insert `Lavalink.jar` inside the folder - +9. Now, create folder and insert `Lavalink.jar` inside the folder +
-10. Create a file with `application.yml` by right click, new, and text document, go here to copy the configuration [application.yml](https://github.com/freyacodes/Lavalink/blob/master/LavalinkServer/application.yml.example), and paste it on `application.yml` that you just created. If you don't have [IDE](https://en.wikipedia.org/wiki/Integrated_development_environment) like Visual Studio Code, you might can't open `application.yml` because no apps support it. You can download the `application.yml.example` that is in the link that i gave you, and then rename it from `application.yml.example` to `application.yml` and it will look like this - +10. Create a file with `application.yml` by right click, new, and text document, go here to copy the configuration [application.yml](https://github.com/freyacodes/Lavalink/blob/master/LavalinkServer/application.yml.example), and paste it on `application.yml` that you just created. If you don't have [IDE](https://en.wikipedia.org/wiki/Integrated_development_environment) like Visual Studio Code, you might can't open `application.yml` because no apps support it. You can download the `application.yml.example` that is in the link that i gave you, and then rename it from `application.yml.example` to `application.yml` and it will look like this +
-11. Now open your file into terminal, by typing `cd "path to lavalink's file with yml"` in command prompt or your lovely CMD, type `java -jar Lavalink.jar` and boom, lavalink is now started on `localhost` with `2333` port and `youshallnotpass` password. If you're using VPS, your lavalink will start in your domain or IP with the same port and password - +11. Now open your file into terminal, by typing `cd "path to lavalink's file with yml"` in command prompt or your lovely CMD, type `java -jar Lavalink.jar` and boom, lavalink is now started on `localhost` with `2333` port and `youshallnotpass` password. If you're using VPS, your lavalink will start in your domain or IP with the same port and password +
- +
12. Now, your lavalink server started and you can connect your bot to the server with available [Client](https://github.com/freyacodes/Lavalink#client-libraries). Here's the example node data to connect it with [Laffey](https://github.com/Weeb-Devs/Laffey). ``` @@ -48,6 +48,6 @@ }, ], ``` - + ### Found something wrong? Feel free to make a pull request or submitting an issue from this tutorial. Thank you diff --git a/readme/changelogs/0.1.1.md b/readme/changelogs/0.1.1.md index 25bf2e9..36cdce4 100644 --- a/readme/changelogs/0.1.1.md +++ b/readme/changelogs/0.1.1.md @@ -19,4 +19,4 @@

> ## Note: -> - \ No newline at end of file +> - diff --git a/readme/changelogs/0.1.2.md b/readme/changelogs/0.1.2.md index 58f332f..353e2d3 100644 --- a/readme/changelogs/0.1.2.md +++ b/readme/changelogs/0.1.2.md @@ -20,4 +20,4 @@

> ## Note: -> - \ No newline at end of file +> - diff --git a/readme/changelogs/0.1.3.md b/readme/changelogs/0.1.3.md index c54a688..8ff21ee 100644 --- a/readme/changelogs/0.1.3.md +++ b/readme/changelogs/0.1.3.md @@ -28,4 +28,4 @@

> ## Note: -> - \ No newline at end of file +> -