@hotbunny/hackhub-content-sdk 0.1.0 → 0.1.1

package/README.md

@@ -2,43 +2,23 @@
 
 Type definitions and API reference for creating HackHub mods.
 
-This package provides **TypeScript types only** -- no runtime code. The game loads your compiled `mod.js` at startup; this package gives you autocompletion and type checking while developing.
+## Quick Start
 
-## Installation
+The easiest way to create a new mod is with the interactive CLI:
 
 ```bash
-npm install @hotbunny/hackhub-content-sdk --save-dev
+npm create hackhub-mod
 ```
 
-## Mod Structure
+This will scaffold a ready-to-go project with templates, build config, and everything set up.
 
-A HackHub mod is a folder inside the game's `mods/` directory:
+## Manual Installation
 
+```bash
+npm install @hotbunny/hackhub-content-sdk --save-dev
 ```
-mods/
-  my-first-mod/
-    manifest.json
-    mod.js
-```
-
-### manifest.json
-
-```json
-{
-    "id": "my-first-mod",
-    "name": "My First Mod",
-    "version": "1.0.0",
-    "author": "YourName",
-    "description": "A simple HackHub mod",
-    "entry": "mod.js",
-    "permissions": ["network", "files", "events"],
-    "dependencies": []
-}
-```
-
-### Source Code (TypeScript)
 
-Write your mod in TypeScript, then compile to a single `mod.js` bundle.
+## Example
 
 ```typescript
 import {
@@ -134,119 +114,28 @@ class MyQuest extends Quest {
 ### Listening to Game Events
 
 ```typescript
-import { Events } from "@hotbunny/hackhub-content-sdk";
-
 Events.on("Terminal.NmapScan", (data) => {
     console.log(`Player scanned ${data.ip}`);
 });
-
-Events.on("Kisscord.Messaging", (data) => {
-    console.log(`Message on channel ${data.channel}`);
-});
 ```
 
 ### Custom Cross-Mod Events
 
-Register and emit your own typed events that other mods can listen to:
-
 ```typescript
-// In your mod's type declarations
 declare module "@hotbunny/hackhub-content-sdk" {
     interface ModEventMap {
         "MyMod.BossDefeated": { bossName: string; reward: number };
     }
 }
 
-// Emit
 Events.register("MyMod.BossDefeated");
 Events.emit("MyMod.BossDefeated", { bossName: "Hydra", reward: 500 });
 
-// Another mod can listen (with full type safety)
 Events.on("MyMod.BossDefeated", (data) => {
-    console.log(`Boss ${data.bossName} defeated! Reward: ${data.reward}`);
-});
-```
-
-## Messaging APIs
-
-### Twotter (in-game Twitter)
-
-```typescript
-import { Twotter } from "@hotbunny/hackhub-content-sdk";
-
-const user = Twotter.createUser({
-    username: "darknet_hacker",
-    bio: "I hack things.",
-    verified: true,
-});
-Twotter.addUser(user);
-
-Twotter.postTweet({
-    id: "my-tweet-1",
-    userId: user.id,
-    content: "Just breached the mainframe!",
-    interaction: { comments: 5, share: 2, likes: 42, views: 1000 },
-    showInTimeline: true,
+    console.log(`Boss ${data.bossName} defeated!`);
 });
 ```
 
-### Kisscord (in-game Discord)
-
-```typescript
-import { Kisscord, KisscordStatus } from "@hotbunny/hackhub-content-sdk";
-
-const npc = Kisscord.createUser({
-    username: "informant",
-    firstName: "John",
-    lastName: "Doe",
-    isFriend: true,
-    status: KisscordStatus.Online,
-});
-Kisscord.addUser(npc);
-Kisscord.sendMessage(npc.id, "I have the files you need.");
-```
-
-### WeeChat (in-game IRC)
-
-```typescript
-import { WeeChat } from "@hotbunny/hackhub-content-sdk";
-
-WeeChat.createServer("irc.darknet.org", "secret123");
-WeeChat.sendMessage({
-    host: "irc.darknet.org",
-    username: "informant",
-    message: "The target IP is 45.33.32.156",
-});
-```
-
-## Building Your Mod
-
-Use [esbuild](https://esbuild.github.io/) to compile your TypeScript source into a single `mod.js`:
-
-```bash
-npx esbuild src/index.ts --bundle --outfile=mod.js --format=cjs --platform=browser --target=es2020 --external:@hotbunny/hackhub-content-sdk
-```
-
-The `--external` flag is important: the game provides the SDK at runtime, so it must not be bundled into your mod.
-
-### tsconfig.json (recommended)
-
-```json
-{
-    "compilerOptions": {
-        "target": "ES2020",
-        "module": "ESNext",
-        "moduleResolution": "bundler",
-        "strict": true,
-        "experimentalDecorators": true,
-        "emitDecoratorMetadata": true,
-        "esModuleInterop": true,
-        "skipLibCheck": true
-    },
-    "include": ["src/**/*.ts"]
-}
-```
-
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hotbunny/hackhub-content-sdk",
-    "version": "0.1.0",
+    "version": "0.1.1",
     "description": "Type definitions and API reference for HackHub mod development",
     "types": "index.d.ts",
     "files": [