@hotbunny/hackhub-content-sdk 0.9.7 → 0.9.9

package/README.md

@@ -1,4 +1,4 @@
-# Hackhub Content SDK
+# @hotbunny/hackhub-content-sdk
 
 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.
 
@@ -144,20 +144,54 @@ class StoryQuest extends Quest<{ contacted: boolean }> {
 
 ## 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
@@ -169,8 +203,15 @@ 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.");
     }
 
 }
@@ -185,10 +226,36 @@ import { App, RegisterApp } from "@hotbunny/hackhub-content-sdk";
 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(),
+    };
 
 }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hotbunny/hackhub-content-sdk",
-    "version": "0.9.7",
+    "version": "0.9.9",
     "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": {
@@ -29,10 +29,7 @@
         "typescript",
         "hotbunny"
     ],
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/AceKiron/hackhub-content-sdk.git"
-    },
+    "homepage": "https://docs.hotbunny.dev/hackhub/",
     "author": "HotBunny Interactive Entertainment Inc.",
     "license": "MIT",
     "publishConfig": {