chore: Rename 'Game' to 'BaseGame'

Author: PartMan7

src/cache/index.ts

@@ -1,6 +1,6 @@
 import type { JudgementGame } from '@/discord/commands/judgement';
 import type { Games } from '@/ps/games';
-import type { BaseGame } from '@/ps/games/game';
+import type { CommonGame } from '@/ps/games/game';
 import type { PSCronJobManager } from '@/ps/handlers/cron';
 import type { DiscCommand, PSCommand } from '@/types/chat';
 import type { PSRoomConfig } from '@/types/ps';
@@ -22,7 +22,7 @@ export const PSQuoteRoomPrefs: { [key: string]: { room: string; at: Date } } = {
 export const PSCronJobs: { manager: PSCronJobManager | null } = { manager: null };
 
 // Games
-export const PSGames: { [key in keyof Games]?: Record<string, BaseGame> } = {};
+export const PSGames: { [key in keyof Games]?: Record<string, CommonGame> } = {};
 
 // Discord
 export const DiscCommands: { [key: string]: DiscCommand & { path: string; isAlias?: boolean; slash: SlashCommandBuilder } } = {};

src/ps/commands/games/core.tsx

@@ -8,7 +8,7 @@ import { toId } from '@/tools';
 import { ChatError } from '@/utils/chatError';
 
 import type { NoTranslate, ToTranslate, TranslationFn } from '@/i18n/types';
-import type { BaseGame } from '@/ps/games/game';
+import type { CommonGame } from '@/ps/games/game';
 import type { PSCommand } from '@/types/chat';
 import type { Room } from 'ps-client';
 import type { HTMLopts } from 'ps-client/classes/common';
@@ -31,7 +31,7 @@ type RoomContext = { room: Room; $T: TranslationFn };
 export const command: PSCommand[] = Object.entries(Games).map(([_gameId, Game]): PSCommand => {
 	const gameId = _gameId as keyof Games;
 
-	type GameFilter = (game: BaseGame) => boolean;
+	type GameFilter = (game: CommonGame) => boolean;
 
 	function getByContext(ctx: SearchContext): GameFilter {
 		return game => {
@@ -76,7 +76,7 @@ export const command: PSCommand[] = Object.entries(Games).map(([_gameId, Game]):
 		searchCtx: SearchContext,
 		roomCtx: RoomContext,
 		restCtx: string
-	): BaseGame | null {
+	): CommonGame | null {
 		if (!PSGames[gameId]) return null;
 		if (Game.meta.players === 'single') {
 			const inferredSpecifier = typeof specifier === 'string' ? `#${Game.meta.abbr}-${toId(specifier)}` : specifier;
@@ -125,7 +125,7 @@ export const command: PSCommand[] = Object.entries(Games).map(([_gameId, Game]):
 		return null;
 	}
 
-	function getGame(feed: string, searchCtx: SearchContext, roomCtx: RoomContext): { game: BaseGame; ctx: string } {
+	function getGame(feed: string, searchCtx: SearchContext, roomCtx: RoomContext): { game: CommonGame; ctx: string } {
 		const { $T } = roomCtx;
 		const [fullSpec, fullCtx] = feed.lazySplit(/\s*,\s*/, 1);
 		const fullGame = gameFromContext(fullSpec, searchCtx, roomCtx, fullCtx);

src/ps/games/chess/index.ts

@@ -2,7 +2,7 @@ import { Chess as ChessLib } from 'chess.js';
 import { EmbedBuilder } from 'discord.js';
 
 import { render } from '@/ps/games/chess/render';
-import { Game } from '@/ps/games/game';
+import { BaseGame } from '@/ps/games/game';
 import { pick } from '@/utils/pick';
 
 import type { TranslatedText } from '@/i18n/types';
@@ -19,7 +19,7 @@ function isValidSquare(input: string): input is Square {
 	return /^[a-h][1-9]$/.test(input);
 }
 
-export class Chess extends Game<State> {
+export class Chess extends BaseGame<State> {
 	selected: Square | null = null;
 	showMoves: Move[] = [];
 	drawOffered: null | string = null;

src/ps/games/connectfour/index.ts

@@ -2,7 +2,7 @@ import { EmbedBuilder } from 'discord.js';
 
 import { WINNER_ICON } from '@/discord/constants/emotes';
 import { render } from '@/ps/games/connectfour/render';
-import { Game, createGrid } from '@/ps/games/game';
+import { BaseGame, createGrid } from '@/ps/games/game';
 import { repeat } from '@/utils/repeat';
 
 import type { TranslatedText } from '@/i18n/types';
@@ -15,7 +15,7 @@ import type { ReactElement } from 'react';
 
 export { meta } from '@/ps/games/connectfour/meta';
 
-export class ConnectFour extends Game<State> {
+export class ConnectFour extends BaseGame<State> {
 	log: Log[] = [];
 	winCtx?: WinCtx | { type: EndType };
 	cache: Record<string, Record<Turn, number>> = {};

src/ps/games/game.ts

@@ -26,7 +26,7 @@ const backupKeys = ['state', 'started', 'turn', 'turns', 'seed', 'players', 'the
  * This is the shared code for all games. To check the game-specific code, refer to the
  * extended constructor in `$game/index.ts` and go through the `action` method.
  */
-export class Game<State extends BaseState> {
+export class BaseGame<State extends BaseState> {
 	meta: Meta;
 	id: string;
 	$T: TranslationFn;
@@ -121,9 +121,9 @@ export class Game<State extends BaseState> {
 	}
 	persist(ctx: BaseContext) {
 		if (!PSGames[this.meta.id]) PSGames[this.meta.id] = {};
-		PSGames[this.meta.id]![this.id] = this as BaseGame;
+		PSGames[this.meta.id]![this.id] = this as CommonGame;
 		if (ctx.backup) {
-			const parsedBackup: Pick<BaseGame, (typeof backupKeys)[number]> = JSON.parse(ctx.backup);
+			const parsedBackup: Pick<CommonGame, (typeof backupKeys)[number]> = JSON.parse(ctx.backup);
 			backupKeys.forEach(key => {
 				switch (key) {
 					case 'log':
@@ -486,4 +486,5 @@ export function createGrid<T>(x: number, y: number, fill: (x: number, y: number)
 	return Array.from({ length: x }).map((_, i) => Array.from({ length: y }).map((_, j) => fill(i, j)));
 }
 
-export type BaseGame = Game<BaseState>;
+/** Non-generic type representing only the things all games have in common */
+export type CommonGame = BaseGame<BaseState>;

src/ps/games/lightsout/index.ts

@@ -1,6 +1,6 @@
 import { type ReactElement } from 'react';
 
-import { Game, createGrid } from '@/ps/games/game';
+import { BaseGame, createGrid } from '@/ps/games/game';
 import { render, renderCloseSignups } from '@/ps/games/lightsout/render';
 import { deepClone } from '@/utils/deepClone';
 import { type Point, parsePoint, stepPoint } from '@/utils/grid';
@@ -13,7 +13,7 @@ import type { User } from 'ps-client';
 
 export { meta } from '@/ps/games/lightsout/meta';
 
-export class LightsOut extends Game<State> {
+export class LightsOut extends BaseGame<State> {
 	ended = false;
 	size: [number, number];
 	setBy: User | null = null;

src/ps/games/mastermind/index.ts

@@ -1,6 +1,6 @@
 import { type ReactElement } from 'react';
 
-import { Game } from '@/ps/games/game';
+import { BaseGame } from '@/ps/games/game';
 import { render, renderCloseSignups } from '@/ps/games/mastermind/render';
 import { sample } from '@/utils/random';
 
@@ -12,7 +12,7 @@ import type { User } from 'ps-client';
 
 export { meta } from '@/ps/games/mastermind/meta';
 
-export class Mastermind extends Game<State> {
+export class Mastermind extends BaseGame<State> {
 	ended = false;
 	setBy: User | null = null;
 

src/ps/games/othello/index.ts

@@ -1,7 +1,7 @@
 import { EmbedBuilder } from 'discord.js';
 
 import { WINNER_ICON } from '@/discord/constants/emotes';
-import { Game, createGrid } from '@/ps/games/game';
+import { BaseGame, createGrid } from '@/ps/games/game';
 import { render } from '@/ps/games/othello/render';
 import { deepClone } from '@/utils/deepClone';
 
@@ -14,7 +14,7 @@ import type { User } from 'ps-client';
 
 export { meta } from '@/ps/games/othello/meta';
 
-export class Othello extends Game<State> {
+export class Othello extends BaseGame<State> {
 	log: Log[] = [];
 	winCtx?: WinCtx | { type: EndType };
 	cache: Record<string, Record<Turn, number>> = {};

src/ps/games/render.tsx

@@ -1,10 +1,10 @@
 import { Button } from '@/utils/components/ps';
 
 import type { BaseState } from '@/ps/games/common';
-import type { Game } from '@/ps/games/game';
+import type { BaseGame } from '@/ps/games/game';
 import type { CSSProperties, HTMLProps, ReactElement, ReactNode } from 'react';
 
-export function renderSignups<State extends BaseState>(this: Game<State>, staff: boolean): ReactElement | null {
+export function renderSignups<State extends BaseState>(this: BaseGame<State>, staff: boolean): ReactElement | null {
 	const startable = this.meta.autostart === false && this.startable();
 	if (staff && !startable) return null;
 	return (
@@ -36,7 +36,7 @@ export function renderSignups<State extends BaseState>(this: Game<State>, staff:
 	);
 }
 
-export function renderCloseSignups<State extends BaseState>(this: Game<State>): ReactElement {
+export function renderCloseSignups<State extends BaseState>(this: BaseGame<State>): ReactElement {
 	return (
 		<>
 			<hr />

src/ps/games/scrabble/index.ts

@@ -1,6 +1,6 @@
 import { EmbedBuilder } from 'discord.js';
 
-import { Game, createGrid } from '@/ps/games/game';
+import { BaseGame, createGrid } from '@/ps/games/game';
 import { checkWord } from '@/ps/games/scrabble/checker';
 import {
 	BaseBoard,
@@ -29,7 +29,7 @@ function isLetter(char: string): boolean {
 	return /[A-Z]/.test(char);
 }
 
-export class Scrabble extends Game<State> {
+export class Scrabble extends BaseGame<State> {
 	points: Record<string, number> = LETTER_POINTS;
 	log: Log[] = [];
 	passCount: number | null = null;