From 1bddae2f04e9855835dc92bcc97e99970c9e7ded Mon Sep 17 00:00:00 2001
From: lolcat <will@lolcat.ca>
Date: Sun, 4 Sep 2022 20:50:23 -0400
Subject: [PATCH] stupid readme

---
 readme.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..d3d2481
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,59 @@
+# Rena Mumble
+Welcome to the **only** working music bot for mumble (as of writing)! I made this cause the other scripts on github weren't working anymore, so here it is!
+
+## Features
+- NO web interface (who needs that shit?)
+- It works, unlike the 45 other alternatives out there
+
+## Installation
+Okay, bare with me, I SWEAR this bot won't fail to install halfway trough.
+
+First, make sure you install nodejs v.12.22.12 (or later) and npm 8.19.1 (or later!).
+If your package manager doesn't give a recent enough version of nodejs, install it from here: https://nodejs.org/en/
+
+From there, npm should be installed I think, if its not just install it trough your package manager and run `sudo npm install -g npm` to install the latest version.
+
+Then, run these commands one by one:
+```
+sudo apt install ffmpeg git
+git clone <this repo>.git
+cd <the repo>
+npm install noodle.js ytdl-core ytsr node-fetch@2 sharp
+```
+Then, create a private key and certificate using the following command:
+```
+openssl req -x509 -newkey rsa:2048 -nodes -keyout key.pem -out cert.pem
+```
+This should create a key.pem and cert.pem file. Place those at the root of the project. Then, edit the rena.conf file to your liking!!
+
+## Start the thing
+```
+nodejs bot.js
+```
+
+## Q&A
+**Q: Sometimes, it just skips the video right away! What the fuck!!!!**
+
+Check if your serber is blocked from youtube. The video you requested might also be age restricted, a livestream, or something else happened that makes streaming the video impossible.
+
+**Q: Will, you lied to me nothing fucking works!!**
+
+It's probably cause the youtube downloader script is fucked. Try updating it periodically with
+```
+Run npm install ytdl-core@latest
+Run npm install ytsr@latest
+``` 
+
+**Q: What are the commands???**
+
+Make sure you're located in the same channel as the bot and type `.help`. It should be smooth sailing from there!
+
+**Q: I found a bug or a missing feature!**
+
+Contact me: https://lolcat.ca/contact/
+
+## Try it out
+Theres a live instance of it running (hopefully) at mumble://lolcat.ca:64738 inside the music channel.
+
+## License
+MIT