From c0afca9f95b78e6370b389999112f47fc7ad13e2 Mon Sep 17 00:00:00 2001 From: Pinapelz Date: Wed, 2 Apr 2025 05:54:36 -0700 Subject: add improve README for aquadx stuff --- chuni/aquadx/README.md | 26 ++++++++++++++++++++++++-- mai2/aquadx/README.md | 30 +++++++++++++++++++++++++++--- ongeki/aquadx/README.md | 32 +++++++++++++++++++++++++------- wacca/aquadx/README.md | 29 +++++++++++++++++++++++++++++ 4 files changed, 105 insertions(+), 12 deletions(-) create mode 100644 wacca/aquadx/README.md diff --git a/chuni/aquadx/README.md b/chuni/aquadx/README.md index a4c0c68..5150231 100644 --- a/chuni/aquadx/README.md +++ b/chuni/aquadx/README.md @@ -1,3 +1,25 @@ -This is for CHUNITHM NEW and beyond +CHUNITHM NEW and beyond. Both self-hosted and the primary AquaDX server is supported: -`chuni_aquadx_to_tachi.py` - Exports using data from AquaNet Web UI functionality. Does not require direct access to DB +# 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` | + +> [!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** 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** diff --git a/ongeki/aquadx/README.md b/ongeki/aquadx/README.md index 8c3d9c3..60dce7e 100644 --- a/ongeki/aquadx/README.md +++ b/ongeki/aquadx/README.md @@ -1,10 +1,28 @@ -AquaDX currently does not have a built-in export function. If you are playing on the publicly hosted ver the best way to get some scores for now is to scrape your recent plays: +O.N.G.E.K.I Both self-hosted and the primary AquaDX server is supported: +Please note currently all scores are set as DX variant of scores. -**No access to DB (playing on a hosted version):** -- Go to ONGEKI player page -- `CTRL + SHIFT + I`-> Open Network tab -- Find URL for request made to `/aqua/api/v2/game/ongeki` -- Download the JSON and use this as your input +# Arguments -The script should grab the latest all-music.json. But in case it doesn't, a potentially outdated backup has been included +| 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** diff --git a/wacca/aquadx/README.md b/wacca/aquadx/README.md new file mode 100644 index 0000000..86c55e9 --- /dev/null +++ b/wacca/aquadx/README.md @@ -0,0 +1,29 @@ +WACCA. Both self-hosted and the primary AquaDX server is supported: + +> [!IMPORTANT] +> Since there is no export for player data yet, this script can only grab your RECENT plays + +# 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** -- cgit v1.2.3