New match type: ddrSongHash (#1213)

* New match type: `ddrSongHash` * style: sort `MatchTypesWithDifficulty` * make `ddrSongHash` a song property instead of a chart property * docs: add descriptions for match type `ddrSongHash` * add `ddrSongHash` field to all applicable songs * fix: enforce ddrSongHash is only used on DDR --------- Co-authored-by: zk <[email protected]>
zkrising · Dec 18, 2024 · 2111782 · 2111782
1 parent 36bf039
commit 2111782
Show file tree

Hide file tree

Showing 10 changed files with 1,332 additions and 3 deletions.
diff --git a/common/src/config/game-support/ddr.ts b/common/src/config/game-support/ddr.ts
@@ -60,6 +60,7 @@ export const DDR_CONF = {
 		inGameID: zodNonNegativeInt,
 		flareCategory: DDR_FLARE_CATEGORIES,
 		basename: z.string().optional(),
+		ddrSongHash: z.string().optional(), // optional because konaste-only songs have no hashes
 	}),
 } as const satisfies INTERNAL_GAME_CONFIG;
 
@@ -206,7 +207,7 @@ export const DDR_SP_CONF = {
 	preferences: z.strictObject({}),
 	scoreMeta: z.strictObject({}),
 
-	supportedMatchTypes: ["inGameID", "songTitle", "tachiSongID"],
+	supportedMatchTypes: ["inGameID", "songTitle", "tachiSongID", "ddrSongHash"],
 } as const satisfies INTERNAL_GAME_PT_CONFIG;
 
 export const DDR_DP_CONF = {

diff --git a/common/src/lib/schemas.ts b/common/src/lib/schemas.ts
@@ -875,7 +875,8 @@ const PR_BATCH_MANUAL_SCORE = (game: Game, playtype: Playtype): PrudenceSchema =
 			"inGameID",
 			"inGameStrID",
 			"uscChartHash",
-			"popnChartHash"
+			"popnChartHash",
+			"ddrSongHash"
 		),
 		identifier: "string",
 		comment: optNull(p.isBoundedString(3, 240)),

diff --git a/common/src/types/batch-manual.ts b/common/src/types/batch-manual.ts
@@ -19,6 +19,7 @@ type MatchTypesNoDifficulty = "bmsChartHash" | "itgChartHash" | "popnChartHash"
 
 // These MatchTypes need `difficulty` set in the batch manual.
 type MatchTypesWithDifficulty =
+	| "ddrSongHash"
 	| "inGameID"
 	| "inGameStrID"
 	| "sdvxInGameID"

diff --git a/docs/docs/codebase/batch-manual/index.md b/docs/docs/codebase/batch-manual/index.md
@@ -166,6 +166,11 @@ means that it will check for any of `INF/GRV/HVN/VVD/XCD` for this song.
 
 This is useful for services that store all of those as the same difficulty.
 
+- ddrSongHash
+
+This is a 32-character hash used by the official DDR e-amusement website to
+identify a song; you must specify the difficulty for this chart as well.
+
 ## Example
 
 A final example of a simple BATCH MANUAL format

diff --git a/docs/docs/game-support/common-config/match-types.md b/docs/docs/game-support/common-config/match-types.md
@@ -31,6 +31,10 @@ Uses `identifier` as a SHA1 hash, since that's what USC uses.
 
 These match types need both `identifier` and a `difficulty` defined.
 
+### `ddrSongHash`
+
+Looks up on the 32-character song hash for this chart, where the hash is from the official DDR e-amusement website.
+
 ### `inGameID`
 
 Looks up on the in game ID for this chart.

diff --git a/docs/docs/game-support/games/ddr-DP.md b/docs/docs/game-support/games/ddr-DP.md
@@ -84,3 +84,4 @@ The folowing judgements are defined:
 - `inGameID`
 - `songTitle`
 - `tachiSongID`
+- `ddrSongHash`
diff --git a/docs/docs/game-support/games/ddr-SP.md b/docs/docs/game-support/games/ddr-SP.md
@@ -84,3 +84,4 @@ The folowing judgements are defined:
 - `inGameID`
 - `songTitle`
 - `tachiSongID`
+- `ddrSongHash`