@logic-pad/core 0.13.3 → 0.14.0

package/assets/logic-core.global.d.ts

@@ -344,6 +344,8 @@ declare global {
     get value(): T;
   }
   export declare abstract class Configurable {
+    abstract get title(): string;
+    abstract get configExplanation(): string;
     get configs(): readonly AnyConfig[] | null;
     abstract copyWith(props: Record<string, unknown>): this;
     /**
@@ -357,6 +359,7 @@ declare global {
   export declare abstract class Instruction extends Configurable {
     abstract get id(): string;
     abstract get explanation(): string;
+    get configExplanation(): string;
     abstract createExampleGrid(): GridData;
     /**
      * Indicates that validation by logic is not available and the solution must be used for validation
@@ -492,6 +495,9 @@ declare global {
      * Ranges from 0 to 1
      */
     readonly velocity: number | null;
+    readonly title = 'Music Grid - Row';
+    readonly configExplanation =
+      'Configure the playback settings from this tile onwards.';
     private static readonly CONFIGS;
     constructor(
       /**
@@ -520,6 +526,9 @@ declare global {
     readonly pedal: boolean | null;
     readonly checkpoint: boolean;
     readonly rows: readonly Row[];
+    readonly title = 'Music Grid - Control Line';
+    readonly configExplanation =
+      'Configure the playback settings from this point onwards.';
     private static readonly CONFIGS;
     /**
      * Configure playback settings, taking effect at the given column (inclusive)
@@ -565,6 +574,8 @@ declare global {
     readonly controlLines: readonly ControlLine[];
     readonly track: GridData | null;
     readonly normalizeVelocity: boolean;
+    readonly title = 'Music Grid';
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     private static readonly SEARCH_VARIANTS;
@@ -621,6 +632,8 @@ declare global {
     ): ControlLine[];
   }
   export declare class CompletePatternRule extends Rule {
+    readonly title = 'Complete The Pattern';
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly SEARCH_VARIANTS;
     /**
@@ -639,6 +652,8 @@ declare global {
     get isSingleton(): boolean;
   }
   export declare class UndercluedRule extends Rule {
+    readonly title = 'Underclued';
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly SEARCH_VARIANTS;
     /**
@@ -665,6 +680,8 @@ declare global {
   export declare class WrapAroundRule extends Rule implements GetTileHandler {
     readonly horizontal: Wrapping;
     readonly vertical: Wrapping;
+    readonly title = 'Wrap Around';
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID_NONE;
     private static readonly EXAMPLE_GRID_HORIZONTAL;
     private static readonly EXAMPLE_GRID_VERTICAL;
@@ -1225,6 +1242,7 @@ declare global {
     readonly type: ConfigType;
     readonly field: string;
     readonly description: string;
+    readonly explanation?: string;
     readonly default: T;
     readonly configurable: boolean;
   }
@@ -1495,6 +1513,7 @@ declare global {
     tileMapper?: (tile: TileData) => TileData
   ): GridData;
   export declare class BanPatternRule extends Rule {
+    readonly title = 'Ban Pattern';
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     private static readonly SEARCH_VARIANTS;
@@ -1517,6 +1536,8 @@ declare global {
   }
   export declare class CellCountPerZoneRule extends Rule {
     readonly color: Color;
+    readonly title = 'Equal Count Per Zone';
+    get configExplanation(): string;
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID_LIGHT;
     private static readonly EXAMPLE_GRID_DARK;
@@ -1540,6 +1561,7 @@ declare global {
   export declare class CellCountRule extends Rule {
     readonly color: Color;
     readonly count: number;
+    readonly title = 'Total Count';
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID_LIGHT;
     private static readonly EXAMPLE_GRID_DARK;
@@ -1563,6 +1585,7 @@ declare global {
   }
   export declare class ConnectAllRule extends Rule {
     readonly color: Color;
+    readonly title = 'Connect All';
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID_LIGHT;
     private static readonly EXAMPLE_GRID_DARK;
@@ -1600,6 +1623,7 @@ declare global {
     withColor(color: Color): this;
   }
   export declare class ContainsShapeRule extends RegionShapeRule {
+    readonly title = 'Areas Contain Pattern';
     private static readonly EXAMPLE_GRID_LIGHT;
     private static readonly EXAMPLE_GRID_DARK;
     private static readonly CONFIGS;
@@ -1625,6 +1649,8 @@ declare global {
   export declare class CustomRule extends Rule {
     readonly description: string;
     readonly grid: GridData;
+    readonly title = 'Custom Rule';
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     static readonly configs: readonly AnyConfig[];
     private static readonly SEARCH_VARIANTS;
@@ -1657,6 +1683,8 @@ declare global {
     readonly regenInterval: number;
     readonly startFull: boolean;
     readonly solvePath: Position$1[];
+    readonly title = 'Foresight';
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     private static readonly SEARCH_VARIANTS;
@@ -1697,6 +1725,7 @@ declare global {
     implements FinalValidationHandler
   {
     readonly count: number;
+    readonly title = 'Lying Symbols';
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     private static readonly SEARCH_VARIANTS;
@@ -1727,6 +1756,8 @@ declare global {
   {
     readonly solution: GridData;
     readonly visible: boolean;
+    readonly title = 'Alternate Solution';
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     private static readonly SEARCH_VARIANTS;
@@ -1770,6 +1801,7 @@ declare global {
     implements SymbolValidationHandler
   {
     readonly number: number;
+    readonly title = 'Off By X';
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     private static readonly SEARCH_VARIANTS;
@@ -1799,6 +1831,8 @@ declare global {
     implements SetGridHandler, FinalValidationHandler
   {
     readonly editor: boolean;
+    readonly title = 'Perfection';
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly SEARCH_VARIANTS;
     /**
@@ -1842,6 +1876,7 @@ declare global {
   export declare class RegionAreaRule extends Rule {
     readonly color: Color;
     readonly size: number;
+    readonly title = 'Region Area Size';
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID_DARK;
     private static readonly EXAMPLE_GRID_LIGHT;
@@ -1865,6 +1900,7 @@ declare global {
     withSize(size: number): this;
   }
   export declare class SameShapeRule extends RegionShapeRule {
+    readonly title = 'Same Shape Areas';
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID_LIGHT;
     private static readonly EXAMPLE_GRID_DARK;
@@ -1887,6 +1923,7 @@ declare global {
     readonly color: Color;
     readonly count: number;
     readonly comparison: Comparison;
+    readonly title = 'Symbols Per Area';
     private static readonly SYMBOL_POSITIONS;
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRIDS;
@@ -1920,6 +1957,7 @@ declare global {
     private static countAllSymbolsOfPosition;
   }
   export declare class UniqueShapeRule extends RegionShapeRule {
+    readonly title = 'Unique Shape Areas';
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID_LIGHT;
     private static readonly EXAMPLE_GRID_DARK;
@@ -2101,8 +2139,11 @@ declare global {
     parseRules(_input: string): Rule[];
     stringifySymbols(symbols: ReadonlyMap<string, readonly Symbol$1[]>): string;
     parseSymbols(_input: string): Map<string, Symbol$1[]>;
+    stringifyGrid(grid: GridData): string;
     parseGrid(_input: string): GridData;
+    stringifyGridWithSolution(puzzle: PuzzleData): string;
     parseGridWithSolution(_input: string): PuzzleData;
+    stringifyPuzzle(puzzle: Puzzle): string;
     parsePuzzle(_input: string): Puzzle;
   }
   /**
@@ -2338,6 +2379,7 @@ declare global {
     withNumber(number: number): this;
   }
   export declare class AreaNumberSymbol extends NumberSymbol {
+    readonly title = 'Area Number';
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     /**
@@ -2378,6 +2420,7 @@ declare global {
   }
   export declare class DartSymbol extends NumberSymbol {
     readonly orientation: Orientation;
+    readonly title = 'Dart';
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     /**
@@ -2418,7 +2461,7 @@ declare global {
     private buildCheckAndRating;
   }
   export type DirectionLinkerMap = Record<Direction, Direction>;
-  export declare class DirectionLinkerSymbol extends Symbol$1 {
+  export declare abstract class DirectionLinkerSymbol extends Symbol$1 {
     readonly x: number;
     readonly y: number;
     private static readonly CONFIGS;
@@ -2439,7 +2482,6 @@ declare global {
     createExampleGrid(): GridData;
     private deltaCoordinate;
     validateSymbol(grid: GridData): State;
-    copyWith({ x, y }: { x?: number; y?: number }): this;
     private getInitialCheckedCouples;
   }
   export declare abstract class DirectionLinkerBTModule extends BTModule {
@@ -2455,6 +2497,7 @@ declare global {
     ): Position$1 | null;
   }
   export declare class FocusSymbol extends NumberSymbol {
+    readonly title = 'Focus Number';
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     /**
@@ -2494,6 +2537,7 @@ declare global {
   export declare class GalaxySymbol extends DirectionLinkerSymbol {
     readonly x: number;
     readonly y: number;
+    readonly title = 'Galaxy';
     private static readonly linkedDirections;
     /**
      * **Galaxies are centers of rotational symmetry**
@@ -2522,6 +2566,7 @@ declare global {
     readonly x: number;
     readonly y: number;
     readonly letter: string;
+    readonly title = 'Letter';
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     /**
@@ -2559,6 +2604,7 @@ declare global {
     readonly x: number;
     readonly y: number;
     readonly orientation: Orientation;
+    readonly title = 'Lotus';
     private static readonly linkedDirectionsFromOrientation;
     /**
      * **Areas containing this symbol must be symmetrical**
@@ -2595,6 +2641,7 @@ declare global {
     checkGlobal(grid: BTGridData): false | CheckResult;
   }
   export declare class MinesweeperSymbol extends NumberSymbol {
+    readonly title = 'Minesweeper Number';
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     /**
@@ -2643,6 +2690,7 @@ declare global {
   export declare class MyopiaSymbol extends MultiEntrySymbol {
     readonly diagonals: boolean;
     readonly directions: OrientationToggle;
+    get title(): 'Framed Myopia Arrow' | 'Myopia Arrow';
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     private static readonly EXAMPLE_DIAGONAL_GRID;
@@ -2685,6 +2733,7 @@ declare global {
     checkGlobal(grid: BTGridData): CheckResult | false;
   }
   export declare class ViewpointSymbol extends NumberSymbol {
+    readonly title = 'Viewpoint Number';
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     /**
@@ -2856,6 +2905,8 @@ declare global {
   export declare class CustomIconSymbol extends CustomSymbol {
     readonly icon: string;
     readonly rotation: number;
+    readonly title = 'Custom Icon Symbol';
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     /**
@@ -2899,6 +2950,8 @@ declare global {
   export declare class CustomTextSymbol extends CustomSymbol {
     readonly text: string;
     readonly rotation: number;
+    readonly title = 'Custom Text Symbol';
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     /**
@@ -2946,6 +2999,8 @@ declare global {
     readonly x: number;
     readonly y: number;
     readonly revealLocation: boolean;
+    readonly title = 'Hidden Symbol Marker';
+    get configExplanation(): string;
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID;
     /**

package/dist/data/config.d.ts

@@ -26,6 +26,7 @@ export interface Config<T> {
     readonly type: ConfigType;
     readonly field: string;
     readonly description: string;
+    readonly explanation?: string;
     readonly default: T;
     readonly configurable: boolean;
 }

package/dist/data/configurable.d.ts

@@ -1,5 +1,7 @@
 import { AnyConfig } from './config.js';
 export default abstract class Configurable {
+    abstract get title(): string;
+    abstract get configExplanation(): string;
     get configs(): readonly AnyConfig[] | null;
     abstract copyWith(props: Record<string, unknown>): this;
     /**

package/dist/data/instruction.d.ts

@@ -4,6 +4,7 @@ import { Mode } from './primitives.js';
 export default abstract class Instruction extends Configurable {
     abstract get id(): string;
     abstract get explanation(): string;
+    get configExplanation(): string;
     abstract createExampleGrid(): GridData;
     /**
      * Indicates that validation by logic is not available and the solution must be used for validation

package/dist/data/instruction.js

@@ -1,5 +1,8 @@
 import Configurable from './configurable.js';
 export default class Instruction extends Configurable {
+    get configExplanation() {
+        return this.explanation;
+    }
     /**
      * Indicates that validation by logic is not available and the solution must be used for validation
      */

package/dist/data/puzzle.js

@@ -77,7 +77,9 @@ export function validatePuzzleChecklist(metadata, gridWithSolution, state) {
         });
         checklist.items.push({
             id: 'solutionIsNotEmpty',
-            success: gridWithSolution.tiles.some(row => row.some(tile => !tile.fixed && tile.color !== Color.Gray)),
+            success: gridWithSolution.musicGrid.value
+                ? gridWithSolution.tiles.some(row => row.some(tile => !tile.fixed && tile.color === Color.Dark))
+                : gridWithSolution.tiles.some(row => row.some(tile => !tile.fixed && tile.color !== Color.Gray)),
             mandatory: true,
         });
     }

package/dist/data/rules/banPatternRule.d.ts

@@ -4,6 +4,7 @@ import { RuleState } from '../primitives.js';
 import { Shape } from '../shapes.js';
 import Rule, { SearchVariant } from './rule.js';
 export default class BanPatternRule extends Rule {
+    readonly title = "Ban Pattern";
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     private static readonly SEARCH_VARIANTS;

package/dist/data/rules/banPatternRule.js

@@ -12,6 +12,12 @@ class BanPatternRule extends Rule {
      */
     constructor(pattern) {
         super();
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Ban Pattern'
+        });
         Object.defineProperty(this, "pattern", {
             enumerable: true,
             configurable: true,
@@ -51,6 +57,9 @@ class BanPatternRule extends Rule {
         });
         const width = maxX - minX + 1;
         const height = maxY - minY + 1;
+        if (!Number.isFinite(width) || !Number.isFinite(height)) {
+            return GridData.create(0, 0);
+        }
         const tiles = array(width, height, (x, y) => {
             const tile = this.pattern.getTile(x + minX, y + minY);
             if (!tile.exists || tile.color !== Color.Gray)
@@ -130,6 +139,7 @@ Object.defineProperty(BanPatternRule, "CONFIGS", {
             resizable: true,
             field: 'pattern',
             description: 'Pattern',
+            explanation: 'The pattern to be banned. Can be a mix of dark and light tiles.',
             configurable: true,
         },
     ])

package/dist/data/rules/cellCountPerZoneRule.d.ts

@@ -4,6 +4,8 @@ import { Color, RuleState } from '../primitives.js';
 import Rule, { SearchVariant } from './rule.js';
 export default class CellCountPerZoneRule extends Rule {
     readonly color: Color;
+    readonly title = "Equal Count Per Zone";
+    get configExplanation(): string;
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID_LIGHT;
     private static readonly EXAMPLE_GRID_DARK;

package/dist/data/rules/cellCountPerZoneRule.js

@@ -5,6 +5,9 @@ import GridZones from '../gridZones.js';
 import { Color, State } from '../primitives.js';
 import Rule from './rule.js';
 class CellCountPerZoneRule extends Rule {
+    get configExplanation() {
+        return 'Use the zone tool to define areas on the grid.';
+    }
     /**
      * **Zones of the same size have the same number of <color> cells.**
      *
@@ -18,6 +21,12 @@ class CellCountPerZoneRule extends Rule {
             writable: true,
             value: color
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Equal Count Per Zone'
+        });
         this.color = color;
     }
     get id() {

package/dist/data/rules/cellCountRule.d.ts

@@ -5,6 +5,7 @@ import Rule, { SearchVariant } from './rule.js';
 export default class CellCountRule extends Rule {
     readonly color: Color;
     readonly count: number;
+    readonly title = "Total Count";
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID_LIGHT;
     private static readonly EXAMPLE_GRID_DARK;

package/dist/data/rules/cellCountRule.js

@@ -24,6 +24,12 @@ class CellCountRule extends Rule {
             writable: true,
             value: count
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Total Count'
+        });
         this.color = color;
         this.count = count;
     }

package/dist/data/rules/completePatternRule.d.ts

@@ -2,6 +2,8 @@ import GridData from '../grid.js';
 import { RuleState } from '../primitives.js';
 import Rule, { SearchVariant } from './rule.js';
 export default class CompletePatternRule extends Rule {
+    readonly title = "Complete The Pattern";
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly SEARCH_VARIANTS;
     /**

package/dist/data/rules/completePatternRule.js

@@ -2,6 +2,9 @@ import GridData from '../grid.js';
 import { MajorRule, State } from '../primitives.js';
 import Rule from './rule.js';
 class CompletePatternRule extends Rule {
+    get configExplanation() {
+        return 'Complete the grid by pattern recognition. Your provided solution may override auto-validation.';
+    }
     /**
      * **Complete the pattern**
      *
@@ -9,6 +12,12 @@ class CompletePatternRule extends Rule {
      */
     constructor() {
         super();
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Complete The Pattern'
+        });
     }
     get id() {
         return MajorRule.CompletePattern;

package/dist/data/rules/connectAllRule.d.ts

@@ -4,6 +4,7 @@ import { Color, RuleState } from '../primitives.js';
 import Rule, { SearchVariant } from './rule.js';
 export default class ConnectAllRule extends Rule {
     readonly color: Color;
+    readonly title = "Connect All";
     private static readonly CONFIGS;
     private static readonly EXAMPLE_GRID_LIGHT;
     private static readonly EXAMPLE_GRID_DARK;

package/dist/data/rules/connectAllRule.js

@@ -17,6 +17,12 @@ class ConnectAllRule extends Rule {
             writable: true,
             value: color
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Connect All'
+        });
         this.color = color;
     }
     get id() {

package/dist/data/rules/containsShapeRule.d.ts

@@ -5,6 +5,7 @@ import { Shape } from '../shapes.js';
 import RegionShapeRule from './regionShapeRule.js';
 import { SearchVariant } from './rule.js';
 export default class ContainsShapeRule extends RegionShapeRule {
+    readonly title = "Areas Contain Pattern";
     private static readonly EXAMPLE_GRID_LIGHT;
     private static readonly EXAMPLE_GRID_DARK;
     private static readonly CONFIGS;

package/dist/data/rules/containsShapeRule.js

@@ -13,6 +13,12 @@ class ContainsShapeRule extends RegionShapeRule {
      */
     constructor(color, pattern) {
         super(color);
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Areas Contain Pattern'
+        });
         Object.defineProperty(this, "pattern", {
             enumerable: true,
             configurable: true,
@@ -52,6 +58,9 @@ class ContainsShapeRule extends RegionShapeRule {
         });
         const width = maxX - minX + 1;
         const height = maxY - minY + 1;
+        if (!Number.isFinite(width) || !Number.isFinite(height)) {
+            return GridData.create(0, 0);
+        }
         const tiles = array(width, height, (x, y) => {
             const tile = this.pattern.getTile(x + minX, y + minY);
             if (!tile.exists || tile.color !== Color.Gray)
@@ -134,6 +143,7 @@ Object.defineProperty(ContainsShapeRule, "CONFIGS", {
             resizable: true,
             field: 'pattern',
             description: 'Pattern',
+            explanation: 'The pattern to be contained. Must only include tiles of the selected color.',
             configurable: true,
         },
     ])

package/dist/data/rules/customRule.d.ts

@@ -5,6 +5,8 @@ import Rule, { SearchVariant } from './rule.js';
 export default class CustomRule extends Rule {
     readonly description: string;
     readonly grid: GridData;
+    readonly title = "Custom Rule";
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     static readonly configs: readonly AnyConfig[];
     private static readonly SEARCH_VARIANTS;

package/dist/data/rules/customRule.js

@@ -3,6 +3,9 @@ import GridData from '../grid.js';
 import { State } from '../primitives.js';
 import Rule from './rule.js';
 class CustomRule extends Rule {
+    get configExplanation() {
+        return 'A customizable rule. Your provided solution may override auto-validation.';
+    }
     /**
      * A custom rule with a description and thumbnail grid.
      *
@@ -25,6 +28,12 @@ class CustomRule extends Rule {
             writable: true,
             value: grid
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Custom Rule'
+        });
         this.description = description;
         this.grid = grid;
     }
@@ -69,6 +78,7 @@ Object.defineProperty(CustomRule, "configs", {
             default: 'A *custom* rule',
             field: 'description',
             description: 'Description',
+            explanation: 'A short descriptive text. Use *asterisks* to highlight keywords.',
             configurable: true,
         },
         {
@@ -76,6 +86,7 @@ Object.defineProperty(CustomRule, "configs", {
             default: CustomRule.EXAMPLE_GRID,
             field: 'grid',
             description: 'Thumbnail Grid',
+            explanation: 'An example grid showing the rule.',
             configurable: true,
         },
     ])

package/dist/data/rules/foresightRule.d.ts

@@ -7,6 +7,8 @@ export default class ForesightRule extends Rule {
     readonly regenInterval: number;
     readonly startFull: boolean;
     readonly solvePath: Position[];
+    readonly title = "Foresight";
+    get configExplanation(): string;
     private static readonly EXAMPLE_GRID;
     private static readonly CONFIGS;
     private static readonly SEARCH_VARIANTS;

package/dist/data/rules/foresightRule.js

@@ -4,6 +4,9 @@ import { State, Mode } from '../primitives.js';
 import CustomIconSymbol from '../symbols/customIconSymbol.js';
 import Rule from './rule.js';
 class ForesightRule extends Rule {
+    get configExplanation() {
+        return 'Provide automatic hints to the player.';
+    }
     /**
      * **Foresight: Show hints**
      */
@@ -33,6 +36,12 @@ class ForesightRule extends Rule {
             writable: true,
             value: solvePath
         });
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Foresight'
+        });
         this.count = count;
         this.regenInterval = regenInterval;
         this.startFull = startFull;
@@ -93,6 +102,7 @@ Object.defineProperty(ForesightRule, "CONFIGS", {
             min: 1,
             field: 'count',
             description: 'Foresight count',
+            explanation: 'Maximum number of foresight charges that can be stored.',
             configurable: true,
         },
         {
@@ -101,6 +111,7 @@ Object.defineProperty(ForesightRule, "CONFIGS", {
             min: 1,
             field: 'regenInterval',
             description: 'Regen Interval (seconds)',
+            explanation: 'Time taken for one foresight charge to regenerate.',
             configurable: true,
         },
         {
@@ -108,6 +119,7 @@ Object.defineProperty(ForesightRule, "CONFIGS", {
             default: false,
             field: 'startFull',
             description: 'Start with full foresight',
+            explanation: 'Whether to start with all foresight charges available.',
             configurable: true,
         },
         {
@@ -115,6 +127,7 @@ Object.defineProperty(ForesightRule, "CONFIGS", {
             default: [],
             field: 'solvePath',
             description: 'Intended solve path',
+            explanation: 'A logical solve path of the puzzle. Foresight will hint at the location of the next tile if this is available.',
             configurable: true,
         },
     ])