@hotbunny/hackhub-content-sdk 0.9.2 → 0.9.4

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,34 +39,32 @@ export default class MyMod extends Bootstrap {
 
 ## Quests
 
+Quests use `CreateData()` to initialize data once when the quest is first claimed. After that, access the data via `this.Data`:
+
 ```typescript
-import { Quest, Network, RegisterQuest } from "@hotbunny/hackhub-content-sdk";
+import { Quest, Events, Network, RegisterQuest } from "@hotbunny/hackhub-content-sdk";
 
 @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 },
-            },
-        ],
-    };
+    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() {
+        return {
+            targetIp: Network.randomIp(),
+        };
+    }
 
     OnStart() {
         Network.createSubnetNetwork({
@@ -77,6 +74,18 @@ class InfiltrationQuest extends Quest {
             users: [Network.createUser({ username: "admin", password: "secret123" })],
             children: [],
         });
+
+        Events.on("Terminal.NmapScan", (data) => {
+            if (data.ip === this.Data.targetIp) this.completeObjective("scan");
+        });
+
+        Events.on("Terminal.SSH.Connected", (data) => {
+            if (data.ip === this.Data.targetIp) this.completeObjective("connect");
+        });
+    }
+
+    OnComplete() {
+        Network.destroyNetwork(this.Data.targetIp);
     }
 }
 ```
@@ -88,7 +97,9 @@ Quests can send in-game emails and start phone call dialogs:
 ```typescript
 @RegisterQuest
 class StoryQuest extends Quest {
-    // ... definition, Data ...
+    Name = "StoryQuest";
+    Title = "Story Quest";
+    Objectives = [{ name: "start", description: "Begin the mission" }];
 
     Mails = [
         { title: "Mission Briefing", content: "Your target is ready. Good luck." },
@@ -160,10 +171,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 +195,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 +225,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 +251,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

@@ -1129,6 +1129,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: any;
 	/**
 	 * Called when the quest is first claimed/started.
 	 * Use this to set up event listeners for objective completion.
@@ -1851,6 +1853,31 @@ export declare namespace Random {
 	export function sleep(ms: number): Promise<void>;
 	export {};
 }
+/**
+ * Mod settings API. Provides access to the values configured by
+ * the player in the Mods menu (defined via Bootstrap.Settings).
+ *
+ * @example
+ * ```ts
+ * import { ModSettings } from "@hotbunny/hackhub-content-sdk";
+ *
+ * const difficulty = ModSettings.get<string>("difficulty");
+ * const all = ModSettings.getAll();
+ * ```
+ */
+export declare namespace ModSettings {
+	/** Get a setting value by key. Returns the default if not changed by player. */
+	export function get<T = any>(key: string): T | undefined;
+	/** Get all setting values as a key-value map. */
+	export function getAll(): Record<string, any>;
+	/** Programmatically set a setting value. */
+	export function set(key: string, value: any): void;
+	/** Reset a setting to its default value. */
+	export function reset(key: string): void;
+	/** Reset all settings to their defaults. */
+	export function resetAll(): void;
+	export {};
+}
 /**
  * Marks a class as the mod's entry point.
  * Each mod must have exactly one @RegisterModPackage class extending Bootstrap.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hotbunny/hackhub-content-sdk",
-    "version": "0.9.2",
+    "version": "0.9.4",
     "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": {