@slot-engine/core 0.0.10 → 0.1.0

package/README.md

@@ -1,6 +1,3 @@
-> [!NOTE]
-> This software **is work in progress** and may currently miss features or contain bugs. Feel free to contribute to help improve this project. Breaking changes may occur at any time.
-
 # Slot Engine Core
 
 Library for configuring and simulating slot games. Produces output compatible with Stake Engine / Stake RGS.

package/dist/index.d.mts

@@ -428,7 +428,11 @@ declare class BoardService<TGameModes extends AnyGameModes = AnyGameModes, TSymb
     /**
      * Draws a board using specified reel stops.
      */
-    drawBoardWithForcedStops(reels: Reels, forcedStops: Record<string, number>): void;
+    drawBoardWithForcedStops(opts: {
+        reels: Reels;
+        forcedStops: Record<string, number>;
+        randomOffset?: boolean;
+    }): void;
     /**
      * Draws a board using random reel stops.
      */
@@ -440,7 +444,10 @@ declare class BoardService<TGameModes extends AnyGameModes = AnyGameModes, TSymb
     tumbleBoard(symbolsToDelete: Array<{
         reelIdx: number;
         rowIdx: number;
-    }>): void;
+    }>): {
+        newBoardSymbols: Record<string, GameSymbol[]>;
+        newPaddingTopSymbols: Record<string, GameSymbol[]>;
+    };
 }
 
 declare class Recorder {
@@ -609,7 +616,7 @@ declare class ReelSet {
     reels: Reels;
     protected rng: RandomNumberGenerator;
     constructor(opts: ReelSetOptions);
-    generateReels(simulation: Simulation): void;
+    generateReels(config: GameConfig): ReelSet;
     /**
      * Reads a reelset CSV file and returns the reels as arrays of GameSymbols.
      */
@@ -687,6 +694,11 @@ interface GameModeOpts {
 
 declare class GameService<TGameModes extends AnyGameModes = AnyGameModes, TSymbols extends AnySymbols = AnySymbols, TUserState extends AnyUserData = AnyUserData> extends AbstractService {
     constructor(ctx: () => GameContext<TGameModes, TSymbols, TUserState>);
+    /**
+     * Intended for internal use only.\
+     * Generates reels for all reel sets in the game configuration.
+     */
+    _generateReels(): void;
     /**
      * Retrieves a reel set by its ID within a specific game mode.
      */
@@ -1344,7 +1356,7 @@ declare class GeneratedReelSet extends ReelSet {
      * Checks if a symbol can be placed at the target index without violating spacing rules.
      */
     private violatesSpacing;
-    generateReels({ gameConfig: config }: Simulation): void;
+    generateReels(config: GameConfig): this;
 }
 interface GeneratedReelSetOptions extends ReelSetOptions {
     /**
@@ -1458,7 +1470,7 @@ declare class StaticReelSet extends ReelSet {
     private _strReels;
     constructor(opts: StaticReelSetOptions);
     private validateConfig;
-    generateReels({ gameConfig: config }: Simulation): void;
+    generateReels(config: GameConfig): this;
 }
 interface StaticReelSetOptions extends ReelSetOptions {
     reels?: string[][];
@@ -1537,7 +1549,11 @@ declare class StandaloneBoard {
     /**
      * Draws a board using specified reel stops.
      */
-    drawBoardWithForcedStops(reels: Reels, forcedStops: Record<string, number>): void;
+    drawBoardWithForcedStops(opts: {
+        reels: Reels;
+        forcedStops: Record<string, number>;
+        randomOffset?: boolean;
+    }): void;
     /**
      * Draws a board using random reel stops.
      */
@@ -1549,7 +1565,10 @@ declare class StandaloneBoard {
     tumbleBoard(symbolsToDelete: Array<{
         reelIdx: number;
         rowIdx: number;
-    }>): void;
+    }>): {
+        newBoardSymbols: Record<string, GameSymbol[]>;
+        newPaddingTopSymbols: Record<string, GameSymbol[]>;
+    };
 }
 interface StandaloneBoardOptions {
     ctx: GameContext;

package/dist/index.d.ts

@@ -428,7 +428,11 @@ declare class BoardService<TGameModes extends AnyGameModes = AnyGameModes, TSymb
     /**
      * Draws a board using specified reel stops.
      */
-    drawBoardWithForcedStops(reels: Reels, forcedStops: Record<string, number>): void;
+    drawBoardWithForcedStops(opts: {
+        reels: Reels;
+        forcedStops: Record<string, number>;
+        randomOffset?: boolean;
+    }): void;
     /**
      * Draws a board using random reel stops.
      */
@@ -440,7 +444,10 @@ declare class BoardService<TGameModes extends AnyGameModes = AnyGameModes, TSymb
     tumbleBoard(symbolsToDelete: Array<{
         reelIdx: number;
         rowIdx: number;
-    }>): void;
+    }>): {
+        newBoardSymbols: Record<string, GameSymbol[]>;
+        newPaddingTopSymbols: Record<string, GameSymbol[]>;
+    };
 }
 
 declare class Recorder {
@@ -609,7 +616,7 @@ declare class ReelSet {
     reels: Reels;
     protected rng: RandomNumberGenerator;
     constructor(opts: ReelSetOptions);
-    generateReels(simulation: Simulation): void;
+    generateReels(config: GameConfig): ReelSet;
     /**
      * Reads a reelset CSV file and returns the reels as arrays of GameSymbols.
      */
@@ -687,6 +694,11 @@ interface GameModeOpts {
 
 declare class GameService<TGameModes extends AnyGameModes = AnyGameModes, TSymbols extends AnySymbols = AnySymbols, TUserState extends AnyUserData = AnyUserData> extends AbstractService {
     constructor(ctx: () => GameContext<TGameModes, TSymbols, TUserState>);
+    /**
+     * Intended for internal use only.\
+     * Generates reels for all reel sets in the game configuration.
+     */
+    _generateReels(): void;
     /**
      * Retrieves a reel set by its ID within a specific game mode.
      */
@@ -1344,7 +1356,7 @@ declare class GeneratedReelSet extends ReelSet {
      * Checks if a symbol can be placed at the target index without violating spacing rules.
      */
     private violatesSpacing;
-    generateReels({ gameConfig: config }: Simulation): void;
+    generateReels(config: GameConfig): this;
 }
 interface GeneratedReelSetOptions extends ReelSetOptions {
     /**
@@ -1458,7 +1470,7 @@ declare class StaticReelSet extends ReelSet {
     private _strReels;
     constructor(opts: StaticReelSetOptions);
     private validateConfig;
-    generateReels({ gameConfig: config }: Simulation): void;
+    generateReels(config: GameConfig): this;
 }
 interface StaticReelSetOptions extends ReelSetOptions {
     reels?: string[][];
@@ -1537,7 +1549,11 @@ declare class StandaloneBoard {
     /**
      * Draws a board using specified reel stops.
      */
-    drawBoardWithForcedStops(reels: Reels, forcedStops: Record<string, number>): void;
+    drawBoardWithForcedStops(opts: {
+        reels: Reels;
+        forcedStops: Record<string, number>;
+        randomOffset?: boolean;
+    }): void;
     /**
      * Draws a board using random reel stops.
      */
@@ -1549,7 +1565,10 @@ declare class StandaloneBoard {
     tumbleBoard(symbolsToDelete: Array<{
         reelIdx: number;
         rowIdx: number;
-    }>): void;
+    }>): {
+        newBoardSymbols: Record<string, GameSymbol[]>;
+        newPaddingTopSymbols: Record<string, GameSymbol[]>;
+    };
 }
 interface StandaloneBoardOptions {
     ctx: GameContext;

package/dist/index.js

@@ -650,7 +650,11 @@ var Board = class {
       for (const [r, stopPos] of Object.entries(opts.forcedStops)) {
         const reelIdx = Number(r);
         const symCount = symbolsPerReel[reelIdx];
-        finalReelStops[reelIdx] = stopPos - Math.round(opts.ctx.services.rng.randomFloat(0, symCount - 1));
+        if (opts.forcedStopsOffset !== false) {
+          finalReelStops[reelIdx] = stopPos - Math.round(opts.ctx.services.rng.randomFloat(0, symCount - 1));
+        } else {
+          finalReelStops[reelIdx] = stopPos;
+        }
         if (finalReelStops[reelIdx] < 0) {
           finalReelStops[reelIdx] = opts.reels[reelIdx].length + finalReelStops[reelIdx];
         }
@@ -693,15 +697,22 @@ var Board = class {
       );
     }
     const reels = this.lastUsedReels;
-    opts.symbolsToDelete.forEach(({ reelIdx, rowIdx }) => {
+    const sortedDeletions = [...opts.symbolsToDelete].sort((a, b) => b.rowIdx - a.rowIdx);
+    sortedDeletions.forEach(({ reelIdx, rowIdx }) => {
       this.reels[reelIdx].splice(rowIdx, 1);
     });
     const newFirstSymbolPositions = {};
+    const newBoardSymbols = {};
+    const newPaddingTopSymbols = {};
     for (let ridx = 0; ridx < reelsAmount; ridx++) {
       while (this.reels[ridx].length < symbolsPerReel[ridx]) {
         const padSymbol = this.paddingTop[ridx].pop();
         if (padSymbol) {
           this.reels[ridx].unshift(padSymbol);
+          if (!newBoardSymbols[ridx]) {
+            newBoardSymbols[ridx] = [];
+          }
+          newBoardSymbols[ridx].unshift(padSymbol);
         } else {
           break;
         }
@@ -715,17 +726,30 @@ var Board = class {
         (0, import_assert3.default)(newSymbol, "Failed to get new symbol for tumbling.");
         this.reels[ridx].unshift(newSymbol);
         newFirstSymbolPositions[ridx] = symbolPos;
+        if (!newBoardSymbols[ridx]) {
+          newBoardSymbols[ridx] = [];
+        }
+        newBoardSymbols[ridx].unshift(newSymbol);
       }
     }
     for (let ridx = 0; ridx < reelsAmount; ridx++) {
       const firstSymbolPos = newFirstSymbolPositions[ridx];
+      if (firstSymbolPos === void 0) continue;
       for (let p = 1; p <= padSymbols; p++) {
         const topPos = (firstSymbolPos - p + reels[ridx].length) % reels[ridx].length;
         const padSymbol = reels[ridx][topPos];
         (0, import_assert3.default)(padSymbol, "Failed to get new padding symbol for tumbling.");
         this.paddingTop[ridx].unshift(padSymbol);
+        if (!newPaddingTopSymbols[ridx]) {
+          newPaddingTopSymbols[ridx] = [];
+        }
+        newPaddingTopSymbols[ridx].unshift(padSymbol);
       }
     }
+    return {
+      newBoardSymbols,
+      newPaddingTopSymbols
+    };
   }
 };
 
@@ -845,8 +869,8 @@ var BoardService = class extends AbstractService {
   /**
    * Draws a board using specified reel stops.
    */
-  drawBoardWithForcedStops(reels, forcedStops) {
-    this.drawBoardMixed(reels, forcedStops);
+  drawBoardWithForcedStops(opts) {
+    this.drawBoardMixed(opts.reels, opts.forcedStops, opts.randomOffset);
   }
   /**
    * Draws a board using random reel stops.
@@ -854,18 +878,19 @@ var BoardService = class extends AbstractService {
   drawBoardWithRandomStops(reels) {
     this.drawBoardMixed(reels);
   }
-  drawBoardMixed(reels, forcedStops) {
+  drawBoardMixed(reels, forcedStops, forcedStopsOffset) {
     this.board.drawBoardMixed({
       ctx: this.ctx(),
       reels,
-      forcedStops
+      forcedStops,
+      forcedStopsOffset
     });
   }
   /**
    * Tumbles the board. All given symbols will be deleted and new symbols will fall from the top.
    */
   tumbleBoard(symbolsToDelete) {
-    this.board.tumbleBoard({
+    return this.board.tumbleBoard({
       ctx: this.ctx(),
       symbolsToDelete
     });
@@ -958,6 +983,25 @@ var GameService = class extends AbstractService {
   constructor(ctx) {
     super(ctx);
   }
+  /**
+   * Intended for internal use only.\
+   * Generates reels for all reel sets in the game configuration.
+   */
+  _generateReels() {
+    const config = this.ctx().config;
+    for (const mode of Object.values(config.gameModes)) {
+      if (mode.reelSets && mode.reelSets.length > 0) {
+        for (const reelSet of Object.values(mode.reelSets)) {
+          reelSet.associatedGameModeName = mode.name;
+          reelSet.generateReels(config);
+        }
+      } else {
+        throw new Error(
+          `Game mode "${mode.name}" has no reel sets defined. Cannot generate reelset files.`
+        );
+      }
+    }
+  }
   /**
    * Retrieves a reel set by its ID within a specific game mode.
    */
@@ -1839,7 +1883,7 @@ Simulating game mode: ${mode}`);
       if (mode.reelSets && mode.reelSets.length > 0) {
         for (const reelSet of Object.values(mode.reelSets)) {
           reelSet.associatedGameModeName = mode.name;
-          reelSet.generateReels(this);
+          reelSet.generateReels(this.gameConfig);
         }
       } else {
         throw new Error(
@@ -3013,7 +3057,7 @@ var ReelSet = class {
     this.rng = new RandomNumberGenerator();
     this.rng.setSeed(opts.seed ?? 0);
   }
-  generateReels(simulation) {
+  generateReels(config) {
     throw new Error("Not implemented");
   }
   /**
@@ -3185,7 +3229,7 @@ var GeneratedReelSet = class extends ReelSet {
     }
     return false;
   }
-  generateReels({ gameConfig: config }) {
+  generateReels(config) {
     this.validateConfig(config);
     const gameMode = config.gameModes[this.associatedGameModeName];
     if (!gameMode) {
@@ -3200,7 +3244,7 @@ var GeneratedReelSet = class extends ReelSet {
     const exists = import_fs5.default.existsSync(filePath);
     if (exists && !this.overrideExisting) {
       this.reels = this.parseReelsetCSV(filePath, config);
-      return;
+      return this;
     }
     if (!exists && this.symbolWeights.size === 0) {
       throw new Error(
@@ -3347,6 +3391,7 @@ var GeneratedReelSet = class extends ReelSet {
         `Generated reelset ${this.id} for game mode ${this.associatedGameModeName}`
       );
     }
+    return this;
   }
 };
 
@@ -3382,7 +3427,7 @@ var StaticReelSet = class extends ReelSet {
       );
     }
   }
-  generateReels({ gameConfig: config }) {
+  generateReels(config) {
     this.validateConfig(config);
     if (this._strReels.length > 0) {
       this.reels = this._strReels.map((reel) => {
@@ -3400,6 +3445,7 @@ var StaticReelSet = class extends ReelSet {
     if (this.csvPath) {
       this.reels = this.parseReelsetCSV(this.csvPath, config);
     }
+    return this;
   }
 };
 
@@ -3524,8 +3570,8 @@ var StandaloneBoard = class {
   /**
    * Draws a board using specified reel stops.
    */
-  drawBoardWithForcedStops(reels, forcedStops) {
-    this.drawBoardMixed(reels, forcedStops);
+  drawBoardWithForcedStops(opts) {
+    this.drawBoardMixed(opts.reels, opts.forcedStops, opts.randomOffset);
   }
   /**
    * Draws a board using random reel stops.
@@ -3533,11 +3579,12 @@ var StandaloneBoard = class {
   drawBoardWithRandomStops(reels) {
     this.drawBoardMixed(reels);
   }
-  drawBoardMixed(reels, forcedStops) {
+  drawBoardMixed(reels, forcedStops, forcedStopsOffset) {
     this.board.drawBoardMixed({
       ctx: this.ctx,
       reels,
       forcedStops,
+      forcedStopsOffset,
       reelsAmount: this.reelsAmount,
       symbolsPerReel: this.symbolsPerReel,
       padSymbols: this.padSymbols
@@ -3547,7 +3594,7 @@ var StandaloneBoard = class {
    * Tumbles the board. All given symbols will be deleted and new symbols will fall from the top.
    */
   tumbleBoard(symbolsToDelete) {
-    this.board.tumbleBoard({
+    return this.board.tumbleBoard({
       ctx: this.ctx,
       symbolsToDelete,
       reelsAmount: this.reelsAmount,