From 71ee4f24d048060b835fda38dd71be0b1b60848c Mon Sep 17 00:00:00 2001 From: BestGamersH <104428847+BestGamersH@users.noreply.github.com> Date: Thu, 8 Sep 2022 12:53:01 +0530 Subject: [PATCH 1/4] Add files via upload --- README.md | 146 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 146 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..987daa74 --- /dev/null +++ b/README.md @@ -0,0 +1,146 @@ +# Public Bot and Support Server! + + + +[**Invite the Public Version of this Bot**](https://milrato.milrato.dev) So you don't need to host it by yourself or [join my discord Server](https://discord.gg/milrato) to get a custom hosted Bot for you! + + +# Important notes and thank ❤️ +First of all, thanks for using this Source Code, it was and is a ton of work to create and maintain it! +That's why I'm asking everyone to [**donate a little bit of money**](https://donate.milrato.dev) or if that's not possible, then join my [Discord Server](https://discord.gg/milrato)! + +# Installation Guide 🔥 + +## ✅ Hosting Requirements + +
+ Click to expand + + * [nodejs](https://nodejs.org) version 16.6 or higher, i recommend the latest STABLE version + * [python](https://python.org) version 3.8 or higher, to install the database `enmap` (better-sqlite3) + * a VPS would be adviced, so you don't need to keep your pc/laptop/raspi 24/7 online! [click here for a debian setup](https://github.com/Tomato6966/Debian-Cheat-Sheet-Setup/wiki/) + * Check out my Recommended Host: [BERO-HOST](https://bero.milrato.dev) and use code `milrato` for cheap OP VPS (kvm) + * [Click here for a Direct Order Link](https://bero-host.de/server/prepaid-kvm-rootserver-paket-mieten) + +
+ +## 🤖 Bot Requirements + +
+ Click to expand + + 1. Download the [Source Code]() + * either by: `git clone https://github.com/Tomato6966/Multipurpose-discord-bot` + * or by downloading it as a zip from the releases or a branch + +
+ +## 🎶 Music Requirements + +
+ Click to expand + + *To have your Bot able to play music, you need to connect it to a lavalink Station!* + *There are many public ones out there for example lavalink.eu* + An example for a public configuration will be listed down below + + 1. Make sure `Java 11` is installed on your System! + * [Click here for a Download for **Linux**](https://github.com/Tomato6966/Debian-Cheat-Sheet-Setup/wiki/3.5.2-java-11) + * [Click here for a Download for **Windows**](https://downloads.milrato.eu/windows/java/jdk-11.0.11.exe) ​ + 2. Download [Lavalink.jar](https://github.com/freyacodes/Lavalink/releases/download/3.4/Lavalink.jar) + * here is a direct link: https://github.com/freyacodes/Lavalink/releases/download/3.4/Lavalink.jar + * if you are on linux do this: `wget https://github.com/freyacodes/Lavalink/releases/download/3.4/Lavalink.jar` (prep: `apt-get install -y wget`) + 3. Download [application.yml](https://cdn.discordapp.com/attachments/734517910025928765/934084553751015475/application.yml) + * Download my example, it's the configuration for the lavalink.jar file! + 4. Now put application.yml and Lavalink.jar in the same folder and start it + * To start lavalink type: `java -jar Lavalink.jar` + * Make sure to keep your terminal Open! + * If you want to use something like `npm i -g pm2` to host it without keeping your terminal open type: `pm2 start java -- -jar Lavalink.jar` + 5. The settings like **password** in application.yml and **port** must be provided in the `botconfig/config.json` of the Bot + * If you used the default settings, than no adjust ments are needed and it should look like this: + ```json + { + "clientsettings": { + "nodes": [ + { + "host": "localhost", + "port": 2333, + "password": "youshallnotpass" + } + ] + } + } + ``` + 6. You don't want to host your own Lavalink? + * [Here is a list of many free-to-use Lavalink Servers!](https://lavalink.darrennathanael.com/#how2host) + * Or just use something like this: + ```json + { + "clientsettings": { + "nodes": [ + { + "host": "lava.link", + "port": 80, + "password": "Anything for the Password" + } + ] + } + } + ``` + +
+ +## 🤖 Configuration and Starting + +
+ Click to expand + + **NOTE:** *you can do the exact same configuration inside of the `example.env` File, just make sure to rename it to `.env` or use environment variables!* + + 1. Check `🎶 Music Requirements` that you started lavalink / use a valid public lavalink station + 2. Fill in all required data in `./botconfig/config.json` **NOTE:** *If you're on replit.com, it is exposed to everyone!(use .env instead)* + 3. Fill in all required data in the `.json` Files in `./social_log/` (`./social_log/streamconfig.json` & `./social_log/twitter.json`), if you want the SOCIAL LOGS to work! (the key `authToken` in streamconfig is not needed to be filled in!) + 4. You can adjust some settings in the other `./botconfig/*.json` Files, **BUT PLEASE __KEEP__ MY CREDITS & ADS!** This is the only way on how my hard work is "revenued" + 5. Now start the bot by typing opening a cmd in that folder and type: `node index.js` or `npm start` + * If you don't want to keep the terminal open or if you're on linux, check out [pm2 (and my tutorial)](https://github.com/Tomato6966/Debian-Cheat-Sheet-Setup/wiki/4-pm2-tutorial) and type: `pm2 start --name Bot_Name index.js` + +
+ +## ❓ Where to get which Api-Key(s) + +
+ Click to expand + + **NOTE:** *you can do the exact same configuration inside of the `example.env` File, just make sure to rename it to `.env` or use environment variables!* + + 1. `./botconfig/config.json` + * `token` you can get from: [discord-Developers](https://discord.com/developers/applications) + * `memer_api` you can get from: [Meme-Development DC](https://discord.gg/Mc2FudJkgP) + * `spotify.clientSecret` you can get from: [Spotify-Developer](https://developer.spotify.com) + * `spotify.clientID` you can get from: [Spotify-Developer](https://developer.spotify.com) + * `fnbr` is a FNBR token, which you may get from [FNBRO.co](https://fnbr.co/api/docs) (needed for fnshop) + * `fortnitetracker` is a FORTNITE TRACKER token, which you may get from [fortnitetracker.com](https://fortnitetracker.com/site-api) (needed for fnstats) + 2. `./social_log/streamconfig.json` + * `twitch_clientID` you can get from: [Twitch-Developer](https://dev.twitch.tv/docs/api) ([developer-console](https://dev.twitch.tv/console)) + * `twitch_secret` you can get from: [Twitch-Developer](https://dev.twitch.tv/docs/api) ([developer-console](https://dev.twitch.tv/console)) + * `authToken` is not required to be filled in --> will be done automatically + 3. `./social_log/twitter.json` + * `consumer_key` you can get from: [twitter Developers](https://developer.twitter.com) + * `consumer_secret` you can get from: [twitter Developers](https://developer.twitter.com) + * `access_token` you can get from: [twitter Developers](https://developer.twitter.com) + * `access_token_secret` you can get from: [twitter Developers](https://developer.twitter.com) + +
+ + +## SUPPORT ME AND MILRATO DEVELOPMENT + +> You can always Support me by inviting one of my **own Discord Bots** + +[![2021's best Music Bot | Lava Music](https://cdn.discordapp.com/attachments/748533465972080670/817088638780440579/test3.png)](https://lava.milrato.dev) +[![Musicium Music Bot](https://cdn.discordapp.com/attachments/742446682381221938/770055673965707264/test1.png)](https://musicium.musicium.dev) +[![Milrato Multi Bot](https://cdn.discordapp.com/attachments/742446682381221938/770056826724679680/test1.png)](https://milrato.milrato.dev) + +# Credits + +> If consider using this Bot, make sure to credit me! From 75c66ac9241d38f3adb2c9a5ac7f698ac25fd21e Mon Sep 17 00:00:00 2001 From: BestGamersH <104428847+BestGamersH@users.noreply.github.com> Date: Thu, 8 Sep 2022 14:13:21 +0530 Subject: [PATCH 2/4] Update README.md --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 987daa74..7ae16224 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ # Important notes and thank ❤️ First of all, thanks for using this Source Code, it was and is a ton of work to create and maintain it! -That's why I'm asking everyone to [**donate a little bit of money**](https://donate.milrato.dev) or if that's not possible, then join my [Discord Server](https://discord.gg/milrato)! +If you find any errors please create a issue from Here # Installation Guide 🔥 @@ -19,8 +19,6 @@ That's why I'm asking everyone to [**donate a little bit of money**](https://don * [nodejs](https://nodejs.org) version 16.6 or higher, i recommend the latest STABLE version * [python](https://python.org) version 3.8 or higher, to install the database `enmap` (better-sqlite3) * a VPS would be adviced, so you don't need to keep your pc/laptop/raspi 24/7 online! [click here for a debian setup](https://github.com/Tomato6966/Debian-Cheat-Sheet-Setup/wiki/) - * Check out my Recommended Host: [BERO-HOST](https://bero.milrato.dev) and use code `milrato` for cheap OP VPS (kvm) - * [Click here for a Direct Order Link](https://bero-host.de/server/prepaid-kvm-rootserver-paket-mieten) @@ -30,7 +28,7 @@ That's why I'm asking everyone to [**donate a little bit of money**](https://don Click to expand 1. Download the [Source Code]() - * either by: `git clone https://github.com/Tomato6966/Multipurpose-discord-bot` + * either by: `git clone https://github.com/BestGamersH/Aquana-Source-Code` * or by downloading it as a zip from the releases or a branch @@ -133,14 +131,14 @@ That's why I'm asking everyone to [**donate a little bit of money**](https://don -## SUPPORT ME AND MILRATO DEVELOPMENT +## SUPPORT me AND MILRATO DEVELOPMENT -> You can always Support me by inviting one of my **own Discord Bots** +> You can always Support me by inviting one of me **own Discord Bots** -[![2021's best Music Bot | Lava Music](https://cdn.discordapp.com/attachments/748533465972080670/817088638780440579/test3.png)](https://lava.milrato.dev) -[![Musicium Music Bot](https://cdn.discordapp.com/attachments/742446682381221938/770055673965707264/test1.png)](https://musicium.musicium.dev) -[![Milrato Multi Bot](https://cdn.discordapp.com/attachments/742446682381221938/770056826724679680/test1.png)](https://milrato.milrato.dev) +[![2022's best Music Bot | Aquana Music](https://ibb.co/gmp5Rp4)](https://discord.com/api/oauth2/authorize?client_id=1016375106806743041&permissions=8&scope=applications.commands%20bot) +[![Aquana](https://ibb.co/Vx4HV6X)](https://discord.com/api/oauth2/authorize?client_id=1016438776005935144&permissions=8&scope=bot%20applications.commands) # Credits -> If consider using this Bot, make sure to credit me! +> If consider using this Bot, make sure to credit me +> This bot was made by https://github.com/Tomato6966 All credits to him, I just fixed the errors in it didn't code it fully. From 6198a7ed773aa9c0cb512cbe5407a617617fe594 Mon Sep 17 00:00:00 2001 From: BestGamersH <104428847+BestGamersH@users.noreply.github.com> Date: Thu, 8 Sep 2022 14:15:31 +0530 Subject: [PATCH 3/4] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7ae16224..457a72b2 100644 --- a/README.md +++ b/README.md @@ -135,8 +135,8 @@ If you find any errors please create a issue from You can always Support me by inviting one of me **own Discord Bots** -[![2022's best Music Bot | Aquana Music]([https://ibb.co/gmp5Rp4](https://cdn.discordapp.com/attachments/1017354675575599104/1017354736686604338/standard_3.gif))](https://discord.com/api/oauth2/authorize?client_id=1016375106806743041&permissions=8&scope=applications.commands%20bot) +[![2022's best Music Bot | Aquana Music](https://cdn.discordapp.com/attachments/1017354675575599104/1017354736686604338/standard_3.gif)](https://discord.com/api/oauth2/authorize?client_id=1016375106806743041&permissions=8&scope=applications.commands%20bot) [![Aquana](https://cdn.discordapp.com/attachments/1017354675575599104/1017354750758498324/standard_2.gif)](https://discord.com/api/oauth2/authorize?client_id=1016438776005935144&permissions=8&scope=bot%20applications.commands) # Credits