@swrpg-online/dice 0.0.0-development

package/dist/hints.js

@@ -0,0 +1,251 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hints = void 0;
+exports.hintCostDisplayText = hintCostDisplayText;
+const types_1 = require("./types");
+// 1 advantage or 1 triumph
+const recoverOneStrain = "Recover one strain (may be applied more than once).";
+const addBoostDieToActiveAlly = "Add a boost die to the next allied active character's check.";
+const noticeImportantPoint = "Notice a single important point in the ongoing conflict, such as the location of a blast door's control panel or a weak point on an attack speeder.";
+const inflictCriticalInjury = "Inflict a Critical Injury with a successful attack that deals damage past soak (Advantage cost may vary).";
+const activateWeaponQuality = "Activate a weapon quality (Advantage cost may vary).";
+// 2 advantage or 1 triumph
+const performManeuver = "Perform an immediate free maneuver that does not exceed the two maneuver per turn limit.";
+const addSetbackDie = "Add a setback die to the targeted character's next check.";
+const addBoostDieToAnyAlly = "Add a boost die to any allied character's next check, including that of the active character.";
+// 3 advantage or 1 triumph
+const negateEnemy = "Negate the targeted enemy's defensive bonuses (such as the defense gained from cover, equipment, or performing the Guarded Stance maneuver) util the end of the current round.";
+const ignoreEnvironment = "Ignore penalizing environmental effects such as inclement weather, zero gravity, or similar circumstances until the end of the active character's next turn.";
+const disableOpponent = "When dealing damage to a target, have the attack disable the opponent or one piece of gear rather than dealing wounds or strain. This could include hobbling them temporarily with a shot to the leg, or disabling their comlink. This should be agreed upon by the player and the GM, and the effects are up to the GM (although Table 6-10: Critical Injury Result is a god resource to consult for possible effects). The effects should be temporary and not too excessive.";
+const gainDefense = "Gain + 1 melee or ranged defense until the end of the active character's next turn.";
+const dropWeapon = "Force the target to drop a melee or ranged weapon they are wielding.";
+// 1 triumph
+const upgradeDifficultyTargetedCharacter = "Upgrade the difficulty of the targeted character's next check.";
+const doSomethingVital = "Do something vital, such as shooting the controls to the nearby blast doors to seal them shut.";
+const upgradeAnyAllyCheck = "Upgrade any allied character's next check, including that of the current active character.";
+// 2 triumph
+const destroyEquipment = "When dealing damage to a target, have the attack destroy a piece of equipment the target is using, such as blowing up his blaster or destroying a personal shield generator.";
+// 1 threat or 1 despair
+const sufferStrain = "The active character suffers 1 strain.";
+const loseManeuverBenefit = "The active character loses the benefits of a prior maneuver (such as from taking cover or assuming a Guarded Stance) until they perform the maneuver again.";
+// 2 threat or 1 despair
+const freeManeuver = "An opponent may immediately perform one free maneuver in response to the active character's check.";
+const addBoostDieToTargetedCharacter = "Add a boost die to the targeted character's next check.";
+const sufferSetback = "The active character or an allied character suffers a setback die on their next action.";
+// 3 threat or 1 despair
+const fallProne = "The active character falls prone.";
+const gainSignificantAdvantage = "The active character grants the enemy a significant advantage in the ongoing encounter, such as accidentally blasting the controls to a bridge the active character was planning to use for their escape.";
+// 1 despair
+const outOfAmmo = "The character's ranged weapon imediately runs out of ammunition and may not be used for the remainder of the encounter.";
+const upgradeDifficultyAlliedCharacter = "Upgrade the difficulty of an allied character's next check, including that of the current active character.";
+const damagedItem = "The tool or melee weapon the character is using becomes damaged.";
+exports.hints = [
+    // 1 advantage or 1 triumph
+    {
+        description: recoverOneStrain,
+        cost: {
+            [types_1.SYMBOLS.ADVANTAGE]: 1,
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    {
+        description: addBoostDieToActiveAlly,
+        cost: {
+            [types_1.SYMBOLS.ADVANTAGE]: 1,
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    {
+        description: noticeImportantPoint,
+        cost: {
+            [types_1.SYMBOLS.ADVANTAGE]: 1,
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    {
+        description: inflictCriticalInjury,
+        cost: {
+            [types_1.SYMBOLS.ADVANTAGE]: 1,
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    {
+        description: activateWeaponQuality,
+        cost: {
+            [types_1.SYMBOLS.ADVANTAGE]: 1,
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    // 2 advantage or 1 triumph
+    {
+        description: performManeuver,
+        cost: {
+            [types_1.SYMBOLS.ADVANTAGE]: 2,
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    {
+        description: addSetbackDie,
+        cost: {
+            [types_1.SYMBOLS.ADVANTAGE]: 2,
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    {
+        description: addBoostDieToAnyAlly,
+        cost: {
+            [types_1.SYMBOLS.ADVANTAGE]: 2,
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    // 3 advantage or 1 triumph
+    {
+        description: negateEnemy,
+        cost: {
+            [types_1.SYMBOLS.ADVANTAGE]: 3,
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    {
+        description: ignoreEnvironment,
+        cost: {
+            [types_1.SYMBOLS.ADVANTAGE]: 3,
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    {
+        description: disableOpponent,
+        cost: {
+            [types_1.SYMBOLS.ADVANTAGE]: 3,
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    {
+        description: gainDefense,
+        cost: {
+            [types_1.SYMBOLS.ADVANTAGE]: 3,
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    {
+        description: dropWeapon,
+        cost: {
+            [types_1.SYMBOLS.ADVANTAGE]: 3,
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    // 1 triumph
+    {
+        description: upgradeDifficultyTargetedCharacter,
+        cost: {
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    {
+        description: doSomethingVital,
+        cost: {
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    {
+        description: upgradeAnyAllyCheck,
+        cost: {
+            [types_1.SYMBOLS.TRIUMPH]: 1,
+        },
+    },
+    // 2 triumph
+    {
+        description: destroyEquipment,
+        cost: {
+            [types_1.SYMBOLS.TRIUMPH]: 2,
+        },
+    },
+    // 1 threat or 1 despair
+    {
+        description: sufferStrain,
+        cost: {
+            [types_1.SYMBOLS.THREAT]: 1,
+            [types_1.SYMBOLS.DESPAIR]: 1,
+        },
+    },
+    {
+        description: loseManeuverBenefit,
+        cost: {
+            [types_1.SYMBOLS.THREAT]: 1,
+            [types_1.SYMBOLS.DESPAIR]: 1,
+        },
+    },
+    // 2 threat or 1 despair
+    {
+        description: freeManeuver,
+        cost: {
+            [types_1.SYMBOLS.THREAT]: 2,
+            [types_1.SYMBOLS.DESPAIR]: 1,
+        },
+    },
+    {
+        description: addBoostDieToTargetedCharacter,
+        cost: {
+            [types_1.SYMBOLS.THREAT]: 1,
+            [types_1.SYMBOLS.DESPAIR]: 1,
+        },
+    },
+    {
+        description: sufferSetback,
+        cost: {
+            [types_1.SYMBOLS.THREAT]: 2,
+            [types_1.SYMBOLS.DESPAIR]: 1,
+        },
+    },
+    // 3 threat or 1 despair
+    {
+        description: fallProne,
+        cost: {
+            [types_1.SYMBOLS.THREAT]: 3,
+            [types_1.SYMBOLS.DESPAIR]: 1,
+        },
+    },
+    {
+        description: gainSignificantAdvantage,
+        cost: {
+            [types_1.SYMBOLS.THREAT]: 3,
+            [types_1.SYMBOLS.DESPAIR]: 1,
+        },
+    },
+    // 1 despair
+    {
+        description: outOfAmmo,
+        cost: {
+            [types_1.SYMBOLS.DESPAIR]: 1,
+        },
+    },
+    {
+        description: upgradeDifficultyAlliedCharacter,
+        cost: {
+            [types_1.SYMBOLS.DESPAIR]: 1,
+        },
+    },
+    {
+        description: damagedItem,
+        cost: {
+            [types_1.SYMBOLS.DESPAIR]: 1,
+        },
+    },
+];
+function hintCostDisplayText(hint) {
+    if (!hint.cost || Object.keys(hint.cost).length === 0) {
+        return "No cost";
+    }
+    const parts = Object.entries(hint.cost)
+        .filter(([_, count]) => count && count > 0)
+        .map(([symbol, count]) => {
+        const symbolName = symbol.charAt(0).toUpperCase() + symbol.toLowerCase().slice(1);
+        const plural = count > 1 ? "s" : "";
+        return `${count} ${symbolName}${plural}`;
+    });
+    // Use "OR" in uppercase for clarity when multiple options exist
+    if (parts.length > 1) {
+        return parts.join(" OR ");
+    }
+    return parts.length > 0 ? parts[0] : "No cost";
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { roll } from "./dice";
+export type { DicePool, RollResult } from "./types";
+export { createSkillCheck, createCombatCheck, createOpposedCheck, createDifficultyPool, } from "./pools";

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDifficultyPool = exports.createOpposedCheck = exports.createCombatCheck = exports.createSkillCheck = exports.roll = void 0;
+var dice_1 = require("./dice");
+Object.defineProperty(exports, "roll", { enumerable: true, get: function () { return dice_1.roll; } });
+var pools_1 = require("./pools");
+Object.defineProperty(exports, "createSkillCheck", { enumerable: true, get: function () { return pools_1.createSkillCheck; } });
+Object.defineProperty(exports, "createCombatCheck", { enumerable: true, get: function () { return pools_1.createCombatCheck; } });
+Object.defineProperty(exports, "createOpposedCheck", { enumerable: true, get: function () { return pools_1.createOpposedCheck; } });
+Object.defineProperty(exports, "createDifficultyPool", { enumerable: true, get: function () { return pools_1.createDifficultyPool; } });

package/dist/pools.d.ts

@@ -0,0 +1,32 @@
+import { DicePool } from "./types";
+/**
+ * Creates a basic skill check dice pool
+ * @param ability Number of ability (green) dice
+ * @param proficiency Number of proficiency (yellow) dice
+ * @returns DicePool configured for a basic skill check
+ */
+export declare const createSkillCheck: (ability: number, proficiency: number) => DicePool;
+/**
+ * Creates a combat check dice pool with optional boost die
+ * @param ability Number of ability (green) dice
+ * @param proficiency Number of proficiency (yellow) dice
+ * @param boost Number of boost (blue) dice
+ * @returns DicePool configured for a combat check
+ */
+export declare const createCombatCheck: (ability: number, proficiency: number, boost?: number) => DicePool;
+/**
+ * Creates an opposed check dice pool
+ * @param ability Number of ability (green) dice
+ * @param proficiency Number of proficiency (yellow) dice
+ * @param difficulty Number of difficulty (purple) dice
+ * @param challenge Number of challenge (red) dice
+ * @returns DicePool configured for an opposed check
+ */
+export declare const createOpposedCheck: (ability: number, proficiency: number, difficulty: number, challenge?: number) => DicePool;
+/**
+ * Creates a difficulty check dice pool
+ * @param difficulty Number of difficulty (purple) dice
+ * @param challenge Number of challenge (red) dice
+ * @returns DicePool configured for a pure difficulty check
+ */
+export declare const createDifficultyPool: (difficulty: number, challenge?: number) => DicePool;

package/dist/pools.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDifficultyPool = exports.createOpposedCheck = exports.createCombatCheck = exports.createSkillCheck = void 0;
+/**
+ * Creates a basic skill check dice pool
+ * @param ability Number of ability (green) dice
+ * @param proficiency Number of proficiency (yellow) dice
+ * @returns DicePool configured for a basic skill check
+ */
+const createSkillCheck = (ability, proficiency) => ({
+    abilityDice: Math.max(0, ability),
+    proficiencyDice: Math.max(0, proficiency),
+});
+exports.createSkillCheck = createSkillCheck;
+/**
+ * Creates a combat check dice pool with optional boost die
+ * @param ability Number of ability (green) dice
+ * @param proficiency Number of proficiency (yellow) dice
+ * @param boost Number of boost (blue) dice
+ * @returns DicePool configured for a combat check
+ */
+const createCombatCheck = (ability, proficiency, boost = 0) => ({
+    abilityDice: Math.max(0, ability),
+    proficiencyDice: Math.max(0, proficiency),
+    boostDice: Math.max(0, boost),
+});
+exports.createCombatCheck = createCombatCheck;
+/**
+ * Creates an opposed check dice pool
+ * @param ability Number of ability (green) dice
+ * @param proficiency Number of proficiency (yellow) dice
+ * @param difficulty Number of difficulty (purple) dice
+ * @param challenge Number of challenge (red) dice
+ * @returns DicePool configured for an opposed check
+ */
+const createOpposedCheck = (ability, proficiency, difficulty, challenge = 0) => ({
+    abilityDice: Math.max(0, ability),
+    proficiencyDice: Math.max(0, proficiency),
+    difficultyDice: Math.max(0, difficulty),
+    challengeDice: Math.max(0, challenge),
+});
+exports.createOpposedCheck = createOpposedCheck;
+/**
+ * Creates a difficulty check dice pool
+ * @param difficulty Number of difficulty (purple) dice
+ * @param challenge Number of challenge (red) dice
+ * @returns DicePool configured for a pure difficulty check
+ */
+const createDifficultyPool = (difficulty, challenge = 0) => ({
+    difficultyDice: Math.max(0, difficulty),
+    challengeDice: Math.max(0, challenge),
+});
+exports.createDifficultyPool = createDifficultyPool;

package/dist/types.d.ts

@@ -0,0 +1,60 @@
+export type DicePool = {
+    boostDice?: number;
+    abilityDice?: number;
+    proficiencyDice?: number;
+    setBackDice?: number;
+    difficultyDice?: number;
+    challengeDice?: number;
+    forceDice?: number;
+};
+export type DiceResult = {
+    successes: number;
+    failures: number;
+    advantages: number;
+    threats: number;
+    triumphs: number;
+    despair: number;
+    lightSide: number;
+    darkSide: number;
+    hints?: string[];
+};
+export type DieType = "boost" | "ability" | "proficiency" | "setback" | "difficulty" | "challenge" | "force";
+export type DetailedDieResult = {
+    type: DieType;
+    roll: number;
+    result: DiceResult;
+};
+export type RollResult = {
+    results: DetailedDieResult[];
+    summary: DiceResult;
+};
+export declare const SYMBOLS: {
+    readonly SUCCESS: "SUCCESS";
+    readonly FAILURE: "FAILURE";
+    readonly ADVANTAGE: "ADVANTAGE";
+    readonly THREAT: "THREAT";
+    readonly TRIUMPH: "TRIUMPH";
+    readonly DESPAIR: "DESPAIR";
+    readonly LIGHT: "LIGHT";
+    readonly DARK: "DARK";
+};
+export type Symbol = keyof typeof SYMBOLS;
+export type RollOptions = {
+    hints?: boolean;
+    /**
+     * Maximum number of dice allowed per die type.
+     * Default: 100
+     */
+    maxDicePerType?: number;
+    /**
+     * Maximum total number of dice allowed in a single roll.
+     * Default: 500
+     */
+    maxTotalDice?: number;
+    /**
+     * Whether to throw an error when dice limits are exceeded.
+     * If false, dice counts will be silently capped to the maximum.
+     * Default: false
+     */
+    throwOnLimitExceeded?: boolean;
+};

package/dist/types.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SYMBOLS = void 0;
+exports.SYMBOLS = {
+    SUCCESS: "SUCCESS",
+    FAILURE: "FAILURE",
+    ADVANTAGE: "ADVANTAGE",
+    THREAT: "THREAT",
+    TRIUMPH: "TRIUMPH",
+    DESPAIR: "DESPAIR",
+    LIGHT: "LIGHT",
+    DARK: "DARK",
+};

package/package.json

@@ -0,0 +1,98 @@
+{
+  "name": "@swrpg-online/dice",
+  "version": "0.0.0-development",
+  "description": "A TypeScript library that creates dice rolls using the narrative dice system for the Star Wars Roleplaying Game by Fantasy Flight Games and Edge Studio.",
+  "keywords": [
+    "swrpg",
+    "dice",
+    "rpg",
+    "star wars",
+    "star-wars",
+    "rpg",
+    "dice",
+    "edge-studio",
+    "narrative-dice",
+    "typescript",
+    "cli",
+    "swrpg",
+    "genesys",
+    "fantasy-flight-games",
+    "ffg",
+    "roleplaying",
+    "tabletop",
+    "dice-roller"
+  ],
+  "homepage": "https://github.com/swrpg-online/dice",
+  "bugs": {
+    "url": "https://github.com/swrpg-online/dice/issues"
+  },
+  "license": "MIT",
+  "author": "@swrpg-online",
+  "contributors": [],
+  "main": "dist/bundle.cjs.js",
+  "module": "dist/bundle.esm.js",
+  "browser": "dist/bundle.umd.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "swrpg-dice": "dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/bundle.esm.js",
+      "require": "./dist/bundle.cjs.js",
+      "browser": "./dist/bundle.umd.js",
+      "default": "./dist/index.js"
+    },
+    "./cli": "./dist/cli.js",
+    "./bundle": {
+      "import": "./dist/bundle.esm.js",
+      "require": "./dist/bundle.cjs.js",
+      "browser": "./dist/bundle.umd.js"
+    }
+  },
+  "directories": {
+    "test": "tests"
+  },
+  "files": [
+    "dist/**"
+  ],
+  "scripts": {
+    "test": "npx jest --verbose",
+    "ci:test": "tsc --noEmit && npx jest --verbose",
+    "build": "tsc && npm run bundle",
+    "bundle": "rollup -c",
+    "prepare": "npm run build && husky install"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^28.0.6",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-typescript": "^12.1.4",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^11.0.1",
+    "@semantic-release/npm": "^12.0.1",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.10.0",
+    "husky": "^8.0.3",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.2.10",
+    "prettier": "3.4.1",
+    "rollup": "^2.79.2",
+    "rollup-plugin-terser": "^7.0.2",
+    "semantic-release": "^24.2.0",
+    "ts-jest": "^29.4.1",
+    "tslib": "^2.8.1",
+    "typescript": "^5.7.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/swrpg-online/dice"
+  },
+  "engines": {
+    "node": ">=21"
+  },
+  "lint-staged": {
+    "**/*": "prettier --write --ignore-unknown"
+  }
+}