@randsum/blades
Blades in the Dark compatible dice rolling for Randsum
[](https://www.npmjs.com/package/@randsum/blades)
[](https://bundlephobia.com/package/@randsum/blades)
[](https://www.npmjs.com/package/@randsum/blades)
[](https://github.com/RANDSUM/randsum/blob/main/LICENSE)
[](https://www.npmjs.com/package/@randsum/blades)
A utility for rolling dice in [Forged in the Dark](https://bladesinthedark.com/) systems!
- đ˛ Standard Blades in the Dark position and effect rolls
- đ¯ Automatic handling of dice pools
- đ Full TypeScript support
- đĒļ Lightweight implementation
## Installation
```bash
npm install @randsum/blades
# or
yarn add @randsum/blades
# or
bun add @randsum/blades
```
## Usage
```typescript
import { rollBlades } from "@randsum/blades"
import type { BladesRollResult } from "@randsum/blades"
// Basic roll with dice pool
const { outcome, result } = rollBlades(2)
console.log(outcome) // 'critical' | 'success' | 'partial' | 'failure'
// Different dice pool sizes
rollBlades(1) // Desperate position
rollBlades(2) // Risky position
rollBlades(3) // Controlled position
rollBlades(4) // Controlled with assistance
```
## API Reference
### `roll`
Makes a Blades in the Dark roll, returning the result based on the highest die.
```typescript
function rollBlades(dicePool: number): BladesRollResult
```
**Parameters:**
- `dicePool`: Number of d6 dice to roll (typically 1-4)
**Returns:**
- `'critical'`: Rolled 6 on multiple dice (critical success)
- `'success'`: Highest die was 4-6 (full success)
- `'partial'`: Highest die was 1-3 (partial success/complication)
- `'failure'`: No dice rolled (should not occur with valid input)
**Result Interpretation:**
```typescript
type BladesResult = "critical" | "success" | "partial" | "failure"
```
## Related Packages
- [@randsum/roller](https://github.com/RANDSUM/randsum/tree/main/packages/roller): Core dice rolling implementation