@randsum/salvageunion
Salvage Union compatible dice rolling for Randsum
[](https://www.npmjs.com/package/@randsum/salvageunion)
[](https://bundlephobia.com/package/@randsum/salvageunion)
[](https://www.npmjs.com/package/@randsum/salvageunion)
[](https://github.com/RANDSUM/randsum/blob/main/LICENSE)
[](https://www.npmjs.com/package/@randsum/salvageunion)
[](https://codecov.io/gh/RANDSUM/randsum)
A type-safe implementation of [Salvage Union](https://www.geargrindergames.com/salvage-union) dice rolling mechanics that supports:
- ðē Standard 2d10 rolls with modifiers
- ðŊ Automatic outcome determination
- ð Built-in roll tables
- ð Full TypeScript support
- ðŠķ Tree-shakeable implementation
## Installation
```bash
npm install @randsum/salvageunion
# or
yarn add @randsum/salvageunion
# or
bun add @randsum/salvageunion
```
## Usage
```typescript
import { rollTable } from "@randsum/salvageunion"
import type { SalvageUnionTableResult } from "@randsum/salvageunion"
// Basic roll with default table
const result = rollTable()
// Returns table result with hit type, label, description, and roll value
// Roll with specific table
const result = rollTable("Morale")
// Type-safe result handling
const { hit, label, description, roll } = rollTable("Core Mechanic")
switch (hit) {
case "Nailed It":
// 20
break
case "Success":
// 11-19
break
case "Tough Choice":
// 6-10
break
case "Failure":
// 2-5
break
case "Cascade Failure":
// 1
break
}
```
## API Reference
### `rollTable`
Makes a d20 roll following Salvage Union rules, returning a table result object with hit type, label, description, and roll value.
```typescript
function rollTable(tableName?: SalvageUnionTableName): SalvageUnionTableResult
```
### Roll Tables
The package includes all official Salvage Union roll tables, organized into collections:
#### PCTables
- `Core Mechanic`: Standard action resolution
- `Critical Damage`: Vehicle critical hits
- `Critical Injury`: Character injuries
- `Reactor Overload`: Mech reactor issues
- `Area Salvage`: Random salvage finds
- `Mech Salvage`: Salvageable mech parts
#### NPCTables
- `NPC Action`: Random NPC actions
- `Reaction`: NPC reactions to PCs
- `Morale`: NPC morale checks
- `Group Initiative`: Group combat initiative
- `Retreat`: NPC retreat behavior
## Related Packages
- [@randsum/roller](https://github.com/RANDSUM/randsum/tree/main/packages/roller): Core dice rolling implementation