@hotbunny/hackhub-content-sdk 0.9.0 → 0.9.2

package/README.md

@@ -1,272 +1,281 @@
 # @hotbunny/hackhub-content-sdk
 
-Type definitions and build tools for creating HackHub mods.
+Official modding SDK for [HackHub - Ultimate Hacker Simulator](https://store.steampowered.com/app/2980270/HackHub__Ultimate_Hacker_Simulator/) on Steam. Create custom quests, websites, terminal commands, desktop apps, and more.
 
-## Quick Start
+## Getting Started
 
-The easiest way to create a new mod is with the interactive CLI:
+### Create a New Mod
 
 ```bash
 npm create hackhub-mod
 ```
 
-This will scaffold a ready-to-go project with templates, build config, and everything set up.
+The CLI scaffolds a complete mod project with build config, templates, and TypeScript support.
 
-## Manual Installation
+### Manual Setup
 
 ```bash
 npm install @hotbunny/hackhub-content-sdk --save-dev
 ```
 
-## Example
+## Mod Entry Point
+
+Every mod needs a `Bootstrap` class decorated with `@RegisterModPackage`:
 
 ```typescript
-import {
-    Bootstrap,
-    Quest,
-    Events,
-    Network,
-    Random,
-    RegisterModPackage,
-    RegisterQuest,
-} from "@hotbunny/hackhub-content-sdk";
+import { Bootstrap, RegisterModPackage, Storage } from "@hotbunny/hackhub-content-sdk";
 
 @RegisterModPackage
-class MyMod extends Bootstrap {
-    Settings = [
-        { key: "difficulty", label: "Difficulty", type: "select" as const, default: "normal", options: [
-            { label: "Easy", value: "easy" },
-            { label: "Normal", value: "normal" },
-            { label: "Hard", value: "hard" },
-        ]},
-        { key: "showHints", label: "Show Hints", type: "toggle" as const, default: true },
-    ];
-
+export default class MyMod extends Bootstrap {
     OnModPackageLoaded() {
-        console.log("My mod loaded!");
+        const difficulty = Storage.get<string>("difficulty");
+        console.log(`Loaded with difficulty: ${difficulty}`);
+    }
+
+    OnModPackageUnloaded() {
+        console.log("Mod unloaded");
     }
 }
+```
+
+## Quests
+
+```typescript
+import { Quest, Network, RegisterQuest } from "@hotbunny/hackhub-content-sdk";
 
 @RegisterQuest
-class MyQuest extends Quest {
+class InfiltrationQuest extends Quest {
     definition = {
-        name: "MyQuest",
-        title: "My Custom Quest",
-        description: "A quest added by a mod.",
-        rewards: { money: 100 },
+        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",
-                trigger: {
-                    event: "Terminal.NmapScan",
-                    condition: (data) => data.ip === "10.0.0.1",
-                },
+                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 },
             },
         ],
     };
 
-    OnStart() {
-        const targetIp = Random.pick(["10.0.0.1", "10.0.0.2", "10.0.0.3"]);
+    Data = {
+        targetIp: "10.0.0.50",
+    };
 
+    OnStart() {
         Network.createSubnetNetwork({
-            ip: targetIp,
+            ip: this.Data.targetIp,
             type: "ROUTER",
-            ports: [{ external: 80, internal: 80, active: true, service: "http" }],
-            users: [Network.createUser({ username: "admin", password: Random.password() })],
+            ports: [{ external: 22, internal: 22, active: true, service: "ssh" }],
+            users: [Network.createUser({ username: "admin", password: "secret123" })],
             children: [],
         });
     }
 }
 ```
 
-## API Overview
+### Quest Mail & Dialogs
 
-### Base Classes
-
-| Class | Purpose |
-|-------|---------|
-| `Bootstrap` | Mod entry point with lifecycle callbacks, settings, and manifest |
-| `Quest` | Define custom quests with objectives, rewards, mail, and dialogs |
-| `Website` | Add in-game websites to the browser |
-| `Command` | Register custom terminal commands |
-| `App` | Create desktop applications |
-
-### API Namespaces
-
-| Namespace | Purpose |
-|-----------|---------|
-| `Events` | Listen to 60+ game events, emit custom cross-mod events |
-| `Files` | Create, read, write, delete files in the game filesystem |
-| `Network` | Create networks, manage ports, firewalls, domains |
-| `Mail` | Send in-game emails |
-| `Bank` | Manage bank transactions |
-| `Random` | Random generation helpers (id, uuid, number, password, username, pick, sleep) |
-| `Storage` | Persistent key-value storage (per-mod) |
-| `Variables` | Session-only variables (per-mod, reset on game close) |
-| `SharedStorage` | Persistent storage shared between mods |
-| `SharedVariables` | Session variables shared between mods |
-| `Shell` | Execute terminal commands programmatically |
-| `UI` | Show notifications and toasts |
-| `Twotter` | In-game Twitter -- create users, post tweets |
-| `Kisscord` | In-game Discord -- create users, send messages |
-| `WeeChat` | In-game IRC -- create servers, send messages |
-
-### Decorators
+Quests can send in-game emails and start phone call dialogs:
 
 ```typescript
-@RegisterModPackage   // Register the mod's Bootstrap class
-@RegisterQuest        // Register a Quest
-@RegisterWebsite      // Register a Website
-@RegisterCommand      // Register a terminal Command
-@RegisterApp          // Register a desktop App
-```
+@RegisterQuest
+class StoryQuest extends Quest {
+    // ... definition, Data ...
 
-## Mod Settings
+    Mails = [
+        { title: "Mission Briefing", content: "Your target is ready. Good luck." },
+    ];
 
-Mods can define settings that players can configure from the in-game Mods menu.
+    Dialog = {
+        default: [
+            { speaker: "Handler", text: "Are you ready for the mission?", options: [
+                { label: "Yes", text: "I'm ready.", switchBranch: "briefing" },
+                { label: "No", text: "Not yet.", isEnd: true },
+            ]},
+        ],
+        briefing: [
+            { speaker: "Handler", text: "Good luck out there.", isEnd: true },
+        ],
+    };
 
-### Declarative Settings
+    OnStart() {
+        this.sendMail(0);
+        this.createDialog("default");
+    }
+}
+```
 
-Define a `Settings` array on your Bootstrap class:
+## Websites
 
 ```typescript
-@RegisterModPackage
-class MyMod extends Bootstrap {
-    Settings = [
-        { key: "difficulty", label: "Difficulty", type: "select" as const, default: "normal", options: [
-            { label: "Easy", value: "easy" },
-            { label: "Normal", value: "normal" },
-            { label: "Hard", value: "hard" },
-        ]},
-        { key: "showHints", label: "Show Hints", type: "toggle" as const, default: true },
-        { key: "volume", label: "Volume", type: "slider" as const, default: 50, min: 0, max: 100, step: 5 },
-        { key: "playerName", label: "Player Name", type: "text" as const, default: "Player" },
-    ];
+import { Website, RegisterWebsite } from "@hotbunny/hackhub-content-sdk";
+
+@RegisterWebsite
+class MyWebsite extends Website {
+    SiteName = "darkforum";
+    DisplayName = "DarkForum";
+    Description = "Underground hacking forum";
+    HTML = "website.html";
 }
 ```
 
-Setting values are stored in mod-scoped storage and can be read with `Storage.get("key")`.
+## Terminal Commands
 
-Available types: `toggle`, `select`, `text`, `number`, `slider`.
+```typescript
+import { Command, RegisterCommand } from "@hotbunny/hackhub-content-sdk";
+
+@RegisterCommand
+class PingCommand extends Command {
+    CommandName = "myping";
+    Description = "Custom ping command";
 
-### Custom HTML Settings
+    OnCommand(args: string[], tools: any) {
+        tools.println(`Pinging ${args[0] || "nowhere"}...`);
+    }
+}
+```
 
-For advanced settings panels, provide an HTML file:
+## Desktop Apps
 
 ```typescript
-@RegisterModPackage
-class MyMod extends Bootstrap {
-    SettingsHTML = "settings.html";
+import { App, RegisterApp } from "@hotbunny/hackhub-content-sdk";
+
+@RegisterApp
+class MyApp extends App {
+    AppName = "mytool";
+    DisplayName = "My Tool";
+    Description = "A custom desktop application";
+    HTML = "app.html";
+    Size = { width: 600, height: 400 };
 }
 ```
 
-The HTML file is rendered in a sandboxed iframe within the Mods menu.
+## Mod Settings
 
-## Random Helpers
+Players can configure your mod from the in-game Mods menu. Settings values are accessible via `Storage.get(key)`.
 
 ```typescript
-import { Random } from "@hotbunny/hackhub-content-sdk";
+import { Bootstrap, ModSettingDefinition, RegisterModPackage, Storage } from "@hotbunny/hackhub-content-sdk";
 
-Random.id();                    // Short unique ID (default 10 chars)
-Random.uuid();                  // UUID v4
-Random.number(1, 100);          // Random integer between 1-100
-Random.password();              // Random password from game's list
-Random.username();              // Random username from game's list
-Random.pick(["a", "b", "c"]);   // Random element from array
-Random.pickMultiple(arr, 3);    // 3 unique random elements
-await Random.sleep(2000);       // Wait 2 seconds
+@RegisterModPackage
+export default class MyMod extends Bootstrap {
+    Settings: ModSettingDefinition[] = [
+        {
+            key: "difficulty",
+            label: "Difficulty",
+            type: "select",
+            default: "normal",
+            options: [
+                { label: "Easy", value: "easy" },
+                { label: "Normal", value: "normal" },
+                { label: "Hard", value: "hard" },
+            ],
+        },
+        { key: "showHints", label: "Show Hints", type: "toggle", default: true },
+        { key: "maxEnemies", label: "Max Enemies", type: "slider", default: 5, min: 1, max: 20 },
+    ];
+
+    OnModPackageLoaded() {
+        const difficulty = Storage.get<string>("difficulty");
+        const hints = Storage.get<boolean>("showHints");
+        console.log(`Difficulty: ${difficulty}, Hints: ${hints}`);
+    }
+}
 ```
 
-## Events
+Available setting types: `toggle`, `select`, `text`, `number`, `slider`.
 
-### Listening to Game Events
+For fully custom settings panels, use an HTML file rendered in iframe:
 
 ```typescript
-Events.on("Terminal.NmapScan", (data) => {
-    console.log(`Player scanned ${data.ip}`);
-});
+@RegisterModPackage
+export default class MyMod extends Bootstrap {
+    SettingsHTML = "settings.html";
+}
+```
 
-Events.on("Bettercap.Open", () => {
-    console.log("Player opened Bettercap");
-});
+## API Reference
 
-Events.on("Process.Killed", (data) => {
-    console.log(`Process ${data.name} was killed`);
-});
-```
+### Namespaces
 
-### Custom Cross-Mod Events
+| Namespace | Purpose |
+|-----------|---------|
+| `Events` | Listen to 60+ game events, emit custom events |
+| `Files` | Create, read, write, delete in-game files |
+| `Network` | Create networks, ports, firewalls, domains |
+| `Mail` | Send in-game emails |
+| `Bank` | Bank accounts and transactions |
+| `Random` | Random generation (id, password, username, pick, etc.) |
+| `Storage` | Persistent key-value storage per mod |
+| `Variables` | Session-only variables (reset on game close) |
+| `SharedStorage` | Persistent storage shared between mods |
+| `SharedVariables` | Session variables shared between mods |
+| `Shell` | Execute terminal commands programmatically |
+| `UI` | Notifications and toasts |
+| `Twotter` | In-game social media (Twitter-like) |
+| `Kisscord` | In-game messaging (Discord-like) |
+| `WeeChat` | In-game IRC chat |
 
-```typescript
-declare module "@hotbunny/hackhub-content-sdk" {
-    interface ModEventMap {
-        "MyMod.BossDefeated": { bossName: string; reward: number };
-    }
-}
+### Random
 
-Events.register("MyMod.BossDefeated");
-Events.emit("MyMod.BossDefeated", { bossName: "Hydra", reward: 500 });
+```typescript
+import { Random } from "@hotbunny/hackhub-content-sdk";
 
-Events.on("MyMod.BossDefeated", (data) => {
-    console.log(`Boss ${data.bossName} defeated!`);
-});
+Random.id();                    // Short unique ID
+Random.uuid();                  // UUID v4
+Random.number(1, 100);          // Random integer 1-100
+Random.password();              // Random password
+Random.username();              // Random username
+Random.pick(["a", "b", "c"]);  // Random array element
+Random.pickMultiple(arr, 3);    // 3 unique random elements
+await Random.sleep(2000);       // Wait 2 seconds
 ```
 
-## Quest Mail & Dialogs
-
-Quests can send in-game emails and start phone call dialogs:
+### Events
 
 ```typescript
-@RegisterQuest
-class MyQuest extends Quest {
-    Mails = [
-        { title: "Mission Briefing", content: "Your target is...", replyable: false },
-    ];
+import { Events } from "@hotbunny/hackhub-content-sdk";
 
-    Dialog = {
-        default: [
-            { speaker: "Handler", text: "Are you ready?", options: [
-                { label: "Yes", text: "I'm ready.", switchBranch: "briefing" },
-                { label: "No", text: "Not yet.", isEnd: true },
-            ]},
-        ],
-        briefing: [
-            { speaker: "Handler", text: "Good luck.", isEnd: true },
-        ],
-    };
+// Listen to game events
+Events.on("Terminal.NmapScan", (data) => console.log(`Scanned ${data.ip}`));
+Events.on("Bettercap.Open", () => console.log("Bettercap opened"));
+Events.on("Process.Killed", (data) => console.log(`Killed ${data.name}`));
 
-    OnStart() {
-        this.sendMail(0);
-        this.createDialog("default");
-    }
-}
+// Custom cross-mod events
+Events.emit("MyMod.ScoreUpdated", { score: 100 });
+Events.on("MyMod.ScoreUpdated", (data) => console.log(data.score));
 ```
 
 ## Manifest
 
-Each mod requires a `manifest.json`:
+Each mod requires a `manifest.json` in its root:
 
 ```json
 {
-    "id": "my-unique-mod-id",
+    "id": "my-mod-id",
     "name": "My Mod",
     "version": "1.0.0",
     "author": "Your Name",
-    "description": "What the mod does",
+    "description": "A brief description of the mod",
     "apiVersion": 1,
     "permissions": ["filesystem", "network", "events"],
     "cover": "cover.png",
-    "tags": ["quest", "network"],
-    "dependencies": [],
-    "workshopId": ""
+    "tags": ["quest", "network"]
 }
 ```
 
 ### Permissions
 
-| Permission | Required for |
-|------------|-------------|
+| Permission | Grants access to |
+|------------|-----------------|
 | `filesystem` | Files API |
 | `network` | Network API |
 | `events` | Events API |
@@ -277,11 +286,16 @@ Each mod requires a `manifest.json`:
 
 ## Steam Workshop
 
-Mods can be published to and downloaded from Steam Workshop directly from the in-game Mods menu.
+Mods support Steam Workshop for easy distribution:
+
+- **Upload** local mods to Workshop from the in-game Mods menu
+- **Subscribe** to mods on Workshop -- they're automatically downloaded and loaded
+- **Update** published mods with change notes
+
+## Links
 
-- **Browse**: View and manage your Workshop subscriptions
-- **Upload**: Publish local mods to Workshop with cover image, tags, and change notes
-- **Auto-discovery**: Subscribed Workshop mods are automatically loaded on game start
+- [HackHub - Ultimate Hacker Simulator on Steam](https://store.steampowered.com/app/2980270/HackHub__Ultimate_Hacker_Simulator/)
+- [Steam Workshop](https://steamcommunity.com/app/2980270/workshop/)
 
 ## License
 

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@hotbunny/hackhub-content-sdk",
-    "version": "0.9.0",
-    "description": "Type definitions and build tools for HackHub mod development",
+    "version": "0.9.2",
+    "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": {
         ".": {
@@ -19,10 +19,14 @@
     ],
     "keywords": [
         "hackhub",
+        "hacker-simulator",
+        "hacking-game",
+        "steam",
         "modding",
-        "sdk",
-        "types",
+        "modding-sdk",
         "game-modding",
+        "steam-workshop",
+        "typescript",
         "hotbunny"
     ],
     "repository": {