@hotbunny/hackhub-content-sdk 0.9.3 → 0.9.5

package/README.md

@@ -23,13 +23,12 @@ npm install @hotbunny/hackhub-content-sdk --save-dev
 Every mod needs a `Bootstrap` class decorated with `@RegisterModPackage`:
 
 ```typescript
-import { Bootstrap, RegisterModPackage, Storage } from "@hotbunny/hackhub-content-sdk";
+import { Bootstrap, RegisterModPackage } from "@hotbunny/hackhub-content-sdk";
 
 @RegisterModPackage
 export default class MyMod extends Bootstrap {
     OnModPackageLoaded() {
-        const difficulty = Storage.get<string>("difficulty");
-        console.log(`Loaded with difficulty: ${difficulty}`);
+        console.log("Mod loaded!");
     }
 
     OnModPackageUnloaded() {
@@ -40,43 +39,62 @@ export default class MyMod extends Bootstrap {
 
 ## Quests
 
+Quests use a generic type parameter for type-safe data. `CreateData()` initializes the data once when the quest is first claimed. After that, access via `this.Data` and update via `this.SetData()`:
+
 ```typescript
-import { Quest, Network, RegisterQuest } from "@hotbunny/hackhub-content-sdk";
+import { Quest, Events, Network, RegisterQuest } from "@hotbunny/hackhub-content-sdk";
+
+interface InfiltrationData {
+    targetIp: string;
+    attempts: number;
+}
 
 @RegisterQuest
-class InfiltrationQuest extends Quest {
-    definition = {
-        name: "Infiltration",
-        title: "Server Infiltration",
-        description: "Hack into the target server and download the data.",
-        employer: { name: "Mr. X", avatar: "mrx" },
-        rewards: { money: 5000, xp: 200 },
-        objectives: [
-            {
-                name: "scan",
-                description: "Scan the target server",
-                trigger: { event: "Terminal.NmapScan", condition: (data) => data.ip === this.Data.targetIp },
-            },
-            {
-                name: "connect",
-                description: "Connect via SSH",
-                trigger: { event: "Terminal.SSH.Connected", condition: (data) => data.ip === this.Data.targetIp },
-            },
-        ],
-    };
+class InfiltrationQuest extends Quest<InfiltrationData> {
+    Name = "Infiltration";
+    Title = "Server Infiltration";
+    Description = "Hack into the target server and download the data.";
+    Employer = { name: "Mr. X", avatar: "mrx" };
+    Rewards = { money: 5000, xp: 200 };
+    Objectives = [
+        { name: "scan", description: "Scan the target server" },
+        {
+            name: "connect",
+            description: "Connect via SSH",
+            unlocksAfter: ["scan"],
+        },
+    ];
 
-    Data = {
-        targetIp: "10.0.0.50",
-    };
+    CreateData(): InfiltrationData {
+        return {
+            targetIp: Network.randomIp(),
+            attempts: 0,
+        };
+    }
 
     OnStart() {
         Network.createSubnetNetwork({
-            ip: this.Data.targetIp,
+            ip: this.Data.targetIp,   // fully typed
             type: "ROUTER",
             ports: [{ external: 22, internal: 22, active: true, service: "ssh" }],
             users: [Network.createUser({ username: "admin", password: "secret123" })],
             children: [],
         });
+
+        Events.on("Terminal.NmapScan", (data) => {
+            if (data.ip === this.Data.targetIp) {
+                this.SetData("attempts", this.Data.attempts + 1);  // type-safe key & value
+                this.completeObjective("scan");
+            }
+        });
+
+        Events.on("Terminal.SSH.Connected", (data) => {
+            if (data.ip === this.Data.targetIp) this.completeObjective("connect");
+        });
+    }
+
+    OnComplete() {
+        Network.destroyNetwork(this.Data.targetIp);
     }
 }
 ```
@@ -87,8 +105,14 @@ Quests can send in-game emails and start phone call dialogs:
 
 ```typescript
 @RegisterQuest
-class StoryQuest extends Quest {
-    // ... definition, Data ...
+class StoryQuest extends Quest<{ contacted: boolean }> {
+    Name = "StoryQuest";
+    Title = "Story Quest";
+    Objectives = [{ name: "start", description: "Begin the mission" }];
+
+    CreateData() {
+        return { contacted: false };
+    }
 
     Mails = [
         { title: "Mission Briefing", content: "Your target is ready. Good luck." },
@@ -160,10 +184,10 @@ class MyApp extends App {
 
 ## Mod Settings
 
-Players can configure your mod from the in-game Mods menu. Settings values are accessible via `Storage.get(key)`.
+Players can configure your mod from the in-game Mods menu. Use the `ModSettings` API to read and write setting values:
 
 ```typescript
-import { Bootstrap, ModSettingDefinition, RegisterModPackage, Storage } from "@hotbunny/hackhub-content-sdk";
+import { Bootstrap, ModSettingDefinition, ModSettings, RegisterModPackage } from "@hotbunny/hackhub-content-sdk";
 
 @RegisterModPackage
 export default class MyMod extends Bootstrap {
@@ -184,8 +208,8 @@ export default class MyMod extends Bootstrap {
     ];
 
     OnModPackageLoaded() {
-        const difficulty = Storage.get<string>("difficulty");
-        const hints = Storage.get<boolean>("showHints");
+        const difficulty = ModSettings.get<string>("difficulty");
+        const hints = ModSettings.get<boolean>("showHints");
         console.log(`Difficulty: ${difficulty}, Hints: ${hints}`);
     }
 }
@@ -214,6 +238,7 @@ export default class MyMod extends Bootstrap {
 | `Mail` | Send in-game emails |
 | `Bank` | Bank accounts and transactions |
 | `Random` | Random generation (id, password, username, pick, etc.) |
+| `ModSettings` | Read/write mod settings configured by the player |
 | `Storage` | Persistent key-value storage per mod |
 | `Variables` | Session-only variables (reset on game close) |
 | `SharedStorage` | Persistent storage shared between mods |
@@ -239,6 +264,18 @@ Random.pickMultiple(arr, 3);    // 3 unique random elements
 await Random.sleep(2000);       // Wait 2 seconds
 ```
 
+### ModSettings
+
+```typescript
+import { ModSettings } from "@hotbunny/hackhub-content-sdk";
+
+ModSettings.get<string>("difficulty");  // Read a setting value
+ModSettings.getAll();                   // All settings as key-value map
+ModSettings.set("difficulty", "hard");  // Write a setting value
+ModSettings.reset("difficulty");        // Reset to default
+ModSettings.resetAll();                 // Reset all to defaults
+```
+
 ### Events
 
 ```typescript

package/index.d.ts

@@ -1078,31 +1078,32 @@ export declare abstract class Bootstrap {
 	OnModPackageUnloaded(): void;
 }
 /**
- * Base class for mod quests. Mod authors extend this to create custom quests.
+ * Base class for mod quests. Extend with a generic type for type-safe quest data.
  *
  * @example
  * ```ts
- * import { Quest, RegisterQuest } from "@hotbunny/hackhub-content-sdk";
+ * interface MyData { targetIp: string; attempts: number; }
  *
  * @RegisterQuest
- * export class HackThePlanet extends Quest {
+ * export class HackThePlanet extends Quest<MyData> {
  *     Name = "HackThePlanet";
  *     Title = "Hack the Planet";
- *     Rewards = { money: 5000 };
  *     Objectives = [
  *         { name: "scan", description: "Scan the target with nmap" },
- *         { name: "exploit", description: "Exploit the vulnerability", unlocksAfter: ["scan"] },
  *     ];
  *
+ *     CreateData() {
+ *         return { targetIp: "192.168.1.50", attempts: 0 };
+ *     }
+ *
  *     OnStart() {
- *         Events.on("Terminal.NmapScan", (data) => {
- *             if (data.ip === "192.168.1.50") this.completeObjective("scan");
- *         });
+ *         console.log(this.Data.targetIp); // fully typed
+ *         this.SetData("attempts", 1);     // type-safe key & value
  *     }
  * }
  * ```
  */
-export declare abstract class Quest {
+export declare abstract class Quest<T extends Record<string, any> = Record<string, any>> {
 	abstract Name: string;
 	abstract Title: string;
 	abstract Objectives: QuestObjectiveDefinition[];
@@ -1129,6 +1130,8 @@ export declare abstract class Quest {
 	Mails?: QuestMailDefinition[];
 	/** Phone-call dialog tree for this quest. Use this.createDialog(branch) to start. */
 	Dialog?: QuestDialogDefinition;
+	/** Quest data created by CreateData(). Populated at runtime by the game engine. */
+	Data: T;
 	/**
 	 * Called when the quest is first claimed/started.
 	 * Use this to set up event listeners for objective completion.
@@ -1141,15 +1144,19 @@ export declare abstract class Quest {
 	/** Called when the quest's objectives listener starts (e.g. after game load). */
 	OnObjectivesStart(): void;
 	/** Return initial quest data. Override to provide custom data storage. */
-	CreateData(): any;
+	CreateData(): T;
+	/** Update a single key in the quest data and persist it. */
+	SetData<K extends keyof T>(key: K, value: T[K]): void;
 	/** Complete an objective by its name. */
 	completeObjective(name: string): void;
 	/** Send a mail from the Mails array by index. */
 	sendMail(index: number, from?: string, to?: string): void;
 	/** Start a phone-call dialog. Defaults to "default" branch. */
 	createDialog(branch?: string, startIndex?: number): void;
+	/** @internal */ _completeObjectiveInternal?: (index: number) => void;
 	/** @internal */ _sendMailInternal?: (index: number, from?: string, to?: string) => void;
 	/** @internal */ _createDialogInternal?: (branch: string, startIndex: number) => void;
+	/** @internal */ _saveDataInternal?: () => void;
 }
 /**
  * Base class for mod websites. Mod authors extend this to create

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hotbunny/hackhub-content-sdk",
-    "version": "0.9.3",
+    "version": "0.9.5",
     "description": "Official modding SDK for HackHub - Ultimate Hacker Simulator on Steam. Create custom quests, websites, terminal commands, and desktop apps.",
     "types": "index.d.ts",
     "exports": {