diff options
| author | Pinapelz <yukais@pinapelz.com> | 2025-04-02 05:54:36 -0700 |
|---|---|---|
| committer | Pinapelz <yukais@pinapelz.com> | 2025-04-02 05:54:36 -0700 |
| commit | c0afca9f95b78e6370b389999112f47fc7ad13e2 (patch) | |
| tree | c82803804baa494798dff6f5344af8f6099773e5 /mai2/aquadx/README.md | |
| parent | 550053e5ebeadba457efeee6faf2b5589caef625 (diff) | |
add improve README for aquadx stuff
Diffstat (limited to 'mai2/aquadx/README.md')
| -rw-r--r-- | mai2/aquadx/README.md | 30 |
1 files changed, 27 insertions, 3 deletions
diff --git a/mai2/aquadx/README.md b/mai2/aquadx/README.md index 51152c5..9348f80 100644 --- a/mai2/aquadx/README.md +++ b/mai2/aquadx/README.md @@ -1,4 +1,28 @@ -This is for maimai DX +maimai DX. Both self-hosted and the primary AquaDX server is supported: -`mai_aquadx_to_tachi.py` - Exports using data from AquaNet Web UI functionality. Does not require direct access to DB -- Requries AquaDX music file, it should grab the latest one from AquaNet but if it does not there is a backup included as `all-music.json` +Please note currently all scores are set as DX variant of scores. + +# Arguments + +| Argument | Short | Description | Default | +|:-----------:|:----:|:---------------------------------------------------------------------------------------------------------------:|:--------------------------:| +| `--file` | `-f` | Specify the path to the playdata JSON file exported from AquaDX. Expected to be in the format of AquaNet CHUNITHM export | — | +| `--service` | `-s` | Service description to be shown on Tachi (Note for where this score came from). | `AquaDX Chuni Import` | +| `--token` | `-t` | Use your AquaNet Token to grab your play data directly from the API. Get it from the browser's Network tab. | — | +| `--url` | `-u` | AquaNet API endpoint. No need to change this unless you self-host AquaDX. The full URL before `/api` is expected | `https://aquadx.net/aqua` | +| `--output` | `-o` | Output filename. | `aquadx_chuni_tachi.json` | +| `--music` | `-m` | Music file containing map of song ids to song titles. Usually not needed to be specified as script will grab the latest from AquaDX | `online` | + +> [!IMPORTANT] +> You only need to specify either `--file` or `--token`/`--url` + +# How to get token? +1. Go to AquaDX +2. CTRL+SHIFT+I (Open Dev Tools panel) +3. Go to Network tab +4. Refresh the page with the Dev Tools Panel Open +5. Search for `/api/v2` +6. Click on any of the requests and check the url. There will be a part of the url that starts with `token=` +7. Copy everything after the `=` up until either the end of the URL or the next `&` + +**DO NOT SHARE THIS TOKEN WITH OTHER PEOPLE** |