docs: add README.md

README.md

@@ -0,0 +1,65 @@
+# AppleMusicDecrypt
+
+Apple Music decryption tool, based on [zhaarey/apple-music-alac-atmos-downloader](https://github.com/zhaarey/apple-music-alac-atmos-downloader)
+
+**WARNING: This project is currently in an extremely early stage, and there are still a large number of undiscovered bugs and unfinished features. USE IT WITH CAUTION.**
+
+# Usage
+```shell
+# Download song/album with default codec (alac)
+download https://music.apple.com/jp/album/nameless-name-single/1688539265
+# Download song/album with specified codec
+download https://music.apple.com/jp/song/caribbean-blue/339592231 -c aac
+```
+
+# Support Codec
+
+- `alac`
+- `ec3`
+- `aac`
+- `aac-binaural`
+- `aad-downmix`
+
+# Support Link
+- Apple Music Song Share Link (https://music.apple.com/jp/album/%E5%90%8D%E3%82%82%E3%81%AA%E3%81%8D%E4%BD%95%E3%82%82%E3%81%8B%E3%82%82/1688539265?i=1688539274)
+- Apple Music Album Share Link (https://music.apple.com/jp/album/nameless-name-single/1688539265)
+- Apple Music Song Link (https://music.apple.com/jp/song/caribbean-blue/339592231)
+
+# Deploy
+## Prepare Local Environment
+1. Install [GPAC](https://gpac.io/downloads/gpac-nightly-builds/)
+2. Download [Bento4 MP4Tools](https://www.bento4.com/downloads/) and add the executable files to the environment variables
+3. Run `gpac -version`, `mp4box -version`, `mp4extract`, `mp4edit` and make sure all the commands run fine
+## Prepare Android Environment
+### For WSA (Recommend):
+1. Install Apple Music (3.6.0-beta) and login
+2. Install WSA from [LSPosed/MagiskOnWSALocal](https://github.com/LSPosed/MagiskOnWSALocal). Choose the version that includes Magisk but not GApps
+3. Install following Magisk modules: [magisk-frida](https://github.com/ViRb3/magisk-frida), [sqlite3-magisk-module](https://github.com/rojenzaman/sqlite3-magisk-module)
+4. Edit `config.toml`
+```toml
+[[devices]]
+host = "127.0.0.1"
+port = 58526 # Replace this value to your WSA ADB port!
+agentPort = 10020
+fridaPath = "/system/bin/frida-server"
+suMethod = "su -c"
+```
+### For Google Android Emulator
+1. Install Apple Music (3.6.0-beta) and login
+2. Manually install Frida and start frida-server in background
+3. Edit `config.toml`
+```toml
+[[devices]]
+host = "127.0.0.1"
+port = 5555
+agentPort = 10020
+fridaPath = "/data/local/tmp/frida-server-16.2.1-android-x86_64"  # Replace this value to your frida-server path!
+suMethod = "su 0"
+```
+## Run Script
+```shell
+git clone https://github.com/WorldObservationLog/AppleMusicDecrypt.git
+cd AppleMusicDecrypt
+poetry install
+poetry run python main.py
+```