aboutsummaryrefslogtreecommitdiff
path: root/building_guide/hacking.md
diff options
context:
space:
mode:
authorhistoria <[not public]>2026-10-01 14:38:08 -0400
committerhistoria <[not public]>2026-10-01 14:38:08 -0400
commit1082f3336085c15992ca83d5553c0ba52208d70a (patch)
tree4fcedaa90bc01c41456258a9d57f492f31754948 /building_guide/hacking.md
parentd4eae333a8d8a96452bbf3617aa85b50466c11a7 (diff)
downloadthehouseoficarus-1082f3336085c15992ca83d5553c0ba52208d70a.tar.gz
feat: pai gow poker added to the casino
Diffstat (limited to 'building_guide/hacking.md')
-rw-r--r--building_guide/hacking.md50
1 files changed, 0 insertions, 50 deletions
diff --git a/building_guide/hacking.md b/building_guide/hacking.md
deleted file mode 100644
index dc4372b..0000000
--- a/building_guide/hacking.md
+++ /dev/null
@@ -1,50 +0,0 @@
-## Hacking
-
-Hacking minigames are played by jacking into terminal objects. Terminals are YAML objects that are registered in Go's `terminalDefs` map.
-
-**The filename is the ID** (`terminal_basic.yaml` → `terminal_basic`); like all objects, the loader derives the ID from the filename — don't add an `id:` field (see `objects.md`).
-
-### Terminal Object YAML
-
-```yaml
-name: basic terminal
-color: "28"
-description: "A battered terminal with a cracked screen. {28}[Level 1 Hacking]{/}"
-inroom_description: "A {28}basic terminal{/} hums quietly against the wall."
-```
-
-- `id` must match a key in `terminalDefs` (Go code in `internal/game/hacking.go`)
-- `name` is used for matching in the `jack` command
-- `color` controls the display color
-- `description` is shown when examining the terminal
-- `inroom_description` is shown in room listings
-- No `behavior` field — terminals are registered in Go, not YAML behaviors
-
-### Adding a New Terminal
-
-1. Create an object YAML file in `data/objects/terminal_<name>.yaml`
-2. Add an entry to `terminalDefs` in `internal/game/hacking.go`
-3. Optionally create a new minigame implementation in `internal/game/hacking_<name>.go`
-4. Place the terminal object in a room's `objects:` list
-
-### Adding a New Minigame
-
-New minigames implement the `HackingMinigame` interface:
-
-```go
-type HackingMinigame interface {
- Init(level int) string
- HandleInput(input string) (output string, done bool, won bool)
- Name() string
-}
-```
-
-Optionally implement `XPBonuser` for bonus XP:
-
-```go
-type XPBonuser interface {
- BonusXP() int
-}
-```
-
-