@hotbunny/hackhub-content-sdk 0.9.6 → 0.9.8

package/README.md

@@ -27,6 +27,7 @@ import { Bootstrap, RegisterModPackage } from "@hotbunny/hackhub-content-sdk";
 
 @RegisterModPackage
 export default class MyMod extends Bootstrap {
+
     OnModPackageLoaded() {
         console.log("Mod loaded!");
     }
@@ -34,6 +35,7 @@ export default class MyMod extends Bootstrap {
     OnModPackageUnloaded() {
         console.log("Mod unloaded");
     }
+
 }
 ```
 
@@ -51,10 +53,10 @@ interface InfiltrationData {
 
 @RegisterQuest
 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" },
@@ -74,18 +76,16 @@ class InfiltrationQuest extends Quest<InfiltrationData> {
 
     OnStart() {
         Network.createSubnetNetwork({
-            ip: this.Data.targetIp,   // fully typed
+            ip: this.Data.targetIp,
             type: "ROUTER",
             ports: [{ external: 22, internal: 22, active: true, service: "ssh" }],
             users: [Network.createUser({ username: "admin", password: "secret123" })],
             children: [],
         });
 
-        // Use this.Events.on() — listeners are automatically cleaned up
-        // when the quest completes or is abandoned. No memory leaks!
         this.Events.on("Terminal.NmapScan", (data) => {
             if (data.ip === this.Data.targetIp) {
-                this.SetData("attempts", this.Data.attempts + 1);  // type-safe key & value
+                this.SetData("attempts", this.Data.attempts + 1);
                 this.completeObjective("scan");
             }
         });
@@ -98,6 +98,7 @@ class InfiltrationQuest extends Quest<InfiltrationData> {
     OnComplete() {
         Network.destroyNetwork(this.Data.targetIp);
     }
+
 }
 ```
 
@@ -108,14 +109,11 @@ Quests can send in-game emails and start phone call dialogs:
 ```typescript
 @RegisterQuest
 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." },
     ];
@@ -132,27 +130,68 @@ class StoryQuest extends Quest<{ contacted: boolean }> {
         ],
     };
 
+    CreateData() {
+        return { contacted: false };
+    }
+
     OnStart() {
         this.sendMail(0);
         this.createDialog("default");
     }
+
 }
 ```
 
 ## Websites
 
+Websites use a `Pages` array. Each page has a `path`, `title`, and an `html` file rendered inside the in-game browser:
+
 ```typescript
 import { Website, RegisterWebsite } from "@hotbunny/hackhub-content-sdk";
 
+@RegisterWebsite
+class HackerForum extends Website {
+
+    SiteName = "Hacker Forum";
+    Host = "hackerforum.net";
+    Icon = "./assets/forum-icon.png";
+    Pages = [
+        { path: "/", title: "Home", html: "pages/home.html" },
+        { path: "/about", title: "About", html: "pages/about.html" },
+    ];
+
+}
+```
+
+You can expose TypeScript functions to your HTML pages via `Exports`:
+
+```typescript
 @RegisterWebsite
 class MyWebsite extends Website {
-    SiteName = "darkforum";
-    DisplayName = "DarkForum";
-    Description = "Underground hacking forum";
-    HTML = "website.html";
+
+    SiteName = "My Site";
+    Host = "mysite.com";
+    Icon = "./assets/icon.png";
+    Pages = [
+        { path: "/", title: "Home", html: "pages/home.html" },
+    ];
+
+    Exports = {
+        formatPost: (text: string) => text.toUpperCase(),
+    };
+
 }
 ```
 
+In your HTML, exported functions are available as globals and SDK APIs via `HackhubSDK`:
+
+```html
+<script>
+    const formatted = formatPost("hello");
+    HackhubSDK.Mail.send({ to: "user@mail.com", subject: "Hi" });
+</script>
+```
+
 ## Terminal Commands
 
 ```typescript
@@ -160,12 +199,21 @@ import { Command, RegisterCommand } from "@hotbunny/hackhub-content-sdk";
 
 @RegisterCommand
 class PingCommand extends Command {
+
     CommandName = "myping";
     Description = "Custom ping command";
 
-    OnCommand(args: string[], tools: any) {
-        tools.println(`Pinging ${args[0] || "nowhere"}...`);
+    async Run(tools) {
+        const args = tools.getArgs();
+        if (args.length === 0) {
+            tools.printError("Usage: myping <ip>");
+            return;
+        }
+        tools.println(`Pinging ${args[0]}...`);
+        await tools.sleep(1000);
+        tools.println("Reply received.");
     }
+
 }
 ```
 
@@ -176,11 +224,39 @@ import { App, RegisterApp } from "@hotbunny/hackhub-content-sdk";
 
 @RegisterApp
 class MyApp extends App {
+
     AppName = "mytool";
-    DisplayName = "My Tool";
-    Description = "A custom desktop application";
+    Title = "My Tool";
+    Icon = "./assets/app-icon.png";
+    HTML = "app.html";
+    DefaultSize = { width: 600, height: 400 };
+
+}
+```
+
+Apps can have an App Store listing and expose functions to HTML, just like websites:
+
+```typescript
+@RegisterApp
+class PasswordGen extends App {
+
+    AppName = "passgen";
+    Title = "Password Generator";
+    Icon = "./assets/passgen.png";
     HTML = "app.html";
-    Size = { width: 600, height: 400 };
+    DefaultSize = { width: 400, height: 300 };
+    Unlocked = true;
+
+    Store = {
+        title: "Password Generator",
+        ratings: 4.5,
+        description: "Generate secure passwords",
+    };
+
+    Exports = {
+        generate: (length: number) => Random.password(),
+    };
+
 }
 ```
 
@@ -193,6 +269,7 @@ import { Bootstrap, ModSettingDefinition, ModSettings, RegisterModPackage } from
 
 @RegisterModPackage
 export default class MyMod extends Bootstrap {
+
     Settings: ModSettingDefinition[] = [
         {
             key: "difficulty",
@@ -214,6 +291,7 @@ export default class MyMod extends Bootstrap {
         const hints = ModSettings.get<boolean>("showHints");
         console.log(`Difficulty: ${difficulty}, Hints: ${hints}`);
     }
+
 }
 ```
 
@@ -224,7 +302,9 @@ For fully custom settings panels, use an HTML file rendered in iframe:
 ```typescript
 @RegisterModPackage
 export default class MyMod extends Bootstrap {
+
     SettingsHTML = "settings.html";
+
 }
 ```
 

package/package.json

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