From 4db68b32ca77cecc84a35fa26fd60b132c4d23c7 Mon Sep 17 00:00:00 2001
From: Zsolt Tasnadi <rastasi@gmail.com>
Date: Tue, 26 May 2026 07:33:31 +0200
Subject: [PATCH] readme update

---
 README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 58 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index bf776bd..94bf2f0 100644
--- a/README.md
+++ b/README.md
@@ -5,8 +5,6 @@ A short point-and-click adventure built on the
 three items, one NPC dialog and an ending cutscene — small on purpose,
 designed as an end-to-end reference for someone learning the library.
 
-Full walkthrough and file layout: [`DEMO.md`](DEMO.md).
-
 ## Running it
 
 The library is fetched as a regular Go module. Prerequisites: Go 1.24+
@@ -48,6 +46,58 @@ go mod tidy
 
 Remove the `replace` line before pushing.
 
+## Project layout
+
+Game content lives in `lib/` as package-level `var`s — one struct value
+per file, no constructor functions. `main.go` only calls `lib.Run()`.
+
+```
+main.go                       func main() { lib.Run() }
+lib/
+  setup.go                    Run() and Build(); the only wiring code
+  assets.go                   var Assets []pncdsl.Asset
+  flags.go                    flag-name constants
+  character.player.go         var Player
+  character.cat.go            var Cat
+  item.key.go / beans / mug   var Key, Beans, Mug
+  scene.bedroom.go            var Bedroom
+  scene.kitchen.go            var Kitchen
+  script.intro.go             var IntroScript
+  script.victory.go           var VictoryScript
+  dialog.cat_morning.go       var CatMorning
+  theme.go                    var MorningCoffeeTheme + var Chat
+  widget.gamechat.go          GameChat — demo-only chat widget
+  widget.savekeys.go          SaveKeys — F5/F9 save/load
+```
+
+Adding new content means creating one file with one `var`, and adding
+one `Register(...)` line in `lib/setup.go`. No registrar functions, no
+indirection.
+
+## Custom theme and chat widget
+
+The demo ships with a game-specific theme (`morning-coffee`, warm coffee
+browns over deep espresso) registered alongside the framework's preset
+themes and activated in `Build()`. It is registered the same way as any
+other entity:
+
+```go
+g.ThemeManager.Register(MorningCoffeeTheme)
+g.UseTheme("morning-coffee")
+```
+
+The chat strip at the bottom of the screen is **not** the framework's
+built-in `ChatLog`. It is `GameChat`, a demo-only widget defined in
+`lib/widget.gamechat.go`: click to focus (border highlights), type a
+message, press Enter to send. The widget responds with a random canned
+line — independent of the game state, just a playful HUD element. The
+framework's `ChatLog` is removed and `GameChat` is registered in its
+place during `Build()`.
+
+`GameChat` is intentionally kept inside the demo. If another game wants
+the same panel, copy the file in; the framework stays free of any
+gameplay-flavoured chatter.
+
 ## Controls
 
 | Action | Effect |
@@ -55,9 +105,14 @@ Remove the `replace` line before pushing.
 | left click on a hotspot/UI button | run the active verb |
 | left click on an inventory item   | select it (cursor picks it up) |
 | left click on a hotspot with item selected | use-with |
-| right click                       | deselect held item, or reset verb to Look |
+| right click on a hotspot          | open the verb coin |
+| right click elsewhere             | deselect held item, or reset verb to Look |
+| left click on the chat panel      | focus chat input |
+| type + Enter (chat focused)       | send message, receive a random reply |
+| Esc                               | unfocus chat |
 | click during dialog               | advance line / pick choice |
 | **F1**                            | toggle hotspot debug overlay |
+| **F5** / **F9**                   | save / load slot 0 |
 
 ## License