@shipload/sdk 1.0.0-next.7 → 1.0.0-next.70

package/src/data/capabilities.ts

@@ -8,6 +8,14 @@ export interface StatMapping {
     stat: string
     capability: string
     attribute: string
+    source: string // producing module/role, always present
+}
+
+export interface CapabilityAttributeRow {
+    capability: string
+    attribute: string
+    description: string
+    source?: string // producing module/role; absent when no formula-derived producer exists
 }
 
 export const capabilityNames: string[] = [
@@ -15,57 +23,80 @@ export const capabilityNames: string[] = [
     'Storage',
     'Movement',
     'Energy',
-    'Loader',
+    'Loading',
     'Gathering',
     'Warp',
-    'Crafter',
+    'Crafting',
+    'Build',
     'Launch',
-    'Hauler',
+    'Hauling',
 ]
 
 export const capabilityAttributes: CapabilityAttribute[] = [
     {capability: 'Hull', attribute: 'mass', description: 'Total mass of the hull'},
-    {capability: 'Storage', attribute: 'capacity', description: 'Maximum mass that can be stored'},
     {
         capability: 'Storage',
-        attribute: 'bonus',
-        description: 'Capacity bonus added by an installed Storage module',
+        attribute: 'capacity',
+        description: 'Cargo capacity added by hulls and installed Cargo Hold modules',
+    },
+    {
+        capability: 'Storage',
+        attribute: 'drain',
+        description: 'Fixed normal-travel drain contributed by an installed Cargo Hold',
     },
     {capability: 'Movement', attribute: 'thrust', description: 'Propulsion force'},
-    {capability: 'Movement', attribute: 'drain', description: 'Energy consumed per movement'},
-    {capability: 'Energy', attribute: 'capacity', description: 'Maximum energy storage'},
+    {
+        capability: 'Movement',
+        attribute: 'drain',
+        description: 'Total installed energy consumed per tile of normal travel',
+    },
+    {
+        capability: 'Energy',
+        attribute: 'capacity',
+        description: 'Energy capacity from Power Cores and installed Battery Bank modules',
+    },
     {capability: 'Energy', attribute: 'recharge', description: 'Energy regeneration rate'},
-    {capability: 'Loader', attribute: 'mass', description: 'Weight of the loader unit itself'},
-    {capability: 'Loader', attribute: 'thrust', description: 'Loading speed/force'},
+    {capability: 'Loading', attribute: 'mass', description: 'Weight of the loader unit itself'},
+    {capability: 'Loading', attribute: 'thrust', description: 'Loading speed/force'},
+    {
+        capability: 'Loading',
+        attribute: 'quantity',
+        description: 'Number of cargo items moved per load operation',
+    },
     {capability: 'Gathering', attribute: 'yield', description: 'Mass gathered per second'},
     {capability: 'Gathering', attribute: 'drain', description: 'Energy consumed per gather'},
     {capability: 'Gathering', attribute: 'depth', description: 'Maximum gather depth'},
-    {capability: 'Gathering', attribute: 'speed', description: 'Gathering speed/penetration'},
     {capability: 'Warp', attribute: 'range', description: 'Maximum warp distance'},
-    {capability: 'Crafter', attribute: 'speed', description: 'Crafting time per item'},
+    {capability: 'Crafting', attribute: 'speed', description: 'Crafting time per item'},
     {
-        capability: 'Crafter',
+        capability: 'Crafting',
         attribute: 'drain',
         description: 'Energy consumed per second while crafting',
     },
-    {capability: 'Crafter', attribute: 'quality', description: 'Modifier on output quality'},
+    {capability: 'Crafting', attribute: 'quality', description: 'Modifier on output quality'},
+    {capability: 'Build', attribute: 'speed', description: 'Build progress per second'},
+    {
+        capability: 'Build',
+        attribute: 'drain',
+        description: 'Energy consumed per second while building',
+    },
     {capability: 'Launch', attribute: 'range', description: 'Maximum launch distance'},
     {capability: 'Launch', attribute: 'capacity', description: 'Maximum mass per launch'},
     {capability: 'Launch', attribute: 'drain', description: 'Energy consumed per launch'},
     {
-        capability: 'Hauler',
+        capability: 'Hauling',
         attribute: 'capacity',
         description: 'Number of targets the haul beam can lock onto simultaneously',
     },
     {
-        capability: 'Hauler',
+        capability: 'Hauling',
         attribute: 'efficiency',
         description: 'Thrust penalty reduction per hauled target',
     },
     {
-        capability: 'Hauler',
+        capability: 'Hauling',
         attribute: 'drain',
-        description: 'Energy consumed per target during haul-beam operation',
+        description: 'Fixed normal-travel drain contributed by an installed Tractor Beam',
     },
 ]
 

package/src/data/capability-formulas.ts

@@ -9,19 +9,21 @@ export type SlotConsumerKind =
     | 'gatherer'
     | 'loader'
     | 'crafter'
+    | 'builder'
     | 'storage'
     | 'hauler'
     | 'warp'
+    | 'battery'
     | 'ship-t1'
     | 'container-t1'
     | 'warehouse-t1'
+    | 'extractor-t1'
     | 'container-t2'
 
 const ENTITY_HULL_SLOTS: Record<number, SlotConsumer> = {
     0: {capability: 'Storage', attribute: 'capacity'},
     1: {capability: 'Hull', attribute: 'mass'},
     2: {capability: 'Storage', attribute: 'capacity'},
-    3: {capability: 'Storage', attribute: 'capacity'},
 }
 
 export const SLOT_FORMULAS: Record<SlotConsumerKind, Record<number, SlotConsumer>> = {
@@ -36,33 +38,43 @@ export const SLOT_FORMULAS: Record<SlotConsumerKind, Record<number, SlotConsumer
     gatherer: {
         0: {capability: 'Gathering', attribute: 'yield'},
         1: {capability: 'Gathering', attribute: 'depth'},
-        3: {capability: 'Gathering', attribute: 'drain'},
-        4: {capability: 'Gathering', attribute: 'speed'},
+        2: {capability: 'Gathering', attribute: 'drain'},
     },
     loader: {
-        0: {capability: 'Loader', attribute: 'mass'},
-        1: {capability: 'Loader', attribute: 'thrust'},
+        0: {capability: 'Loading', attribute: 'mass'},
+        1: {capability: 'Loading', attribute: 'thrust'},
     },
     crafter: {
-        0: {capability: 'Crafter', attribute: 'speed'},
-        1: {capability: 'Crafter', attribute: 'drain'},
+        0: {capability: 'Crafting', attribute: 'speed'},
+        1: {capability: 'Crafting', attribute: 'drain'},
+    },
+    builder: {
+        0: {capability: 'Build', attribute: 'speed'},
+        1: {capability: 'Build', attribute: 'drain'},
     },
     storage: {
-        0: {capability: 'Storage', attribute: 'bonus'},
-        1: {capability: 'Storage', attribute: 'bonus'},
-        2: {capability: 'Storage', attribute: 'bonus'},
-        3: {capability: 'Storage', attribute: 'bonus'},
+        0: {capability: 'Storage', attribute: 'capacity'},
+        1: {capability: 'Storage', attribute: 'capacity'},
+        2: {capability: 'Storage', attribute: 'capacity'},
+        3: {capability: 'Storage', attribute: 'capacity'},
     },
     hauler: {
-        0: {capability: 'Hauler', attribute: 'capacity'},
-        1: {capability: 'Hauler', attribute: 'efficiency'},
-        2: {capability: 'Hauler', attribute: 'drain'},
+        0: {capability: 'Hauling', attribute: 'capacity'},
+        1: {capability: 'Hauling', attribute: 'efficiency'},
+        2: {capability: 'Hauling', attribute: 'drain'},
     },
     warp: {
         0: {capability: 'Warp', attribute: 'range'},
     },
+    battery: {
+        0: {capability: 'Energy', attribute: 'capacity'},
+        1: {capability: 'Energy', attribute: 'capacity'},
+        2: {capability: 'Energy', attribute: 'capacity'},
+        3: {capability: 'Energy', attribute: 'capacity'},
+    },
     'ship-t1': ENTITY_HULL_SLOTS,
     'container-t1': ENTITY_HULL_SLOTS,
     'warehouse-t1': ENTITY_HULL_SLOTS,
+    'extractor-t1': ENTITY_HULL_SLOTS,
     'container-t2': ENTITY_HULL_SLOTS,
 }

package/src/data/catalog.test.ts

@@ -0,0 +1,19 @@
+import {describe, expect, test} from 'bun:test'
+import {getItems, itemTypeIndex, typeLabel} from './catalog'
+
+describe('itemTypeIndex', () => {
+    test('agrees with typeLabel for every item in the catalog', () => {
+        for (const item of getItems()) {
+            expect(typeLabel(itemTypeIndex(item.id))).toBe(typeLabel(item.type))
+        }
+    })
+
+    test('covers every type in the chain enum order', () => {
+        const indexes = new Set(getItems().map((item) => itemTypeIndex(item.id)))
+        expect([...indexes].sort()).toEqual([0, 1, 2, 3])
+    })
+
+    test('throws for an unknown item', () => {
+        expect(() => itemTypeIndex(65535)).toThrow()
+    })
+})

package/src/data/catalog.ts

@@ -32,12 +32,16 @@ for (const raw of items as any[]) {
 export const itemIds = Array.from(itemsById.keys())
 
 export function getItem(itemId: UInt16Type): Item {
-    const id = UInt16.from(itemId).toNumber()
-    const item = itemsById.get(id)
-    if (!item) throw new Error(`Unknown item id: ${id}`)
+    const item = tryGetItem(itemId)
+    if (!item) throw new Error(`Unknown item id: ${UInt16.from(itemId).toNumber()}`)
     return item
 }
 
+export function tryGetItem(itemId: UInt16Type): Item | undefined {
+    const id = UInt16.from(itemId).toNumber()
+    return itemsById.get(id)
+}
+
 export function getItems(): Item[] {
     return Array.from(itemsById.values())
 }
@@ -102,6 +106,12 @@ const TYPE_LABEL_BY_STRING: Record<ItemType, string> = {
 
 const TYPE_BY_INDEX: ItemType[] = ['resource', 'component', 'module', 'entity']
 
+export function itemTypeIndex(itemId: UInt16Type): number {
+    const index = TYPE_BY_INDEX.indexOf(getItem(itemId).type)
+    if (index < 0) throw new Error(`Unknown item type for item ${UInt16.from(itemId).toNumber()}`)
+    return index
+}
+
 export function typeLabel(type: ItemType | number): string {
     if (typeof type === 'number') {
         const t = TYPE_BY_INDEX[type]

package/src/data/charters.json

@@ -0,0 +1,396 @@
+{
+  "nodes": [
+    {
+      "nodeId": 10001,
+      "cost": "2000000000",
+      "prereqs": [],
+      "grants": [
+        {
+          "kind": 4,
+          "building": 0,
+          "stat": 0,
+          "value": 1
+        },
+        {
+          "kind": 3,
+          "building": 1,
+          "stat": 0,
+          "value": 1
+        },
+        {
+          "kind": 1,
+          "building": 1,
+          "stat": 0,
+          "value": 5
+        },
+        {
+          "kind": 2,
+          "building": 1,
+          "stat": 1,
+          "value": 200
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 10100201,
+      "cost": "800000000",
+      "prereqs": [
+        10001
+      ],
+      "grants": [
+        {
+          "kind": 2,
+          "building": 1,
+          "stat": 1,
+          "value": 50
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 10100202,
+      "cost": "1200000000",
+      "prereqs": [
+        10100201
+      ],
+      "grants": [
+        {
+          "kind": 2,
+          "building": 1,
+          "stat": 1,
+          "value": 50
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 10100203,
+      "cost": "1600000000",
+      "prereqs": [
+        10100202
+      ],
+      "grants": [
+        {
+          "kind": 2,
+          "building": 1,
+          "stat": 1,
+          "value": 50
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 10100204,
+      "cost": "2000000000",
+      "prereqs": [
+        10100203
+      ],
+      "grants": [
+        {
+          "kind": 2,
+          "building": 1,
+          "stat": 1,
+          "value": 50
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 20001,
+      "cost": "4000000000",
+      "prereqs": [
+        10001
+      ],
+      "grants": [
+        {
+          "kind": 4,
+          "building": 0,
+          "stat": 0,
+          "value": 2
+        },
+        {
+          "kind": 3,
+          "building": 2,
+          "stat": 0,
+          "value": 1
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 30100001,
+      "cost": "3000000000",
+      "prereqs": [
+        10001
+      ],
+      "grants": [
+        {
+          "kind": 3,
+          "building": 3,
+          "stat": 0,
+          "value": 1
+        },
+        {
+          "kind": 1,
+          "building": 3,
+          "stat": 0,
+          "value": 2
+        },
+        {
+          "kind": 2,
+          "building": 3,
+          "stat": 2,
+          "value": 200
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 30100301,
+      "cost": "800000000",
+      "prereqs": [
+        30100001
+      ],
+      "grants": [
+        {
+          "kind": 2,
+          "building": 3,
+          "stat": 2,
+          "value": 50
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 30100302,
+      "cost": "1200000000",
+      "prereqs": [
+        30100301
+      ],
+      "grants": [
+        {
+          "kind": 2,
+          "building": 3,
+          "stat": 2,
+          "value": 50
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 30100303,
+      "cost": "1600000000",
+      "prereqs": [
+        30100302
+      ],
+      "grants": [
+        {
+          "kind": 2,
+          "building": 3,
+          "stat": 2,
+          "value": 50
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 30100304,
+      "cost": "2000000000",
+      "prereqs": [
+        30100303
+      ],
+      "grants": [
+        {
+          "kind": 2,
+          "building": 3,
+          "stat": 2,
+          "value": 50
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 40100001,
+      "cost": "2500000000",
+      "prereqs": [
+        10001
+      ],
+      "grants": [
+        {
+          "kind": 3,
+          "building": 4,
+          "stat": 0,
+          "value": 1
+        },
+        {
+          "kind": 1,
+          "building": 4,
+          "stat": 0,
+          "value": 2
+        },
+        {
+          "kind": 2,
+          "building": 4,
+          "stat": 3,
+          "value": 200
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 40100101,
+      "cost": "1000000000",
+      "prereqs": [
+        40100001
+      ],
+      "grants": [
+        {
+          "kind": 1,
+          "building": 4,
+          "stat": 0,
+          "value": 1
+        },
+        {
+          "kind": 2,
+          "building": 4,
+          "stat": 4,
+          "value": 200
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 40100102,
+      "cost": "1500000000",
+      "prereqs": [
+        40100101
+      ],
+      "grants": [
+        {
+          "kind": 1,
+          "building": 4,
+          "stat": 0,
+          "value": 1
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 40100103,
+      "cost": "2000000000",
+      "prereqs": [
+        40100102
+      ],
+      "grants": [
+        {
+          "kind": 1,
+          "building": 4,
+          "stat": 0,
+          "value": 1
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 40100104,
+      "cost": "2500000000",
+      "prereqs": [
+        40100103
+      ],
+      "grants": [
+        {
+          "kind": 1,
+          "building": 4,
+          "stat": 0,
+          "value": 1
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 40100401,
+      "cost": "800000000",
+      "prereqs": [
+        40100001
+      ],
+      "grants": [
+        {
+          "kind": 2,
+          "building": 4,
+          "stat": 3,
+          "value": 50
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 40100402,
+      "cost": "1200000000",
+      "prereqs": [
+        40100401
+      ],
+      "grants": [
+        {
+          "kind": 2,
+          "building": 4,
+          "stat": 3,
+          "value": 50
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 40100403,
+      "cost": "1600000000",
+      "prereqs": [
+        40100402
+      ],
+      "grants": [
+        {
+          "kind": 2,
+          "building": 4,
+          "stat": 3,
+          "value": 50
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    },
+    {
+      "nodeId": 40100404,
+      "cost": "2000000000",
+      "prereqs": [
+        40100403
+      ],
+      "grants": [
+        {
+          "kind": 2,
+          "building": 4,
+          "stat": 3,
+          "value": 50
+        }
+      ],
+      "exclusionGroup": 0,
+      "repeatCap": 0
+    }
+  ]
+}

package/src/data/citizenry-adjectives.json

@@ -0,0 +1,42 @@
+[
+    "Free",
+    "Civic",
+    "United",
+    "Sovereign",
+    "Common",
+    "Greater",
+    "Outer",
+    "Inner",
+    "New",
+    "Old",
+    "Grand",
+    "High",
+    "Deep",
+    "Bright",
+    "Open",
+    "Steadfast",
+    "Enduring",
+    "Rising",
+    "Standing",
+    "Unified",
+    "Allied",
+    "Independent",
+    "Provisional",
+    "Perpetual",
+    "Elder",
+    "Prime",
+    "Central",
+    "Frontier",
+    "Distant",
+    "Kindred",
+    "Mutual",
+    "Shared",
+    "Reformed",
+    "Restored",
+    "Second",
+    "Orbital",
+    "Solar",
+    "Verdant",
+    "Far",
+    "Wayward"
+]