# API Reference

**URL:** https://hotbunny.dev/c/docs/api-reference/9.md

[Latest](https://hotbunny.dev/latest.md) · [Categories](https://hotbunny.dev/categories.md) · [Tags](https://hotbunny.dev/tags.md)

---

## [Welcome to the API Reference](https://hotbunny.dev/t/welcome-to-the-api-reference/11)

<div class="topic-metadata">

**Author:** [@system](https://hotbunny.dev/u/system)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 12:53pm UTC](https://hotbunny.dev/t/welcome-to-the-api-reference/11 "2026-10-21T12:53:19Z")

</div>

Every API the HackHub Content SDK exposes. Pages in this section are written by the HotBunny team and kept up to date with the Content SDK. Have a question about a page? Reply right under it: questions on a doc page he…

---

## [Handbook](https://hotbunny.dev/t/handbook/70)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:03pm UTC](https://hotbunny.dev/t/handbook/70 "2026-10-21T16:03:14Z")

</div>

The Handbook namespace lets your mod add its own articles to the in-game Handbook app, so players can read guides, lore and reference material for your mod right next to the base game’s entries. Article content is writt…

---

## [ContextMenu](https://hotbunny.dev/t/contextmenu/69)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:03pm UTC](https://hotbunny.dev/t/contextmenu/69 "2026-10-21T16:03:13Z")

</div>

The ContextMenu API allows mods to add custom right-click menu items to various targets in the game. Import import { ContextMenu } from "@hotbunny/hackhub-content-sdk"; Functions ContextMenu.register(item: ContextMenuI…

---

## [Desktop](https://hotbunny.dev/t/desktop/68)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:03pm UTC](https://hotbunny.dev/t/desktop/68 "2026-10-21T16:03:11Z")

</div>

The Desktop API allows mods to add custom widgets to the game desktop. Widgets are rendered inside sandboxed iframes with full SDK access via window.HackhubSDK. Import import { Desktop } from "@hotbunny/hackhub-content-…

---

## [Menu](https://hotbunny.dev/t/menu/67)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:03pm UTC](https://hotbunny.dev/t/menu/67 "2026-10-21T16:03:10Z")

</div>

The Menu API allows mods to add custom items to the Start Menu. Import import { Menu } from "@hotbunny/hackhub-content-sdk"; Functions Menu.addItem(item: MenuItem) Adds a custom item to the start menu. Menu.addItem({ …

---

## [Theme](https://hotbunny.dev/t/theme/66)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:03pm UTC](https://hotbunny.dev/t/theme/66 "2026-10-21T16:03:08Z")

</div>

The Theme API allows mods to create and register custom themes, change the active theme at runtime, and inject custom CSS into the game. Importing import { Theme } from "@hotbunny/hackhub-content-sdk"; Registering a Th…

---

## [ModSettings](https://hotbunny.dev/t/modsettings/65)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:03pm UTC](https://hotbunny.dev/t/modsettings/65 "2026-10-21T16:03:07Z")

</div>

Read and write mod settings configured by the player in the Mods menu. This API is completely separate from the Storage API. No permission required. Methods get\<T\>(key) Get a setting value by key. Returns the player’s …

---

## [Localization](https://hotbunny.dev/t/localization/64)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:03pm UTC](https://hotbunny.dev/t/localization/64 "2026-10-21T16:03:06Z")

</div>

The Localization namespace lets a mod ship its text in more than one language and read back whichever one the player is playing in. Without it a mod has one choice, which is to write its strings straight into the source…

---

## [Scheduler](https://hotbunny.dev/t/scheduler/63)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:03pm UTC](https://hotbunny.dev/t/scheduler/63 "2026-10-21T16:03:04Z")

</div>

The Scheduler namespace provides save-resilient scheduling on the in-game clock. A job is a due date, not a countdown, which is what makes it survive the things a countdown does not: quitting, loading another save, comi…

---

## [Time](https://hotbunny.dev/t/time/62)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:03pm UTC](https://hotbunny.dev/t/time/62 "2026-10-21T16:03:02Z")

</div>

The Time namespace is the in-game clock. The world runs on its own calendar, faster than real time and frozen while the game is paused. Anything with a due date, an age or a deadline should be measured against this rath…

---

## [Random](https://hotbunny.dev/t/random/61)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:03pm UTC](https://hotbunny.dev/t/random/61 "2026-10-21T16:03:01Z")

</div>

Random generation and async utility functions. No permission required. Methods id(length?) Generate a short unique ID. Default length is 10. Parameter Type Default Description length number? 10 Character lengt…

---

## [WeeChat](https://hotbunny.dev/t/weechat/60)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:02pm UTC](https://hotbunny.dev/t/weechat/60 "2026-10-21T16:02:59Z")

</div>

The WeeChat namespace provides access to the in-game IRC-like terminal chat system. Create IRC servers, send messages, and read chat history. No permission required. Import import { WeeChat } from "@hotbunny/hackhub-co…

---

## [Kisscord](https://hotbunny.dev/t/kisscord/59)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:02pm UTC](https://hotbunny.dev/t/kisscord/59 "2026-10-21T16:02:58Z")

</div>

The Kisscord namespace provides access to the in-game Discord-like messaging application. Create NPC contacts, send messages, and manage friend lists. No permission required. Import import { Kisscord, KisscordStatus } …

---

## [Twotter](https://hotbunny.dev/t/twotter/58)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:02pm UTC](https://hotbunny.dev/t/twotter/58 "2026-10-21T16:02:57Z")

</div>

The Twotter namespace provides access to the in-game Twitter-like social media platform. Create NPC accounts, post tweets, and manage interactions. No permission required. Import import { Twotter } from "@hotbunny/hack…

---

## [SharedVariables](https://hotbunny.dev/t/sharedvariables/57)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:02pm UTC](https://hotbunny.dev/t/sharedvariables/57 "2026-10-21T16:02:55Z")

</div>

The SharedVariables namespace provides in-memory key-value storage shared between all mods. Data is lost when the game is closed (session-only). All mods read and write to the same key space. For persistent shared stora…

---

## [SharedStorage](https://hotbunny.dev/t/sharedstorage/56)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:02pm UTC](https://hotbunny.dev/t/sharedstorage/56 "2026-10-21T16:02:54Z")

</div>

The SharedStorage namespace provides persistent key-value storage shared between all mods. Data persists across game sessions. All mods read and write to the same key space. Use descriptive key names prefixed with your …

---

## [Variables](https://hotbunny.dev/t/variables/55)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:02pm UTC](https://hotbunny.dev/t/variables/55 "2026-10-21T16:02:52Z")

</div>

The Variables namespace provides in-memory key-value storage scoped to the current mod. Data is lost when the game is closed (session-only). Each mod has its own isolated namespace. For persistent storage, use Storage. …

---

## [SaveStorage](https://hotbunny.dev/t/savestorage/54)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:02pm UTC](https://hotbunny.dev/t/savestorage/54 "2026-10-21T16:02:51Z")

</div>

The SaveStorage namespace provides per-save persistent key-value storage scoped to the current mod. Unlike Storage - which is global and shared by every save file - data written with SaveStorage belongs to the currently…

---

## [Storage](https://hotbunny.dev/t/storage/53)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:02pm UTC](https://hotbunny.dev/t/storage/53 "2026-10-21T16:02:50Z")

</div>

The Storage namespace provides persistent key-value storage scoped to the current mod. Data persists across game sessions (saved to disk). Each mod has its own isolated namespace - other mods cannot access your data. Fo…

---

## [Tour](https://hotbunny.dev/t/tour/52)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:02pm UTC](https://hotbunny.dev/t/tour/52 "2026-10-21T16:02:48Z")

</div>

The Tour namespace walks the player through something, without a quest to hang it on. A quest can carry its own tour through Quest.Steps, and that is the right place for one whenever there is a quest: the steps follow t…

---

## [UI (notifications, toasts, dialogs)](https://hotbunny.dev/t/ui-notifications-toasts-dialogs/51)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:02pm UTC](https://hotbunny.dev/t/ui-notifications-toasts-dialogs/51 "2026-10-21T16:02:47Z")

</div>

The UI namespace provides methods to show notifications, toast messages and input dialogs to the player. Required permission: ui Import import { UI } from "@hotbunny/hackhub-content-sdk"; Methods UI.notify(message) Sh…

---

## [Shell](https://hotbunny.dev/t/shell/50)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:02pm UTC](https://hotbunny.dev/t/shell/50 "2026-10-21T16:02:00Z")

</div>

The Shell namespace provides access to the in-game terminal. Execute commands, query system info, and inject custom command response data. Required permission: shell Import import { Shell } from "@hotbunny/hackhub-cont…

---

## [Bank](https://hotbunny.dev/t/bank/49)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:01pm UTC](https://hotbunny.dev/t/bank/49 "2026-10-21T16:01:59Z")

</div>

The Bank namespace provides access to the in-game banking system. Send money to the player, withdraw from their account, check balance, and read account details. Required permission: bank Import import { Bank } from "@…

---

## [Phone](https://hotbunny.dev/t/phone/48)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:01pm UTC](https://hotbunny.dev/t/phone/48 "2026-10-21T16:01:58Z")

</div>

The Phone namespace sends text messages to the player’s in-game phone. Requires permission: mail Import import { Phone } from "@hotbunny/hackhub-content-sdk"; Methods Phone.sendSms(sms) Drop an unread SMS into the pho…

---

## [Mail](https://hotbunny.dev/t/mail/47)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:01pm UTC](https://hotbunny.dev/t/mail/47 "2026-10-21T16:01:56Z")

</div>

The Mail namespace provides access to the in-game email system. Send emails to the player, attach custom metadata for programmatic detection, and read their inbox. Required permission: mail Import import { Mail } from …

---

## [Database](https://hotbunny.dev/t/database/46)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:01pm UTC](https://hotbunny.dev/t/database/46 "2026-10-21T16:01:55Z")

</div>

The Database namespace allows mods to create and manage in-game databases. These databases are used by tools like sqlmap and the DatabaseManager app. Required permission: network Import import { Database } from "@hotbu…

---

## [Http](https://hotbunny.dev/t/http/45)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:01pm UTC](https://hotbunny.dev/t/http/45 "2026-10-21T16:01:53Z")

</div>

The Http namespace lets content stand up web applications the player can actually browse, probe and attack over the game’s simulated network. Requires the network permission. Available since SDK v0.23.0 The Http name…

---

## [Network](https://hotbunny.dev/t/network/44)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:01pm UTC](https://hotbunny.dev/t/network/44 "2026-10-21T16:01:50Z")

</div>

The Network namespace provides access to the in-game network simulation. Create subnets, manage devices, configure firewalls, register domains, and control ports. Required permission: network Import import { Network, N…

---

## [Files](https://hotbunny.dev/t/files/43)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:01pm UTC](https://hotbunny.dev/t/files/43 "2026-10-21T16:01:45Z")

</div>

The Files namespace provides access to the in-game virtual file system. Create, read, modify, and navigate files and folders that appear in the player’s computer. Required permission: filesystem Import import { Files }…

---

## [Events API](https://hotbunny.dev/t/events-api/42)

<div class="topic-metadata">

**Author:** [@SteelWaffe7](https://hotbunny.dev/u/SteelWaffe7)\
**Replies:** 0\
**Last updated:** [October 21, 2026, 4:01pm UTC](https://hotbunny.dev/t/events-api/42 "2026-10-21T16:01:43Z")

</div>

The Events namespace provides access to the game’s event system. Listen to in-game events (terminal commands, file operations, network activity), emit events to the game engine, and communicate between mods using custom …

[Next page](https://hotbunny.dev/c/docs/api-reference/9.md?page=1)
