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 --- wacca/aquadx/README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 wacca/aquadx/README.md (limited to 'wacca') 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