aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author吳俊翰2023-05-04 17:45:58 +0800
committerGitHub2023-05-04 17:45:58 +0800
commitc600671b4235e57db7e2aa95fc99b4f5cbd46cec (patch)
tree2e0c7c907263f89dd4a6610e51eed4df701ffe2f /README.md
parent4e1e3ea8bdb25de41671c3c600070d88b7dd146b (diff)
Add files via upload
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 29 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1944f40..ae684d1 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,29 @@
-# arknights_ost_crawler \ No newline at end of file
+Tested on Ubuntu and Python 3
+
+
+A simple script to download all your favorite Arknights OSTs from monster-siren.hypergryph.com
+
+Download all songs, albums and fill out metadata, album, cover art, artists and even lyrics
+
+### Note:
+
+The API offers .mp3 and .wav, but the program convert .wav to .flac since .wav can't do metadata.
+
+### Requirements:
+
+Python
+
+ffmpeg
+
+```pip3 install -r requirements.txt``` or ```pip install -r requirements.txt```
+
+### Runs:
+
+```python3 main.py``` or ```python main.py```
+
+### Video instructions:
+https://drive.google.com/file/d/1Kzcn3GazpE9MHtzlkgJB3L0DtvsHK88M/view?usp=sharing
+
+
+![image](https://user-images.githubusercontent.com/80285371/207703442-a96488bc-5642-4d7b-92da-f0ac976e944b.png)
+![image](https://user-images.githubusercontent.com/80285371/207703484-2271b5a1-7928-401d-9bed-a5e4feeec4d0.png)