diff --git a/docs/autogen-scripts/package.json b/docs/autogen-scripts/package.json index 760c3e56c..248f094f9 100644 --- a/docs/autogen-scripts/package.json +++ b/docs/autogen-scripts/package.json @@ -3,7 +3,9 @@ "private": true, "version": "1.0.0", "description": "Scripts for automatically generating Tachi documentation.", - "scripts": {}, + "scripts": { + "run": "ts-node src/main.ts" + }, "keywords": [], "author": "zkldi", "license": "MIT", @@ -14,4 +16,4 @@ "commander": "^10.0.0", "tachi-common": "workspace:../../common" } -} +} \ No newline at end of file diff --git a/docs/autogen-scripts/src/config.ts b/docs/autogen-scripts/src/main.ts similarity index 97% rename from docs/autogen-scripts/src/config.ts rename to docs/autogen-scripts/src/main.ts index cf89226f9..8fbbcd39d 100644 --- a/docs/autogen-scripts/src/config.ts +++ b/docs/autogen-scripts/src/main.ts @@ -1,3 +1,4 @@ +/* eslint-disable no-console */ /* eslint-disable operator-assignment */ // Generate documentation for all GPT configs in-tree. @@ -198,5 +199,6 @@ for (const game of allSupportedGames) { } } -console.log("Done! Paste this config into your mkdocs.yml."); +console.error("Done! Paste this config into your mkdocs.yml."); + console.log(mkdocsConf); diff --git a/docs/docs/game-support/games/arcaea-Touch.md b/docs/docs/game-support/games/arcaea-Touch.md index 77b1edfb6..a0f76ae5d 100644 --- a/docs/docs/game-support/games/arcaea-Touch.md +++ b/docs/docs/game-support/games/arcaea-Touch.md @@ -1,4 +1,4 @@ -# Arcaea support +# Arcaea Support This game has the internal GPTString of `arcaea:Touch`. @@ -13,7 +13,7 @@ For more information on what metrics are and how they work, see [TODO]! | Metric Name | Type | Description | | :: | :: | :: | -| `score` | Integer | The score value. This is between 0 and 10 million, plus one point for each note. | +| `score` | Integer | The score value. This is between 0 and 10 million, plus bonus points dependent on how many shiny PUREs you get. | | `lamp` | "LOST", "EASY CLEAR", "CLEAR", "HARD CLEAR", "FULL RECALL", "PURE MEMORY" | The type of clear this was. | ### Derived Metrics @@ -44,7 +44,7 @@ The folowing judgements are defined: | Name | Description | | :: | :: | -| `potential` | The potential value of this score. The same as the system used in game. | +| `potential` | Potential as it is implemented in Arcaea. | ### Session Rating Algorithms @@ -56,7 +56,7 @@ The folowing judgements are defined: | Name | Description | | :: | :: | -| `naivePotential` | The average of your best 30 potentials. This is different to in-game, as it does not take into account your recent scores in any way. | +| `naivePotential` | The average of your best 30 potential values. This is different to in-game, as it does not take into account your recent scores in any way. | ## Difficulties @@ -69,8 +69,8 @@ The folowing judgements are defined: | Name | Type | Values | | :: | :: | :: | -| `badge` | DERIVED | BLUE, GREEN, ASH_PURPLE, PURPLE, RED, ONE_STAR, TWO_STARS, THREE_STARS | -| `courseBanner` | PROVIDED | PHASE_1, PHASE_2, PHASE_3, PHASE_4, PHASE_5, PHASE_6, PHASE_7, PHASE_8, PHASE_9, PHASE_10, PHASE_11 | +| `badge` | DERIVED | BLUE, GREEN, ASH_PURPLE, PURPLE, RED, ONE_STAR, TWO_STARS, THREE_STARS +| `courseBanner` | PROVIDED | PHASE_1, PHASE_2, PHASE_3, PHASE_4, PHASE_5, PHASE_6, PHASE_7, PHASE_8, PHASE_9, PHASE_10, PHASE_11 ## Versions @@ -81,6 +81,6 @@ The folowing judgements are defined: ## Supported Match Types -- `inGameID` +- `inGameStrID` - `songTitle` -- `tachiSongID` +- `tachiSongID` \ No newline at end of file diff --git a/docs/docs/game-support/games/bms-7K.md b/docs/docs/game-support/games/bms-7K.md index 77f6a5100..06d03348a 100644 --- a/docs/docs/game-support/games/bms-7K.md +++ b/docs/docs/game-support/games/bms-7K.md @@ -83,8 +83,8 @@ The folowing judgements are defined: | Name | Type | Values | | :: | :: | :: | | `genocideDan` | PROVIDED | NORMAL_1, NORMAL_2, NORMAL_3, NORMAL_4, NORMAL_5, NORMAL_6, NORMAL_7, NORMAL_8, NORMAL_9, NORMAL_10, INSANE_1, INSANE_2, INSANE_3, INSANE_4, INSANE_5, INSANE_6, INSANE_7, INSANE_8, INSANE_9, INSANE_10, INSANE_KAIDEN, OVERJOY -| `newGenerationDan` | PROVIDED | NORMAL_1, NORMAL_2, NORMAL_3, NORMAL_4, NORMAL_5, NORMAL_6, NORMAL_7, NORMAL_8, NORMAL_9, NORMAL_10, INSANE_0, INSANE_1, INSANE_2, INSANE_3, INSANE_4, INSANE_5, INSANE_6, INSANE_7, INSANE_8, INSANE_9, INSANE_10, INSANE_KAIDEN | `stslDan` | PROVIDED | SL0, SL1, SL2, SL3, SL4, SL5, SL6, SL7, SL8, SL9, SL10, SL11, SL12, ST0, ST1, ST2, ST3, ST4, ST5, ST6, ST7, ST8, ST9, ST10, ST11 +| `newGenerationDan` | PROVIDED | NORMAL_1, NORMAL_2, NORMAL_3, NORMAL_4, NORMAL_5, NORMAL_6, NORMAL_7, NORMAL_8, NORMAL_9, NORMAL_10, INSANE_0, INSANE_1, INSANE_2, INSANE_3, INSANE_4, INSANE_5, INSANE_6, INSANE_7, INSANE_8, INSANE_9, INSANE_10, INSANE_KAIDEN | `lnDan` | PROVIDED | DAN_1, DAN_2, DAN_3, DAN_4, DAN_5, DAN_6, DAN_7, DAN_8, DAN_9, DAN_10, KAIDEN, OVERJOY, UDON | `scratchDan` | PROVIDED | KYU_7, KYU_6, KYU_5, KYU_4, KYU_3, KYU_2, KYU_1, DAN_1, DAN_2, DAN_3, DAN_4, DAN_5, DAN_6, DAN_7, DAN_8, DAN_9, DAN_10, KAIDEN diff --git a/docs/docs/game-support/games/chunithm-Single.md b/docs/docs/game-support/games/chunithm-Single.md index 08413c330..286510e9b 100644 --- a/docs/docs/game-support/games/chunithm-Single.md +++ b/docs/docs/game-support/games/chunithm-Single.md @@ -65,22 +65,33 @@ The folowing judgements are defined: - `ADVANCED` - `EXPERT` - `MASTER` +- `ULTIMA` ## Classes | Name | Type | Values | | :: | :: | :: | -| `colour` | DERIVED | BLUE, GREEN, ORANGE, RED, PURPLE, COPPER, SILVER, GOLD, PLATINUM, RAINBOW | +| `colour` | DERIVED | BLUE, GREEN, ORANGE, RED, PURPLE, COPPER, SILVER, GOLD, PLATINUM, RAINBOW +| `dan` | PROVIDED | DAN_I, DAN_II, DAN_III, DAN_IV, DAN_V, DAN_INFINITE +| `emblem` | PROVIDED | DAN_I, DAN_II, DAN_III, DAN_IV, DAN_V, DAN_INFINITE ## Versions | ID | Pretty Name | | :: | :: | -| `paradiselost` | Paradise Lost | +| `paradiselost` | PARADISE LOST | | `sun` | SUN | +| `sun-intl` | SUN International | +| `sun-omni` | SUN Omnimix | +| `sunplus` | SUN PLUS | +| `sunplus-intl` | SUN PLUS International | +| `sunplus-omni` | SUN PLUS Omnimix | +| `luminous` | LUMINOUS | +| `luminous-intl` | LUMINOUS International | +| `luminous-omni` | LUMINOUS Omnimix | ## Supported Match Types - `inGameID` - `songTitle` -- `tachiSongID` +- `tachiSongID` \ No newline at end of file diff --git a/docs/docs/game-support/games/gitadora-Dora.md b/docs/docs/game-support/games/gitadora-Dora.md index 36369b676..b43afbff5 100644 --- a/docs/docs/game-support/games/gitadora-Dora.md +++ b/docs/docs/game-support/games/gitadora-Dora.md @@ -56,8 +56,6 @@ The folowing judgements are defined: ### Profile Rating Algorithms -The default rating algorithm is `skill`. - | Name | Description | | :: | :: | | `naiveSkill` | Your best 50 skill levels added together, regardless of whether the chart is HOT or not. | diff --git a/docs/docs/game-support/games/gitadora-Gita.md b/docs/docs/game-support/games/gitadora-Gita.md index 3a5148f8d..d78dc6a08 100644 --- a/docs/docs/game-support/games/gitadora-Gita.md +++ b/docs/docs/game-support/games/gitadora-Gita.md @@ -56,8 +56,6 @@ The folowing judgements are defined: ### Profile Rating Algorithms -The default rating algorithm is `skill`. - | Name | Description | | :: | :: | | `naiveSkill` | Your best 50 skill levels added together, regardless of whether the chart is HOT or not. | diff --git a/docs/docs/game-support/games/iidx-DP.md b/docs/docs/game-support/games/iidx-DP.md index 7f9d81672..548e68580 100644 --- a/docs/docs/game-support/games/iidx-DP.md +++ b/docs/docs/game-support/games/iidx-DP.md @@ -34,6 +34,7 @@ For more information on what metrics are and how they work, see [TODO]! | `gauge` | Decimal | The life in percent (between 0 and 100) that was on the gauge at the end of the chart. | | `comboBreak` | Integer | The amount of times combo was broken. | | `gaugeHistory` | Array<Decimal \| null > | A snapshot of the gauge percent throughout the chart. The values should be null from the point the user dies until the end of the chart. | +| `scoreHistory` | Array<Decimal \| null > | A snapshot of the user's ghost throughout the chart. The values may be null. | | `gsmEasy` | Array<Decimal \| null > | If GSM is used, this stores the easy gauge history. | | `gsmNormal` | Array<Decimal \| null > | If GSM is used, this stores the normal gauge history. | | `gsmHard` | Array<Decimal \| null > | If GSM is used, this stores the hard gauge history. | @@ -118,7 +119,7 @@ The default rating algorithm is `ktLampRating`. | `28` | BISTROVER | | `29` | CastHour | | `30` | Resident | -| `31` | EPOLIS | +| `31` | Epolis | | `3-cs` | 3rd Style CS | | `4-cs` | 4th Style CS | | `5-cs` | 5th Style CS | diff --git a/docs/docs/game-support/games/iidx-SP.md b/docs/docs/game-support/games/iidx-SP.md index cd11c8fdd..862538287 100644 --- a/docs/docs/game-support/games/iidx-SP.md +++ b/docs/docs/game-support/games/iidx-SP.md @@ -34,6 +34,7 @@ For more information on what metrics are and how they work, see [TODO]! | `gauge` | Decimal | The life in percent (between 0 and 100) that was on the gauge at the end of the chart. | | `comboBreak` | Integer | The amount of times combo was broken. | | `gaugeHistory` | Array<Decimal \| null > | A snapshot of the gauge percent throughout the chart. The values should be null from the point the user dies until the end of the chart. | +| `scoreHistory` | Array<Decimal \| null > | A snapshot of the user's ghost throughout the chart. The values may be null. | | `gsmEasy` | Array<Decimal \| null > | If GSM is used, this stores the easy gauge history. | | `gsmNormal` | Array<Decimal \| null > | If GSM is used, this stores the normal gauge history. | | `gsmHard` | Array<Decimal \| null > | If GSM is used, this stores the hard gauge history. | @@ -118,7 +119,7 @@ The default rating algorithm is `ktLampRating`. | `28` | BISTROVER | | `29` | CastHour | | `30` | Resident | -| `31` | EPOLIS | +| `31` | Epolis | | `3-cs` | 3rd Style CS | | `4-cs` | 4th Style CS | | `5-cs` | 5th Style CS | diff --git a/docs/docs/game-support/games/jubeat-Single.md b/docs/docs/game-support/games/jubeat-Single.md index 235978d4e..31c1cdd1b 100644 --- a/docs/docs/game-support/games/jubeat-Single.md +++ b/docs/docs/game-support/games/jubeat-Single.md @@ -30,6 +30,7 @@ For more information on what metrics are and how they work, see [TODO]! | `fast` | Integer | The amount of mistakes in this score that were a result of hitting early. | | `slow` | Integer | The amount of mistakes in this score that were a result of hitting late. | | `maxCombo` | Integer | The largest combo in this score. | +| `musicBar` | Array<Decimal> | A snapshot of how well the player did in each part of the song | ## Judgements @@ -92,6 +93,7 @@ The default rating algorithm is `jubility`. | `qubell` | Qubell | | `clan` | clan | | `festo` | festo | +| `festo-omni` | festo Omnimix | | `ave` | Ave. | ## Supported Match Types diff --git a/docs/docs/game-support/games/maimai-Single.md b/docs/docs/game-support/games/maimai-Single.md index cb7435468..35e2df8be 100644 --- a/docs/docs/game-support/games/maimai-Single.md +++ b/docs/docs/game-support/games/maimai-Single.md @@ -1,4 +1,4 @@ -# maimai DX Support +# maimai Support This game has the internal GPTString of `maimai:Single`. @@ -13,14 +13,14 @@ For more information on what metrics are and how they work, see [TODO]! | Metric Name | Type | Description | | :: | :: | :: | -| `percent` | Decimal | The percent this score was worth. Sometimes called 'rate' in game. This is between 0 and 104 (upper bound, each chart has its own maximum percent) | +| `percent` | Decimal | The percent this score was worth. Sometimes called 'rate' in game. This is upper-bounded by how many BREAK notes the chart has. | | `lamp` | "FAILED", "CLEAR", "FULL COMBO", "ALL PERFECT", "ALL PERFECT+" | The type of clear this score was. | ### Derived Metrics | Metric Name | Type | Description | | :: | :: | :: | -| `grade` | "D", "C", "B", "A", "AA", "AAA", "S", "S+", "SS", "SS+", "SSS", "SSS+" | The grade this score was. | +| `grade` | "F", "E", "D", "C", "B", "A", "AA", "AAA", "S", "S+", "SS", "SS+", "SSS", "SSS+" | The grade this score was. | ### Optional Metrics @@ -55,14 +55,13 @@ The folowing judgements are defined: ### Profile Rating Algorithms -The default rating algorithm is `naiveRate`. - | Name | Description | | :: | :: | | `naiveRate` | An average of your 30 best ratings. This is different from the rating in-game, as that is song-based and takes into account recent scores. | ## Difficulties +- `Easy` - `Basic` - `Advanced` - `Expert` @@ -86,3 +85,5 @@ The default rating algorithm is `naiveRate`. - `songTitle` - `tachiSongID` +- `inGameID` +- `inGameStrID` \ No newline at end of file diff --git a/docs/docs/game-support/games/maimaidx-Single.md b/docs/docs/game-support/games/maimaidx-Single.md index f204a1163..bb08d9e3a 100644 --- a/docs/docs/game-support/games/maimaidx-Single.md +++ b/docs/docs/game-support/games/maimaidx-Single.md @@ -56,12 +56,9 @@ The folowing judgements are defined: ### Profile Rating Algorithms -The default rating algorithm is `naiveRate`. - | Name | Description | | :: | :: | | `naiveRate` | A naive rating algorithm that just sums your 50 best scores. | -| `rate` | Rating as it's implemented in game, taking 15 scores from the latest version and 35 from all old versions. | ## Difficulties @@ -82,6 +79,7 @@ The default rating algorithm is `naiveRate`. | :: | :: | :: | | `colour` | DERIVED | WHITE, BLUE, GREEN, YELLOW, RED, PURPLE, BRONZE, SILVER, GOLD, PLATINUM, RAINBOW | `dan` | PROVIDED | DAN_1, DAN_2, DAN_3, DAN_4, DAN_5, DAN_6, DAN_7, DAN_8, DAN_9, DAN_10, SHINDAN_1, SHINDAN_2, SHINDAN_3, SHINDAN_4, SHINDAN_5, SHINDAN_6, SHINDAN_7, SHINDAN_8, SHINDAN_9, SHINDAN_10, SHINKAIDEN, URAKAIDEN +| `matchingClass` | PROVIDED | B5, B4, B3, B2, B1, A5, A5, A4, A3, A2, A1, S5, S4, S3, S2, S1, SS5, SS4, SS3, SS2, SS1, SSS5, SSS4, SSS3, SSS2, SSS1, LEGEND ## Versions @@ -90,8 +88,9 @@ The default rating algorithm is `naiveRate`. | `universeplus` | UNiVERSE PLUS | | `festival` | FESTiVAL | | `festivalplus` | FESTiVAL PLUS | +| `buddies` | BUDDiES | ## Supported Match Types - `songTitle` -- `tachiSongID` +- `tachiSongID` \ No newline at end of file diff --git a/docs/docs/game-support/games/ongeki-Single.md b/docs/docs/game-support/games/ongeki-Single.md index 4c5faff46..2131e42f4 100644 --- a/docs/docs/game-support/games/ongeki-Single.md +++ b/docs/docs/game-support/games/ongeki-Single.md @@ -14,8 +14,8 @@ For more information on what metrics are and how they work, see [TODO]! | Metric Name | Type | Description | | :: | :: | :: | | `score` | Integer | Known in-game as 'Technical Score'. It ranges between 0 and 1,010,000, where notes are worth 950,000, and bells 60,000. | -| `noteLamp` | "LOSS", "CLEAR", "FULL COMBO", "ALL BREAK" | The first lamp. A clear is either a draw or a win. | -| `bellLamp` | "FULL BELL" | The second lamp that tracks whether all bells in the chart have been collected. | +| `noteLamp` | "LOSS", "CLEAR", "FULL COMBO", "ALL BREAK" | The primary lamp. A clear is either a draw or a win. | +| `bellLamp` | "NONE", "FULL BELL" | Tracks whether all bells in the chart have been collected. | ### Derived Metrics @@ -27,11 +27,12 @@ For more information on what metrics are and how they work, see [TODO]! | Metric Name | Type | Description | | :: | :: | :: | -| `fast` | Integer | The number of mistakes in this score that were a result of hitting early. | -| `slow` | Integer | The number of mistakes in this score that were a result of hitting late. | +| `fast` | Integer | The amount of mistakes in this score that were a result of hitting early. | +| `slow` | Integer | The amount of mistakes in this score that were a result of hitting late. | | `maxCombo` | Integer | The largest combo in this score. | -| `bellCount` | Integer | The numer of bells collected. | | `damage` | Integer | The number of damage ticks received. | +| `bellCount` | Integer | The number of bells collected. | +| `totalBellCount` | Integer | The total number of bells. | | `platScore` | Integer | The Platinum Score value. Only exists in MASTER and LUNATIC charts. | ## Judgements @@ -43,8 +44,6 @@ The folowing judgements are defined: - `hit` - `miss` -Note: `pbreak`s are not tracked separately but can be deduced from `platScore`. - ## Rating Algorithms ### Score Rating Algorithms @@ -63,7 +62,7 @@ Note: `pbreak`s are not tracked separately but can be deduced from `platScore`. | Name | Description | | :: | :: | -| `naiveRating` | The average of your best 45 ratings. | +| `naiveRating` | The average of your best 45 scores. | ## Difficulties @@ -73,22 +72,21 @@ Note: `pbreak`s are not tracked separately but can be deduced from `platScore`. - `MASTER` - `LUNATIC` -Note: since bright MEMORY Act.3, "crazy" charts and "Re:MASTER" charts are in separate folders, but both ought to be tracked as LUNATIC. - ## Classes | Name | Type | Values | | :: | :: | :: | -| `colour` | DERIVED | BLUE, GREEN, ORANGE, RED, PURPLE, COPPER, SILVER, GOLD, PLATINUM, RAINBOW | +| `colour` | DERIVED | BLUE, GREEN, ORANGE, RED, PURPLE, COPPER, SILVER, GOLD, PLATINUM, RAINBOW ## Versions | ID | Pretty Name | | :: | :: | -| `brightMemory3` | bright MEMORY Act.3 | +| `brightMemory3` | bright MEMORY Act.III | +| `brightMemory3Omni` | bright MEMORY Act.III Omnimix | ## Supported Match Types - `songTitle` - `tachiSongID` - +- `inGameID` \ No newline at end of file diff --git a/docs/docs/game-support/games/usc-Keyboard.md b/docs/docs/game-support/games/usc-Keyboard.md index fa209d38f..de5a7a7d1 100644 --- a/docs/docs/game-support/games/usc-Keyboard.md +++ b/docs/docs/game-support/games/usc-Keyboard.md @@ -1,4 +1,4 @@ -# USC (Keyboard) Support +# USC (Keyboard/Other) Support This game has the internal GPTString of `usc:Keyboard`. diff --git a/docs/docs/game-support/games/wacca-Single.md b/docs/docs/game-support/games/wacca-Single.md index 8320289a8..0375e6d91 100644 --- a/docs/docs/game-support/games/wacca-Single.md +++ b/docs/docs/game-support/games/wacca-Single.md @@ -55,12 +55,9 @@ The folowing judgements are defined: ### Profile Rating Algorithms -The default rating algorithm is `naiveRate`. - | Name | Description | | :: | :: | | `naiveRate` | A naive rating algorithm that just sums your 50 best scores. | -| `rate` | Rating as it's implemented in game, taking 15 scores from the latest version and 35 from all old versions. | ## Difficulties diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index a2f811055..dea356b9b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -66,6 +66,7 @@ nav: - "game-support/games/gitadora-Gita.md" - "game-support/games/gitadora-Dora.md" - "game-support/games/jubeat-Single.md" + - "game-support/games/maimai-Single.md" - "game-support/games/maimaidx-Single.md" - "game-support/games/popn-9B.md" - "game-support/games/sdvx-Single.md" @@ -75,6 +76,7 @@ nav: - "game-support/games/pms-Controller.md" - "game-support/games/pms-Keyboard.md" - "game-support/games/itg-Stamina.md" + - "game-support/games/arcaea-Touch.md" - "game-support/games/ongeki-Single.md" - Wiki: