@sodiumlabs/gamecord 0.1.2 → 1.0.1

package/README.md

@@ -10,27 +10,57 @@
     </p>
 </div>
 
-# About
+## About
 
 ### Gamecord is a collection of games for your Discord bot.
 
-This library was made as a replacement for [discord-gamecord](https://www.npmjs.com/package/discord-gamecord) which is unmaintained (and partially broken) and has no TypeScript support. While the games options are mostly similar, they are more different as they offers more features to customize and handle your games. Also, this module does not contains all games of the original.
+This library was made as a replacement for [discord-gamecord](https://www.npmjs.com/package/discord-gamecord) which is unmaintained (and partially broken) and has no TypeScript support. While the game options are mostly similar, this library offers more features to customize and handle your games. Also, this module does not contain all games from the original.
 
-Each games are documented with examples on the documentation: TODO
+The module supports both slash commands and message commands!
 
-# Installation
+## Installation
 
-### Node.js 18 or newer is required.
+Node.js 18 or newer is required.
 
-```
+```sh
 npm install @sodiumlabs/gamecord
 ```
 
-# Example usage
+## Documentation
+
+You can find the docs here: [https://docs.sodiumlabs.xyz/docs/packages/gamecord/stable](https://docs.sodiumlabs.xyz/docs/packages/gamecord/stable)
+
+If you need help, ask on our [support server](https://discord.gg/8PDXWSHH7k).
+
+## Example usage
+
+```js
+const { Game2048 } = require("@sodiumlabs/gamecord");
+
+const game = new Game2048(interaction, {
+    embed: {
+        title: "2048",
+        color: 0x5865f2,
+    },
+    notPlayerMessage: game => `Only ${game.player} can use this menu.`,
+    timeout: 60_000,
+    emojis: {
+        up: "🔼",
+        down: "🔽",
+        right: "▶️",
+        left: "◀️"
+    }
+});
+
+game.on("error", err => console.error("Error!", err));
+game.on("gameOver", result => console.log("Result:", result));
+
+await game.start();
+```
 
-TODO
+## Some previews
 
-# Some previews
+Note: every embeds can be fully customized.
 
 <img src="./.github/images/2048.png" alt="2048 game" width="300">
 <img src="./.github/images/connect4.png" alt="connect4 game" width="300">
@@ -42,17 +72,21 @@ TODO
 <img src="./.github/images/trivia.png" alt="trivia game" width="300">
 <img src="./.github/images/wordle.png" alt="wordle game" width="300">
 
-# Notes
+## Notes
 
-- The module expects you to pass function that will not error. If it does, the games can break (e.g. by never emitting the `end` or `gameOver` event).
-- If you dont use `.on("error")`, errors will emit `uncaughtException` on your process.
-- Every components custom ids starts with `$gamecord-`.
-- Most games dont need any permissions since it relies on the interaction methods. However if the game is too long (>= 15mins), the interaction became invalid and the bot will need to be able to see the channel and edit its messages.
+- The module expects you to pass function that will not error. If they do, the games can break (e.g. by never emitting the `end` or `gameOver` event).
+- If you don't use `.on("error")`, errors will emit an `uncaughtException` in your process.
+- Every component custom ID starts with `$gamecord-`.
+- Most games don't need any permissions since they rely on interaction methods. However, if a game is too long (>= 15 mins), the interaction becomes invalid and the bot will need permission to view the channel and edit its messages.
 
-# Links
+## Links
 
-TODO
+- [Documentation](https://docs.sodiumlabs.xyz/docs/packages/gdapi/stable)
+- [Discord server](https://discord.gg/8PDXWSHH7k)
+- [GitHub](https://github.com/sodium-labs/gamecord)
+- [npm](https://npmjs.com/package/@sodiumlabs/gamecord)
+- [Sodium Labs](https://sodiumlabs.xyz)
 
-# Help
+## Help
 
 You need help with the module? Ask on our [support server!](https://discord.gg/8PDXWSHH7k)

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'node:events';
 import * as discord_js from 'discord.js';
-import { APIEmbed as APIEmbed$1, RepliableInteraction, Message, User, MessageCreateOptions, InteractionEditReplyOptions, MessageEditOptions, ButtonStyle, ActionRowBuilder, ButtonBuilder, MessageCollector } from 'discord.js';
+import { APIEmbed as APIEmbed$1, ButtonInteraction, RepliableInteraction, Message, User, MessageCreateOptions, InteractionEditReplyOptions, MessageEditOptions, ButtonStyle, ActionRowBuilder, ButtonBuilder, MessageCollector } from 'discord.js';
 import z from 'zod/v4';
 
 type Awaitable<T> = T | Promise<T>;
@@ -19,6 +19,10 @@ type GameEndEmbed<G, R> = APIEmbed | ((game: G, result: R) => Awaitable<APIEmbed
  * A string, or a function to create one using the game.
  */
 type GameMessage<G> = string | ((game: G) => string);
+/**
+ * A string, or a function to create one using the game.
+ */
+type GameInteractionMessage<G, I = ButtonInteraction> = string | ((game: G, i: I) => string);
 /**
  * A string, or a function to create one using the turn data.
  */
@@ -219,7 +223,7 @@ interface Game2048Result extends GameResult {
 interface Game2048Options {
     embed?: GameEmbed<Game2048>;
     endEmbed?: GameEndEmbed<Game2048, Game2048Result>;
-    notPlayerMessage?: GameMessage<Game2048>;
+    notPlayerMessage?: GameInteractionMessage<Game2048>;
     /**
      * The max amount of time the player can be idle.
      */
@@ -349,7 +353,7 @@ declare const game2048Options: z.ZodObject<{
             icon_url?: string | undefined;
         } | undefined;
     }>>]>>;
-    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: Game2048) => string, (game: Game2048) => string>]>>>;
+    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: Game2048, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string, (game: Game2048, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string>]>>>;
     timeout: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     buttonStyle: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     emojis: z.ZodDefault<z.ZodOptional<z.ZodObject<{
@@ -447,7 +451,7 @@ interface Connect4Options {
     tieMessage?: GameEndMessage<Connect4, Connect4Result>;
     timeoutMessage?: GameEndMessage<Connect4, Connect4Result>;
     turnMessage?: GameTurnMessage<Connect4, Connect4Turn>;
-    notPlayerMessage?: GameMessage<Connect4>;
+    notPlayerMessage?: GameInteractionMessage<Connect4>;
     statusText?: string;
     emojis?: {
         board?: string;
@@ -592,7 +596,7 @@ declare const connect4Options: z.ZodObject<{
     tieMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: Connect4Result, game: Connect4) => string, (result: Connect4Result, game: Connect4) => string>]>>>;
     timeoutMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: Connect4Result, game: Connect4) => string, (result: Connect4Result, game: Connect4) => string>]>>>;
     turnMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(data: Connect4Turn, game: Connect4) => string, (data: Connect4Turn, game: Connect4) => string>]>>>;
-    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: Connect4) => string, (game: Connect4) => string>]>>>;
+    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: Connect4, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string, (game: Connect4, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string>]>>>;
     statusText: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     emojis: z.ZodDefault<z.ZodOptional<z.ZodObject<{
         board: z.ZodDefault<z.ZodOptional<z.ZodString>>;
@@ -670,6 +674,7 @@ declare class Connect4 extends VersusGame<Connect4Result> {
  */
 interface FastTypeResult extends GameResult {
     outcome: "win" | "lose" | "timeout";
+    sentence: string;
     timeTaken: number;
     secondsTaken: number;
     /**
@@ -683,7 +688,7 @@ interface FastTypeOptions {
     winMessage?: GameEndMessage<FastType, FastTypeResult>;
     loseMessage?: GameEndMessage<FastType, FastTypeResult>;
     /**
-     * The sentence the player has to type.
+     * The sentence the player has to type. Random by default.
      */
     sentence?: string;
     /**
@@ -810,7 +815,7 @@ declare const fastTypeOptions: z.ZodObject<{
     }>>]>>;
     winMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: FastTypeResult, game: FastType) => string, (result: FastTypeResult, game: FastType) => string>]>>>;
     loseMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: FastTypeResult, game: FastType) => string, (result: FastTypeResult, game: FastType) => string>]>>>;
-    sentence: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    sentence: z.ZodOptional<z.ZodString>;
     timeout: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
 }, z.core.$strip>;
 /**
@@ -837,6 +842,10 @@ declare const fastTypeOptions: z.ZodObject<{
  */
 declare class FastType extends Game<FastTypeResult> {
     readonly options: z.output<typeof fastTypeOptions>;
+    /**
+     * The sentence the player has to type.
+     */
+    sentence: string;
     private timeTaken;
     private wpm;
     constructor(context: GameContext, options?: FastTypeOptions);
@@ -861,7 +870,7 @@ interface FloodOptions {
     endEmbed?: GameEndEmbed<Flood, FloodResult>;
     winMessage?: GameEndMessage<Flood, FloodResult>;
     loseMessage?: GameEndMessage<Flood, FloodResult>;
-    notPlayerMessage?: GameMessage<Flood>;
+    notPlayerMessage?: GameInteractionMessage<Flood>;
     /**
      * The size (width) of the game board.
      */
@@ -999,7 +1008,7 @@ declare const floodOptions: z.ZodObject<{
     }>>]>>;
     winMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: FloodResult, game: Flood) => string, (result: FloodResult, game: Flood) => string>]>>>;
     loseMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: FloodResult, game: Flood) => string, (result: FloodResult, game: Flood) => string>]>>>;
-    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: Flood) => string, (game: Flood) => string>]>>>;
+    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: Flood, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string, (game: Flood, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string>]>>>;
     size: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     maxTurns: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     timeout: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
@@ -1066,7 +1075,7 @@ interface MemoryOptions {
     endEmbed?: GameEndEmbed<Memory, MemoryResult>;
     winMessage?: GameEndMessage<Memory, MemoryResult>;
     loseMessage?: GameEndMessage<Memory, MemoryResult>;
-    notPlayerMessage?: GameMessage<Memory>;
+    notPlayerMessage?: GameInteractionMessage<Memory>;
     /**
      * The max amount of time the player can be idle.
      */
@@ -1195,7 +1204,7 @@ declare const memoryOptions: z.ZodObject<{
     }>>]>>;
     winMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: MemoryResult, game: Memory) => string, (result: MemoryResult, game: Memory) => string>]>>>;
     loseMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: MemoryResult, game: Memory) => string, (result: MemoryResult, game: Memory) => string>]>>>;
-    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: Memory) => string, (game: Memory) => string>]>>>;
+    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: Memory, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string, (game: Memory, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string>]>>>;
     timeout: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     emojis: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
 }, z.core.$strip>;
@@ -1247,7 +1256,7 @@ interface MinesweeperOptions {
     endEmbed?: GameEndEmbed<Minesweeper, MinesweeperResult>;
     winMessage?: GameEndMessage<Minesweeper, MinesweeperResult>;
     loseMessage?: GameEndMessage<Minesweeper, MinesweeperResult>;
-    notPlayerMessage?: GameMessage<Minesweeper>;
+    notPlayerMessage?: GameInteractionMessage<Minesweeper>;
     /**
      * The max amount of time the player can be idle.
      */
@@ -1377,7 +1386,7 @@ declare const minesweeperOptions: z.ZodObject<{
     }>>]>>;
     winMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: MinesweeperResult, game: Minesweeper) => string, (result: MinesweeperResult, game: Minesweeper) => string>]>>>;
     loseMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: MinesweeperResult, game: Minesweeper) => string, (result: MinesweeperResult, game: Minesweeper) => string>]>>>;
-    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: Minesweeper) => string, (game: Minesweeper) => string>]>>>;
+    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: Minesweeper, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string, (game: Minesweeper, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string>]>>>;
     timeout: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     mines: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     emojis: z.ZodDefault<z.ZodOptional<z.ZodObject<{
@@ -1455,7 +1464,7 @@ interface RockPaperScissorsOptions {
      * The first argument is the emoji chosen by the player.
      */
     choiceMessage?: GameTurnMessage<RockPaperScissors, string>;
-    notPlayerMessage?: GameMessage<RockPaperScissors>;
+    notPlayerMessage?: GameInteractionMessage<RockPaperScissors>;
     buttonStyle?: ButtonStyle;
     buttons?: {
         rock?: string;
@@ -1604,7 +1613,7 @@ declare const rockPaperScissorsOptions: z.ZodObject<{
     tieMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: RockPaperScissorsResult, game: RockPaperScissors) => string, (result: RockPaperScissorsResult, game: RockPaperScissors) => string>]>>>;
     timeoutMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: RockPaperScissorsResult, game: RockPaperScissors) => string, (result: RockPaperScissorsResult, game: RockPaperScissors) => string>]>>>;
     choiceMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(data: string, game: RockPaperScissors) => string, (data: string, game: RockPaperScissors) => string>]>>>;
-    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: RockPaperScissors) => string, (game: RockPaperScissors) => string>]>>>;
+    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: RockPaperScissors, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string, (game: RockPaperScissors, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string>]>>>;
     buttonStyle: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     buttons: z.ZodDefault<z.ZodOptional<z.ZodObject<{
         rock: z.ZodDefault<z.ZodOptional<z.ZodString>>;
@@ -1683,9 +1692,15 @@ interface TicTacToeOptions {
     tieMessage?: GameEndMessage<TicTacToe, TicTacToeResult>;
     timeoutMessage?: GameEndMessage<TicTacToe, TicTacToeResult>;
     turnMessage?: GameTurnMessage<TicTacToe, TicTacToeTurn>;
-    notPlayerMessage?: GameMessage<TicTacToe>;
+    notPlayerMessage?: GameInteractionMessage<TicTacToe>;
     emojis?: {
+        /**
+         * You can also use an emoji ID.
+         */
         xButton?: string;
+        /**
+         * You can also use an emoji ID.
+         */
         oButton?: string;
     };
     styles?: {
@@ -1829,7 +1844,7 @@ declare const ticTacToeOptions: z.ZodObject<{
     tieMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: TicTacToeResult, game: TicTacToe) => string, (result: TicTacToeResult, game: TicTacToe) => string>]>>>;
     timeoutMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: TicTacToeResult, game: TicTacToe) => string, (result: TicTacToeResult, game: TicTacToe) => string>]>>>;
     turnMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(data: TicTacToeTurn, game: TicTacToe) => string, (data: TicTacToeTurn, game: TicTacToe) => string>]>>>;
-    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: TicTacToe) => string, (game: TicTacToe) => string>]>>>;
+    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: TicTacToe, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string, (game: TicTacToe, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string>]>>>;
     emojis: z.ZodDefault<z.ZodOptional<z.ZodObject<{
         xButton: z.ZodDefault<z.ZodOptional<z.ZodString>>;
         oButton: z.ZodDefault<z.ZodOptional<z.ZodString>>;
@@ -1902,7 +1917,24 @@ interface TriviaResult extends GameResult {
     selected: number;
 }
 /**
- * For `single` questions, the values must be the strings `"True"` and `"False"`.
+ * The data of the trivia. The `options` array contains all the choices, including the answer.
+ *
+ *
+ * If you are using the `trivia` option, here is what you should know:
+ *
+ * ### When `mode` is `boolean`:
+ *
+ * - `answer` MUST be exactly either `"True"` or `"False"`.
+ *
+ * - `options` MUST be exactly `["True", "False"]`.
+ *
+ * The buttons labels will still use the `trueText` and `falseText` options.
+ *
+ * ### When `mode` is `multiple`:
+ *
+ * - `answer` MUST be exactly the same as one present in the `options`.
+ *
+ * - `options` can have 2 to 5 elements.
  */
 interface TriviaData {
     question: string;
@@ -1916,14 +1948,18 @@ interface TriviaOptions {
     endEmbed?: GameEndEmbed<Trivia, TriviaResult>;
     winMessage?: GameEndMessage<Trivia, TriviaResult>;
     loseMessage?: GameEndMessage<Trivia, TriviaResult>;
+    notPlayerMessage?: GameInteractionMessage<Trivia>;
     /**
      * Message displayed when the API call to fetch the trivia fails.
      */
     errorMessage?: GameMessage<Trivia>;
     /**
      * "multiple" by default.
+     *
+     * When `mode` is `"boolean"`, the trivia is a true/false question.
+     * When `mode` is `"multiple"`, it is a multi-choices trivia.
      */
-    mode?: "multiple" | "single";
+    mode?: "multiple" | "boolean";
     /**
      * Random if not specified.
      */
@@ -1938,11 +1974,11 @@ interface TriviaOptions {
      */
     timeout?: number;
     /**
-     * The button label for the "True" button. Only when mode: "single".
+     * The button label for the "True" button. Only used when mode is "boolean".
      */
     trueText?: string;
     /**
-     * The button label for the "False" button. Only when mode: "single".
+     * The button label for the "False" button. Only used when mode is "boolean".
      */
     falseText?: string;
 }
@@ -2066,10 +2102,10 @@ declare const triviaOptions: z.ZodObject<{
     winMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: TriviaResult, game: Trivia) => string, (result: TriviaResult, game: Trivia) => string>]>>>;
     loseMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(result: TriviaResult, game: Trivia) => string, (result: TriviaResult, game: Trivia) => string>]>>>;
     errorMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: Trivia) => string, (game: Trivia) => string>]>>>;
-    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: Trivia) => string, (game: Trivia) => string>]>>>;
+    notPlayerMessage: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<() => string, string>>, z.ZodCustom<(game: Trivia, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string, (game: Trivia, i: discord_js.ButtonInteraction<discord_js.CacheType>) => string>]>>>;
     mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        boolean: "boolean";
         multiple: "multiple";
-        single: "single";
     }>>>;
     difficulty: z.ZodOptional<z.ZodEnum<{
         [x: string]: string;
@@ -2082,6 +2118,9 @@ declare const triviaOptions: z.ZodObject<{
 /**
  * A game where the player needs to find the answer of a random question.
  *
+ * When `mode` is `"boolean"`, the trivia is a true/false question.
+ * When `mode` is `"multiple"`, it is a multi-choices trivia.
+ *
  * ## API
  *
  * This game uses the `opentdb.com` API. If you want to use
@@ -2309,4 +2348,4 @@ declare class Wordle extends Game<WordleResult> {
     private getBoardImage;
 }
 
-export { type APIEmbed, type Awaitable, Connect4, type Connect4Options, type Connect4Result, type Connect4Turn, type DeepRequired, FastType, type FastTypeOptions, type FastTypeResult, Flood, type FloodOptions, type FloodResult, Game, Game2048, type Game2048Options, type Game2048Result, type GameContext, type GameEmbed, type GameEndEmbed, type GameEndMessage, type GameMessage, type GameResult, type GameTurnMessage, Memory, type MemoryEmojiPosition, type MemoryOptions, type MemoryResult, Minesweeper, type MinesweeperOptions, type MinesweeperResult, type Position, RockPaperScissors, type RockPaperScissorsOptions, type RockPaperScissorsResult, TicTacToe, type TicTacToeOptions, type TicTacToeResult, type TicTacToeTurn, Trivia, type TriviaData, type TriviaOptions, type TriviaResult, VersusGame, type VersusGameResult, type VersusOptions, type VersusOptionsOutput, type VersusPlayers, Wordle, type WordleOptions, type WordleResult, connect4Options, fastTypeOptions, floodOptions, game2048Options, jokerEmoji, memoryOptions, minesweeperOptions, rockPaperScissorsOptions, ticTacToeOptions, triviaOptions, versusOptions, wordleOptions };
+export { type APIEmbed, type Awaitable, Connect4, type Connect4Options, type Connect4Result, type Connect4Turn, type DeepRequired, FastType, type FastTypeOptions, type FastTypeResult, Flood, type FloodOptions, type FloodResult, Game, Game2048, type Game2048Options, type Game2048Result, type GameContext, type GameEmbed, type GameEndEmbed, type GameEndMessage, type GameInteractionMessage, type GameMessage, type GameResult, type GameTurnMessage, Memory, type MemoryEmojiPosition, type MemoryOptions, type MemoryResult, Minesweeper, type MinesweeperOptions, type MinesweeperResult, type Position, RockPaperScissors, type RockPaperScissorsOptions, type RockPaperScissorsResult, TicTacToe, type TicTacToeOptions, type TicTacToeResult, type TicTacToeTurn, Trivia, type TriviaData, type TriviaOptions, type TriviaResult, VersusGame, type VersusGameResult, type VersusOptions, type VersusOptionsOutput, type VersusPlayers, Wordle, type WordleOptions, type WordleResult, connect4Options, fastTypeOptions, floodOptions, game2048Options, jokerEmoji, memoryOptions, minesweeperOptions, rockPaperScissorsOptions, ticTacToeOptions, triviaOptions, versusOptions, wordleOptions };