Merge branch 'main' of https://github.com/Gunale0926/KO-ON-Bot

Gunale0926 · Aug 30, 2022 · d1d42b9 · d1d42b9
2 parents 6d93882 + 9000137
commit d1d42b9
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 77 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/.gitignore b/.gitignore
@@ -135,8 +135,7 @@ ffmpeg.exe
 31playlistcache
 31voiceidcache
 5440285076349028_31.mp3
-MiguMusicApi/
-QQMusicApi/
-NeteaseCloudMusicApi/
 webtest.py
 webtest1.py
+
+.DS_Store
diff --git a/MiguMusicApi b/MiguMusicApi
diff --git a/NeteaseCloudMusicApi b/NeteaseCloudMusicApi
diff --git a/QQMusicApi b/QQMusicApi
diff --git a/README.md b/README.md
diff --git a/README.org b/README.org
@@ -0,0 +1,27 @@
+* KO-ON Bot
+A Music Player For kookapp.cn
+** Download
+#+BEGIN_SRC bash
+git clone [email protected]:CarterGunale/KO-ON-Bot.git --recursive
+python3 -m pip install -r KO-ON-Bot/requirements.txt
+#+END_SRC
+** Config
+1. Rename ~config.tmp.json~ to config.json
+2. Fill Keywords with value
+   - ~token*~: KOOK Bot token for bot *
+   - ~join_command*~ (Optional): Triger for Bot *
+   - ~default_platform*~ (Optional): Default Platform for Bot *
+   - ~n_*~: configs for Netease Music
+   - ~b_*~: configs for Bilibili
+   - ~qq_enable~: "1" or "0"
+   - ~q_*~: configs for QQ Music
+   - ~schedule_*~: configs for scheduler(refer to the template)
+** Run the BOT
+*** Windows
+#+BEGIN_SRC bash
+start /main run.bat
+#+END_SRC
+*** Linux & macOS
+#+BEGIN_SRC bash
+sh run.sh
+#+END_SRC