games: Add a way to view mods

Author: PartMan7

src/ps/commands/games/core.tsx

@@ -9,6 +9,7 @@ import { ChatError } from '@/utils/chatError';
 
 import type { NoTranslate, ToTranslate, TranslationFn } from '@/i18n/types';
 import type { CommonGame } from '@/ps/games/game';
+import type { BaseModEntry } from '@/ps/games/mods';
 import type { PSCommand } from '@/types/chat';
 import type { Room } from 'ps-client';
 import type { HTMLopts } from 'ps-client/classes/common';
@@ -399,6 +400,31 @@ export const command: PSCommand[] = Object.entries(Games).map(([_gameId, Game]):
 								if (applied.success) message.reply(applied.data);
 							},
 						},
+						mods: {
+							name: 'mods',
+							aliases: ['modslist', 'listmods', 'modoptions'],
+							help: `Lists the mods available for ${Game.meta.name}.`,
+							syntax: 'CMD',
+							async run({ broadcastHTML }) {
+								const mods = Game.meta.mods!;
+								broadcastHTML(
+									<div>
+										{Object.values(mods.data)
+											.filter((mod): mod is BaseModEntry => !!mod)
+											.map(mod => (
+												<details>
+													<summary>
+														<b>{mod.name}</b>
+														{mod.aliases?.length ? ` (${mod.aliases.join('/')})` : null}
+													</summary>
+													{mod.desc}
+												</details>
+											))
+											.space(<br />)}
+									</div>
+								);
+							},
+						},
 					} satisfies PSCommand['children'])
 				: {}),
 			...(Game.meta.themes

src/ps/games/mods.ts

@@ -1,7 +1,8 @@
 import { toId } from '@/tools';
 
 export type ModEnum<Mod extends string> = Record<string, Mod>;
-export type ModData<Mod extends string> = Partial<Record<Mod, { aliases?: string[] | undefined }>>;
+export type BaseModEntry = { id: string; name: string; desc: string; aliases?: string[] | undefined };
+export type ModData<Mod extends string> = Partial<Record<Mod, BaseModEntry>>;
 
 export function parseMod<Mod extends string>(input: string, mods: ModEnum<Mod>, modData: ModData<Mod>): Mod | null {
 	const query = toId(input);

src/ps/games/scrabble/mods.ts

@@ -1,26 +1,35 @@
 import { DICTIONARY, ScrabbleMods } from '@/ps/games/scrabble/constants';
 
+import type { BaseModEntry } from '@/ps/games/mods';
 import type { LetterMetadata, WordScore } from '@/ps/games/scrabble/types';
 
 export const ScrabbleModData: Record<
 	ScrabbleMods,
-	{ name: string; dict: DICTIONARY; aliases?: string[]; points?: LetterMetadata; counts?: LetterMetadata }
+	BaseModEntry & { dict: DICTIONARY; points?: LetterMetadata; counts?: LetterMetadata }
 > = {
 	[ScrabbleMods.CSW19]: {
+		id: ScrabbleMods.CSW19,
 		name: 'CSW19',
+		desc: 'Base Scrabble with the CSW19 dictionary.',
 		dict: DICTIONARY.CSW19,
 	},
 	[ScrabbleMods.CSW21]: {
+		id: ScrabbleMods.CSW21,
 		name: 'CSW21',
+		desc: 'Base Scrabble with the CSW21 dictionary.',
 		dict: DICTIONARY.CSW21,
 	},
 	[ScrabbleMods.CSW24]: {
+		id: ScrabbleMods.CSW24,
 		name: 'CSW24',
+		desc: 'Base Scrabble with the CSW24 dictionary.',
 		dict: DICTIONARY.CSW24,
 		aliases: ['current'],
 	},
 	[ScrabbleMods.ODS8]: {
+		id: ScrabbleMods.ODS8,
 		name: 'ODS8',
+		desc: 'French variant of Scrabble.',
 		dict: DICTIONARY.ODS8,
 		counts: {
 			A: 9,
@@ -83,16 +92,22 @@ export const ScrabbleModData: Record<
 		aliases: ['ods', 'french', 'francais', 'franais'],
 	},
 	[ScrabbleMods.CLABBERS]: {
+		id: ScrabbleMods.CLABBERS,
 		name: 'Clabbers',
+		desc: 'Scrabble, but all anagrams are valid, too!',
 		dict: DICTIONARY.CLABBERS,
 	},
 	[ScrabbleMods.POKEMON]: {
+		id: ScrabbleMods.POKEMON,
 		name: 'Pokémon',
+		desc: 'Scrabble but Pokéwords are allowed (with bonus scoring)!',
 		dict: DICTIONARY.CSW24,
 		aliases: ['pokemod', 'pokmon', 'pkmn', 'mons'],
 	},
 	[ScrabbleMods.CRAZYMONS]: {
+		id: ScrabbleMods.CRAZYMONS,
 		name: 'CRAZYMONS',
+		desc: 'PokéScrabble, but INsANe BONuSEs!',
 		dict: DICTIONARY.CSW24,
 		aliases: ['crazy'],
 	},