Release 0.0.1.8.8.7

This commit is contained in:
WorldBosse committed 2026-10-29 21:59:06 +04:00
1 parent 3c8a17aa78
commit c7beab414c
16283 files changed
+768761 -2

No files matched your search

@@ -0,0 +1,309 @@
# R13 The maid
Owner roadmap (2026-10-06): "another base upgrade, similar to the mercenaries, we should be able to hire a maid ...
cook the best meals ... from the food in any chests in the base (inside walls) ... physically there ... needs
protecting, will not fight anything, if she dies she's gone, gets paid a copper daily, takes from your storage chest.
Where do we hire her from?" Research only: no mod or game file was changed. Every number is PROPOSED with one
recommendation; the owner settles them (section 8) before building.
R15 (settlers, minor settlement mechanics): deferred by the owner (2026-10-06), not researched here.
Short forms: `F/` = `LonaRPG/Data/Scripts/Frames/`, `E/` = `LonaRPG/Data/Scripts/Editables/`,
`S/` = `LonaRPG/Data/Scripts/`, `HCG/` = `LonaRPG/Data/HCGframes/event/`, `NPC/` = `LonaRPG/Data/NPCdata/`,
`FX/` = `LonaRPG/Data/Effects/`, `CHS/` = `LonaRPG/Data/CHSConfig/CHSconfigs_NPC/`,
`LC/` = `LonaCraft_dev/LonaCraft/Scripts/` (dev copy), `MR` = `docs/RESEARCH_AWAY_RAIDS_MERCS.md`.
`LC/110_Bases.rb` and `LC/120_Raids.rb` line numbers as read on 2026-10-06 (other builders are editing them;
`LC/140_AwayRaids.rb` and `LC/150_Mercs.rb` did not exist yet when this was written).
Renders and scripts (scratchpad `r13/`): `maid_candidates.png` (8 CHS looks, 3 part variants each),
`maid_render.py`, `allmaps.py` + `allev.pkl` + `q.py` (every event of every game map, queryable),
`foods.py`, `foodvals.py`, `tags.py` (pot tags, satiety, type tags of the food items).
## 0. Summary
| Question | Finding | PROPOSED |
|---|---|---|
| Hire point | Boss Mama's script is already redirected by Homes and her menu already takes extra lines (`LC/100_Homes.rb:100-107`, `:1344-1370`, `:1512-1525`); she runs the tavern's working girls (her "Work" line, `HCG/NoerTavernWaifu.rb:207`; `Text/ENG/TagMapNoerTavern.txt:115` "Waitress, Dancer") | **Boss Mama**, one line "Hire a maid" through a small provider hook in Homes |
| Look | `CHS/-char-F-REGULAR01.json:161` part 2 "02Maid": black dress, white apron (sheet `-char-F-REGULAR01`, index 0, pattern 2); used by no library template | W1 "02Maid", hair fixed per maid at hire |
| Never fights | an NPC's AI is a Ruby class named in its json, built by `eval(@ai).new` (`F/Modules/NonPlayerCharacter.rb:226-229`); `Npc_RunAway` runs from killers but fights when cornered (`E/4003_Npc_RunAway.rb:24-30`) | own class `Npc_LonaCraftMaid < Npc_RunAway`, no skills, hides in the far corner of her room |
| Gone for good | the game's unique NPCs die through a death event that writes `$story_stats["UniqueChar<name>"] = -1` (`EffectUniqueCharDed`, Map001 `-lib-MapObject`); their events check it in init (Map059 ev69) | own record; a `process_death` alias (`F/281_Game_NonPlayerCharacter.rb:797`) ends the hire; rehire at Boss Mama |
| Cooking | the dark pot is data driven: `$data_AlchemyRecipes` from `FX/Alchemy/*.json` (`S/103_FileGetter.rb:526-544`, `F/5_DataManager.rb:169`), applied by `darkPot_translate_recipe` (`E/29_Functions_DarkPot.rb:292-490`) | reuse the recipe table; each morning the dish with the most satiety her ingredients allow, up to 2, into the pantry chest |
| "Cooked" | no cooked flag in the item data (type tags are rot classes: Good Soup is tag `RawMeat`, `FX/Items/food_SoupLv2.json:10-15`); the inn meal is a satiety refill, not an item (`HCG/NoerTavern_Nap.rb:133`) | cooked = an output item of a dark-pot food recipe (3.2); raw food alone feeds nobody |
| Pay | Copper Coin = `ItemCoin1`, price 200 (`FX/Items/other_Coin1.json`) | 1 Copper a day from a chest inside the walls; 3 unpaid days -> she leaves |
| Build | | 4 items, about 740 Ruby lines, new `LC/160_Maid.rb` |
## 1. What the game and the mod give us
### 1.1 Hire points compared
| Place | NPC / script | Fit | Cost to wire | Verdict |
|---|---|---|---|---|
| **Noer tavern, Boss Mama** | Map059 ev69 `-point-TavernWaifu`, `HCG/NoerTavernWaifu.rb`; menu `\optB` built at `:200-215` | she hires out girls (Work -> Waitress / Dancer, `:207`, `:326`) and already sells Lona the inn room (`LC/100_Homes.rb:164`); a maid "from Boss Mama's girls" reads naturally; the place Lona already goes for food, rooms and the guild | lowest: redirect + menu hook exist (`LC/100_Homes.rb:954-972`, `:1344-1370`, `:1512-1525`; wrapper `LonaCraft/HCGframes/NoerTavernWaifu.rb`); RolePlayS has no copy of her script (not in `RolePlayS/HCGframes/event/`) | **recommended** |
| Guild receptionist | Map059 ev15, `HCG/NoerTavernGuildEmpolyee.rb:268-281` | a mercenary desk, not domestic staff | the MC-1 chain (MR 3.1); RolePlayS replaces this script (MR 1.6) | fallback only, while Boss Mama is gone |
| Bank, Maani | Map015 ev14, Homes seller `NoerBankMaani` (`LC/100_Homes.rb:103`) | sells houses, not staff | low (same Homes hook) | no |
| Back street women | Map063 `CommonWhore` and EV015-EV058, `set_npc("NeutralBSHumanwhoreF")` (`r13/q.py`) | prostitutes; popup lines only, no menu to hook | high (a new event script) | no |
| Refugee camps | hobo women on Map035 / Map073 / Map133 / Map166, `HCG/CommonRefugeeF.rb:15-24` (`\optB[Cancel,Barter,Begging]`) | a destitute woman working for food and a copper fits, but this is the natural entry point of the deferred settlers (R15) | medium (one more redirect) | keep for R15 |
| Saint Monastery nuns | Map064 `nun` / `Nun2`, `SaintHumanPriestF` | church staff, not for hire | high | no |
Boss Mama is deleted while `UniqueCharUniqueTavernWaifu == -1` or Cocona's quest is at 14-20 or 25 (Map059 ev69
init block). PROPOSED fallback: the same line is offered by the guild receptionist (MC-1's chain) while she is gone.
### 1.2 Homes' seller menu (reuse)
| Fact | Evidence |
|---|---|
| Sellers: game script + marker option; the wrapper runs the previous script and arms the extra lines | `LC/100_Homes.rb:100-107`, `:1344-1370` |
| Extra lines come only from `LOCATIONS` (houses, rooms) | `LC/100_Homes.rb:991-1012` (`menu_entries_for`) |
| A pick runs `lonacraft_home_action`, a `case` on `:buy / :rent / :status / :collect` | `LC/100_Homes.rb:1455-1463` |
| Boss Mama's `call_msg("\optB[...]")` is caught and extended (`extend_menu`, marker "Barter") | `LC/100_Homes.rb:1017-1031`, `:1512-1525` |
| The menu is armed only when there is at least one entry | `LC/100_Homes.rb:1352-1361` |
Needed: a provider hook, about 20 lines in `LC/100_Homes.rb`: `Homes.add_menu_provider(seller){ [[label, proc], ...] }`;
`menu_entries_for` appends the providers' lines; `lonacraft_home_action` calls `action.call(self)` when it is a Proc.
Any later seller line (R11 shopkeepers) can use the same hook.
### 1.3 Time, notices, coins, chests
| Fact | Evidence |
|---|---|
| `dateAmt` counts half days, `% 2 == 0` is day; only naps shift the date | MR 1.1; `F/123_Game_Date.rb:121-135` |
| Homes hooks `Game_Date#shift / addDays / oneDayForward` (rent expiry) | `LC/100_Homes.rb:1049-1072` |
| Popups during a nap are lost; Homes queues them (`notice`, `flush_notices`) | `LC/100_Homes.rb:475-492`, `:1108-1110` |
| `take_coins` (party coins) | `LC/100_Homes.rb:303-316` |
| Chest contents `{item => count}`, `get_box` / `write_box` | `F/203_Storage Boxes.rb:427-433` |
| Mod storage: Chest, Wardrobe (`:storage`), box ids from 66000, opened with size 0 = no limit | `LC/90_Furniture.rb:79-80`, `:166`, `:1146-1158`; `F/203_Storage Boxes.rb:438-439` |
| Food in mod chests never rots: the nap rots only the party, box 65533 and box 65535 | `E/97_Game_Actor_Stats&State&Nap.rb:132-134`; `F/203_Storage Boxes.rb:376-397` |
| Cooking pieces: Stove and Campfire ("Cooking Fire"), action `:cook` = the game's pot | `LC/90_Furniture.rb:86`, `:98`, `:1131-1133`; `Text/ENG/Furniture.txt:247-248` |
| Beds: Bed, BedDark, BedBlue, the Bedroll (kind key `PottedPlant`) | `LC/90_Furniture.rb:76-78`, `:108`; `Text/ENG/Furniture.txt:347-348` |
| Doors are closed again after every nap | `LC/110_Bases.rb:415` (`sync_doors`, B3) |
| Inside the walls, live map: `Bases.inside_tiles(map, rec, rm)` | `LC/110_Bases.rb:1567-1640` |
| Furniture of a base: `Bases.furniture_on(rec)` | `LC/110_Bases.rb:2523-2527` |
| Inside the walls, offline: AR-1's room graph from the map file + pieces | MR 2.3, MR 6 (AR-1) |
### 1.4 A non-fighting NPC
| Fact | Evidence |
|---|---|
| Town women `NeutralHumanCommonF`: fraction 3, health 100, def 3, `ai: Npc_RunAway`, killer skills `NpcBasicSh`, `BasicHeavy`, death event `EffectCommonCharDed` | `NPC/NeutralHumanCommonF.json:4`, `:17`, `:21`, `:38`, `:108` |
| `Npc_RunAway`: no target -> random step; killer / assaulter -> moves away, but turns and fights when 4 ways are blocked | `E/4003_Npc_RunAway.rb:14-41` |
| The json's ai string is evaluated as a class name: a class defined by the mod works | `F/Modules/NonPlayerCharacter.rb:226-229`; `F/39_Game_Event.rb:1891-1903` |
| With `master = $game_player`, fraction mode 2: friendly to Lona; Lona's hits start no fight | `F/281_Game_NonPlayerCharacter.rb:1025-1045`, `:874-881` (MR 1.5) |
| Raiders pick targets with their own tri-state AI; a non-friendly NPC can be one | `F/281_Game_NonPlayerCharacter.rb:549-566`, `:695-708` |
| Death: `process_death` -> death animation -> `summon_death_event`; `EffectCommonCharDed` leaves the body (cannibal drops only if Lona has the Cannibal trait) | `F/281_Game_NonPlayerCharacter.rb:797-808`, `:842-845`; `E/151_Game_Character_RangeCheck.rb:9-15` |
| Permanent death of uniques: `EffectUniqueCharDed` sets `UniqueChar<npc_name>` to -1 | Map001 `-lib-MapObject` (`r12/evfull.py` dump) |
| NPCs with `master == $game_player` are skipped by the build rule and the raid adoption | `LC/110_Bases.rb:1654`, `:1682`; `LC/120_Raids.rb:743` |
| Movement helpers: `Raids.bfs`, `Raids.step_down`, the `update_self_movement` alias | `LC/120_Raids.rb:867`, `:1054`, `:1512-1520` |
### 1.5 Sprites
`r13/maid_candidates.png` (3 part variants each). NPC looks are CHS composites: sheet + index + pattern select part
set `(index / 4) x 12 + (index % 4) x 3 + pattern` (MR 3.4); female cells 72 x 66, part images in
`Graphics/CharacterCharsets/FregC/`.
| # | Sheet [index] pattern | Part set | Look | Used by (game) | Fit |
|---|---|---|---|---|---|
| **W1** | **F-REGULAR01 [0] 2** | **02Maid** | **black dress, white apron; 13 hair choices** | **no template; one PirateBaneInn day NPC (Map081 ev30)** | **recommended** |
| W2 | F-REGULAR01 [0] 0 | 00Commoner | town dress, random colours | NeutralHumanCommonF (every town) | blends with townsfolk |
| W3 | F-REGULAR01 [1] 0 | 03Teller | red hair, headband, purple dress | the bank teller look | reads as a known NPC |
| W4 | F-REGULAR02 [0] 0 | 00OldMama | old woman, brown dress | none in the library | a housekeeper option |
| W5 | F-REGULAR02 [3] 0 | 09RefMAMA | refugee mother, rags | SMRefugeeCamp `-point-Mother` (Map133 ev51) | too poor for a hired maid |
| W6 | F-REGULAR01 [2] 1 | 07RandomPoorMiner | rags | hobo women in the refugee camps | keep for R15 |
| x | F-TEEN01 [3] 2 | 11CoconaMaidNoWeapon | Cocona's maid dress | Cocona (story character) | never |
Random parts are re-rolled at every map load (`create_chs_configuration` samples each part,
`F/Modules/Charset_System.rb:121-130`; called from `F/39_Game_Event.rb:1791`), so W1's hair would change every
visit. PROPOSED: at hire draw one hair (`head_equip`) and face (`head`), save their names; after the spawn overwrite
those two entries in `chs_configuration` and refresh (about 15 lines; checked in the build's first run).
## 2. Hiring, pay, leaving (PROPOSED)
| Point | PROPOSED |
|---|---|
| Line in Boss Mama's menu | not hired: "Hire a maid (1 Copper a day)"; hired: "Your maid, <name>" (post base, unpaid days); after a death: the hire line again |
| Hire flow | Boss Mama's lines about one of her girls; pay `hire_fee` 5 Copper Coins from Lona's purse (`take_coins` style); a name drawn from `Text/<lang>/Maid.txt`; hair and face drawn and saved; record written; notice "She will come to the next camp you enter" |
| Only one | `max` 1 maid at a time |
| Taking post | at the first base Lona enters that has a closed room (`inside_tiles` not empty); else she waits (line on entry: "no safe room here yet"). Same rule as the mercenaries (MR 3.2 "Where") |
| Pay | at the shift into day (`dateAmt % 2 == 0`), per day caught up (at most `catchup_days` 14): take `pay` 1 `ItemCoin1` from the storage pieces inside the walls (pantry first); none -> `unpaid` + 1; a paid day resets it |
| Not paid | `unpaid >= grace_days` (3): she leaves; notice "<name> left: no wages for 3 days"; Boss Mama can send another |
| Pay day while Lona is away | the same, offline (AR-1's inside lookup, section 5) |
| Dismiss | from her talk menu; no refund; the event fades, the record goes |
| Save | `lonacraft_data["maid"] = {"name", "hired", "base" (id or nil), "post" [x, y], "t" (last day handled), "unpaid", "look" {"head_equip", "head"}, "cooked" (total), "last" [[item, n], ...]}`; `lonacraft_data["maid_lost"] = {"name", "at", "how"}` for the report; plain types, no save hook (as Homes, `LC/100_Homes.rb:249-265`) |
| Cost compared | 200 a day; the mercenary squad 2,000 a day (MR 3.5); the inn room 2 Large Copper a week (`LC/100_Homes.rb:164`) |
## 3. Cooking (PROPOSED)
### 3.1 The pot's table
| Fact | Evidence |
|---|---|
| A recipe has `requirements` (pot tag => count), `conditions.excludeIngredients`, `conditions.MinStatReq` (`"$game_player.actor.survival_trait": 10`), `bannedItem`, `output` (item => quantity formula), `postProcess` (deductions) | `FX/Alchemy/2000_darkPot_UniqueFoodFormula.json:4-40`; `FX/Alchemy/6000_darkPot_MeatAndSoups.json:64-416` |
| An item's pot tags: `item.pot_data` (Apple Plant 1 + Fruit 1; Carrot Plant 1 + Vegetable 1; Raw Meat Meat 1; Potato Plant 1 + Starch 1; Nuts Starch 1 + Fat 2; Smoked Meat SmokedMeat 1 + Fat 2; Oil Oil 1; the mod's Plank Wood 1) | `F/Modules/ItemConfig.rb:146`; `FX/Items/food_*.json`, `other_Oil.json`; `LonaCraft/Item/Plank.json:16` (`r13/foods.py`) |
| The player's pot sums every tag of everything put in, then runs all recipes in file order; Wood in the pot blocks the soups (`bannedItem` Wood) | `HCG/Command_DarkPot.rb:64-80`; `E/29_Functions_DarkPot.rb:494-507`; `6000_...json:93-98` |
| A dish's satiety: `item.use_item_effect`, attribute `sat` without a `stats_key` | `F/Modules/ItemConfig.rb:296-317`; `F/25_Game_Actor.rb:1372-1378` |
### 3.2 What counts as cooked (shared with R14)
No cooked flag in the data: `type` is Food / FoodBad / Waste and `tag` is a rot class (Good Soup and the meat soups
are tag `RawMeat`, Plant Soup and Meat Salad `RawPlant`; `r13/tags.py` over `FX/Items/food_*.json`). The inn meal
sets satiety to full and gives no item (`HCG/NoerTavern_Nap.rb:133`). So, PROPOSED, one rule for the maid and the
R14 rest: **cooked = an output item of a dark-pot food recipe**, read at runtime from `$data_AlchemyRecipes`
(`output` keys whose item `type` is Food or FoodBad: `FX/Alchemy/2000_darkPot_UniqueFoodFormula.json:26-30`,
`FX/Alchemy/6000_darkPot_MeatAndSoups.json` `output` blocks). Raw meat, vegetables, fruit, nuts and herbs never count:
raw food alone in a chest feeds nobody. Her morning cooking turns the raw food in the chests into dishes, and those
dishes are what the rest eats.
| Dish (pot output) | Needs (pot tags) | Survival | sat / mood | Note |
|---|---|---|---|---|
| ItemMeatSalad | SmokedMeat 1, Plant 4, Fruit 2, Vegetable 2, Oil 1, Starch 1, Fat 2 | 10 | 80 / 40 | best; no human or mystic meat (`2000_...json:5-28`; `FX/Items/food_SF_MeatSalad.json:34-42`) |
| ItemSopGood | Plant 1, Meat 1 (no Wood) | - | 32 / 20 | `6000_...json:164-185`; `food_SoupLv2.json` |
| ItemSmokedMeat | Meat 2, Wood 1 | 10 | 26 / - | keeps; a salad ingredient (`:290-313`) |
| ItemDryFood | Plant 2, Wood 1 | 10 | 16 / - | keeps (`:187-210`) |
| ItemSopMeat | Meat 2 | - | 16 / 10 | `:398-416` |
| ItemSopPlant | Plant 2 | - | 16 / 10 | `:315-333` |
| ItemJunkFood (x3) | Plant 1, Starch 1, Oil 1 | - | 1 / 3 each | FoodBad; never the best |
| the Human / Mystery variants | the same + HumanMeat / MysticMeat | | 12-32, mood -10, puke | refused by default (`refuse_bad_meat`) |
Raw for comparison: Raw Meat sat 8 (+15 puke), Apple / Carrot / Potato 5 each (`r13/foodvals.py`). One meat and one
carrot eaten raw = 13; cooked into Good Soup = 32.
Open, shared with R14: prepared foods that are not pot outputs (Bread sat 10, Cheese 32, Sausage 26; type Food,
tag Food) are not "cooked" under this rule. PROPOSED: they are not, to keep one definition.
### 3.3 The morning cook
| Step | PROPOSED |
|---|---|
| When | the shift into day, after pay (2), once per day caught up; only while posted and alive |
| Needs | a Stove or Cooking Fire inside the walls (else no cooking, notice "<name>: no fire to cook on"); the fire stands in for the recipes' Wood (Smoked Meat, Dry Food); planks and clubs are never burnt |
| Pool | items in the storage pieces inside the walls whose `pot_data` has a food tag (Plant, Meat, Fruit, Vegetable, Starch, Oil, Fat, SmokedMeat) and whose type is Food (plus ItemOil); FoodBad (rats, roaches, flesh) and human / mystic meat left alone (`refuse_bad_meat`) |
| Skill | `MinStatReq` gates use her `cook_skill` 10 in place of Lona's survival trait (the key is read, not evaluated) |
| Pick | per food recipe: cover its requirements with whole items, greedily (the item covering most still-missing tags first, then the cheapest); score = sat of the dish - sat of cooked items used up (a Smoked Meat used in a salad counts 26 against it); best score > 0 wins |
| Make | remove the items used, add 1 dish to the pantry; repeat up to `dishes_per_day` 2; stop when the cooked dishes inside the walls reach `pantry_cap` 6 (raw food does not rot in chests, 1.3, so waiting wastes nothing) |
| Pantry | the storage piece inside the walls nearest the fire (else nearest her post) |
| Report | queued notice for the wake-up: "<name> cooked Good Soup x2"; nothing possible: "<name>: the pantry is bare" (once, until food appears) |
| R14 | the rest eats one cooked dish from the chests inside the walls (R14's rule); the maid keeps that supply going |
Worked example: one chest inside a 1-room palisade with a Stove, holding 3 Raw Meat, 4 Carrot, 2 Apple, 1 Potato,
1 Oil. Day 1: Good Soup x2 (meat + carrot each) = 64 sat; left 1 meat, 2 carrots, 2 apples, 1 potato.
Day 2: Good Soup (meat + carrot) 32, then Plant Soup (carrot + apple) 16. Day 3: Plant Soup (apple + potato) 16;
the chest now holds only the Oil, so nothing more (the salad would have needed a Smoked Meat, 2 vegetables and
2 fruit at once). Eaten raw the same food was worth 3 x 8 + 7 x 5 = 59 sat; cooked, 128.
## 4. The maid at the base (PROPOSED)
| Point | PROPOSED |
|---|---|
| NPC data | `NPC/LonaCraftMaid.json` in the mod, loaded with the mercenary files (MR 3.2): a copy of `NeutralHumanCommonF` with `ai: Npc_LonaCraftMaid`, `skills_killer` / `skills_assaulter` empty, `drop_list` empty, `health` 150, def 3, sensors Eyes, death event `EffectCommonCharDed` |
| AI class | `Npc_LonaCraftMaid < Npc_RunAway` in `LC/160_Maid.rb`: never picks a skill; `get_move_command` returns nil so the driver below owns her steps |
| Event | runtime `RPG::Event` as the mercenaries / furniture (`LC/90_Furniture.rb:571-635`), sheet `-char-F-REGULAR01` index 0 pattern 2; init: `set_npc("LonaCraftMaid")`, `@nappable = false`, `npc.master = $game_player`, `fraction_mode = 2`, `summon_data[:LonaCraftMaid] = true`, saved hair applied; action -> `lonacraft_maid_talk` |
| Spawn | after every `Game_Map#setup` of the post base (as doors and furniture, `LC/110_Bases.rb:409-416`); not nappable, so a nap removes and re-makes her (`F/31_Game_Map.rb:359-372`, MR 1.5) |
| Her room | the inside room (component of `inside_tiles`) holding the fire, else a bed or Bedroll, else the largest; post tile = a free tile next to the fire or bed |
| Calm | a random step every few seconds, only onto tiles of her room, at most `wander` 3 tiles from the post |
| Flee | a hostile within `flee_radius` 6 tiles (the `hostile_near?` test centred on her, `LC/110_Bases.rb:1665-1690`) or a live raid (`Raids.active?`, `LC/120_Raids.rb:584`): walk to the tile of her room farthest from its doors (`Raids.bfs` from the door tiles over the room, then `step_down` toward the maximum, `LC/120_Raids.rb:867`, `:1054`) and stay there; doors are closed after naps (1.3), so raiders reach her only by breaking in. One more branch in the `update_self_movement` dispatch (MR 3.2 "Behaviour") |
| Raiders | they target her through their own AI (1.4) and can kill her: Lona has to keep them out. A bandit spear (atk 20) against def 3: about 9 hits at 150 HP |
| Death | `process_death` alias: an event with `summon_data[:LonaCraftMaid]` -> record moved to `maid_lost`, notice "<name> was killed", never spawned again; the body stays as for any NPC. Rehire at Boss Mama |
| Talk | Status (post base, days with you, unpaid days, last dishes, cooked dishes in the pantry); Come with me (post cleared, she takes post at the next base entered); Dismiss; Cancel |
| Bed | not needed (keep it simple: she sleeps at her post); option in 8 |
| Her own food | none (paid in coin) |
### 4.1 Away raids
| Point | PROPOSED |
|---|---|
| Hook | in AR-1's loop, when a room is reached (MR 2.3, step 3): if it is the maid's room and the budget left is at least `loot_swings` (3), roll `away_kill` 0.5: she dies (report line "<name> was killed"); else "<name> hid and lived" |
| Who | any group that reaches her room rolls (killing needs no looters: undead too) |
| Mercenaries | a squad that repels the raid (MR 3.6) protects her as well |
| Expected | 1-room palisade on a field base: P(raiders reach her room) = (Orkind 70 x 0.53 + Bandits 30 x 1.0 + Undead 20 x 1.0 + Wolves 20 x 0) / 140 = 0.62 per raid (weights `LC/120_Raids.rb:139`, reach MR 2.6); x 0.5 = 0.31 per raid; at about 0.8 away raids a week (MR 2.1) about 0.25 deaths a week. 2-ring base with her in the inner room: bandits reach it 32 %, goblins 0 % (MR 2.6): about 0.1 a week. With a squad posted: about 0 |
| Live raid on the base | section 4: she hides; raiders who break in can kill her for real |
## 5. Shared with the mercenaries build (what `150_Mercs.rb` / `140_AwayRaids.rb` should expose)
| Need | From | Form |
|---|---|---|
| NPC jsons from the mod's `NPC/` folder into `$data_npcs` | MC-2 | load every `NPC/*.json` of the mod, not only the two mercenary files |
| Runtime NPC event builder | MC-2 | `Mercs.build_npc_event(npc_name, sheet, index, pattern, x, y, summon_key, talk_method)` |
| Spawn after setup of a post base | MC-2 | a resident list (`key`, base of, spawn proc) and one `after_setup` loop |
| Post base rule ("first base entered", move post) | MC-2 | `Mercs.claim_post(record)`; the maid adds "has a closed room" |
| Movement dispatch | MC-2 | the `update_self_movement` alias dispatching on `summon_data` keys (`:LonaCraftMerc`, `:LonaCraftMaid`) |
| Death / down hook | MC-2 | one `process_death` alias dispatching on `summon_data` keys (mercenary: down; maid: gone) |
| Date hook | MC-1 / AR-2 | one alias of `Game_Date#shift` / `addDays` / `oneDayForward` calling a list of day callbacks: mercenary expiry, away raids, maid pay + cook, in that order |
| Offline "inside the walls" | AR-1 | `AwayRaids.inside_furniture(rec)` (furniture records in a non-outside room) and `AwayRaids.room_of(rec, x, y)`; live maps may use `Bases.inside_tiles` |
| Room reached | AR-1 | `AwayRaids.on_room_reached(rec, room, budget_left)` returning report lines |
| Config section | `LC/120_Raids.rb` | `"maid"` in `DEFAULTS` (next to `"away"` / `"mercs"`, `:147-161`) and in `merge_user` (`when "away", "mercs"`, `:276`) |
| Seller line | `LC/100_Homes.rb` | the provider hook (1.2) |
## 6. Config (PROPOSED, `Config/Bases.json`)
```json
{
"maid": {
"enabled": true, "hire_fee": 5, "coin": "ItemCoin1", "pay": 1, "grace_days": 3, "catchup_days": 14,
"dishes_per_day": 2, "pantry_cap": 6, "cook_skill": 10, "refuse_bad_meat": true, "need_fire": true,
"health": 150, "wander": 3, "flee_radius": 6, "away_kill": 0.5
}
}
```
## 7. Work breakdown (PROPOSED)
| Item | Scope | Files | Ruby lines | Depends on | Owner choices |
|---|---|---|---|---|---|
| MD-1 Hire, pay, leave | Homes provider hook; Boss Mama line + hire flow (+ guild fallback while she is gone); record; day callback: pay, unpaid, leave; notices; `maid` config section; texts | `LC/100_Homes.rb` (~20), `LC/160_Maid.rb` (new), `LC/120_Raids.rb` (~5), `Text/<5 langs>/Maid.txt` (new, ~25 keys), `loader.rb` | 200 | Homes; MC-1 / AR-2 date hook | 1-3 |
| MD-2 The maid at the base | `NPC/LonaCraftMaid.json`; `Npc_LonaCraftMaid`; spawn, room and post, wander, hide in the far corner, fixed hair, talk menu, death = gone | `LC/160_Maid.rb`, `NPC/LonaCraftMaid.json` (new) | 280 | MC-2 resident helpers (5) | 4, 5, 11-13 |
| MD-3 Cooking | recipe reader over `$data_AlchemyRecipes`, cooked list (shared with R14), pool from chests inside the walls, greedy cover, best dish, pantry, catch-up, wake-up notice | `LC/160_Maid.rb` | 180 | AR-1 inside lookup; MD-1; R14 reads the cooked list | 6-9 |
| MD-4 Raids, debug, self-test | AR-1 room-reached kill roll + report lines; Numpad . menu: hire free / cook now / kill maid; self-test rows (`ItemMeatSalad` in `$data_ItemName`, `Npc_RunAway` defined, `$data_AlchemyRecipes` not empty, `-char-F-REGULAR01` part 2 is "02Maid") | `LC/140_AwayRaids.rb` (~25), `LC/120_Raids.rb` (~15), `LC/98_SelfTest.rb` (~10), `LC/160_Maid.rb` | 80 | AR-1, AR-2, MD-2 | 10 |
Total about 740 lines. Order: MD-1 -> MD-2 -> MD-3 -> MD-4, after MC-2 and AR-1 are in. Note for MD-4:
`food_SF_MeatSalad.json` names itself under the key `"ItemOil"` (`FX/Items/food_SF_MeatSalad.json:2`, a game typo);
the item still exists as `Data/Items.rvdata2` id 153 named `ItemMeatSalad`, hence the self-test row.
## 8. Choices for the owner
| # | Choice | Options | PROPOSED |
|---|---|---|---|
| 1 | Hire point | Boss Mama / guild receptionist / refugee camp women / Maani | Boss Mama; guild receptionist while Boss Mama is gone |
| 2 | Hire fee | none / 5 Copper / 1 Large Copper | 5 Copper |
| 3 | Wages | 1 Copper a day from a chest inside the walls, leaves after 3 unpaid days / from Lona's purse / prepaid weeks | chest, 3 days grace |
| 4 | Look | W1 Maid / W2 Commoner / W4 OldMama (`r13/maid_candidates.png`) | W1, hair fixed per maid |
| 5 | Where she stands | the room with the fire (else a bed), wandering 3 tiles / anywhere inside / by the door | the fire room |
| 6 | Fire needed to cook | yes, Stove or Cooking Fire inside the walls (also the "Wood" for smoking and drying) / no | yes |
| 7 | Dishes a day | 1 / 2 / as many as the food allows; pantry cap 6 | 2, cap 6 |
| 8 | Bad meat | refuse human / mystic meat and FoodBad / cook anything | refuse |
| 9 | "Cooked" (shared with R14) | dark-pot outputs only / also Bread, Cheese, Sausage | pot outputs only |
| 10 | Away raid danger | 50 % death when raiders reach her room with budget left / 25 % / never | 50 % |
| 11 | Live raid | killed for good (owner's words) / only knocked down | killed for good |
| 12 | Bed | not needed / a bed or Bedroll inside the walls required to take post | not needed |
| 13 | Health | 150 / 100 (town woman) / 300 | 150 |
| 14 | Config | `maid` section in `Config/Bases.json` / a new file | `Config/Bases.json` |
## Change 2026-10-07: a house as her post
Owner, 2026-10-07: "The maid should also be able to be sent to any houses you own, not just bases."
Built in the dev copy with these decisions (dispatcher's recommendation, applied unless the owner says
otherwise):
| Point | Built |
|---|---|
| Which houses | the bought homes of `LC/100_Homes.rb` LOCATIONS: rows with their own map (`:interior`), not `:mode => :rent` (today `noer_shack` Old Shack, `noer_stonehouse` Stone House); a rented inn room is never a post |
| Save | `lonacraft_data["maid"]["base"]` (base id) or `["home"]` (location id string), never both; `Maid.post` gives `[:base, record]` / `[:home, id]`, `Maid.post_ref` the saved shape; a save with only `"base"` works as before; `70_Save.rb` unchanged (no maid key in a remap table) |
| Bed rule | unchanged: a Bed / Dark Bed / Blue Bed / Bedroll must be placed in the house, else "There is nowhere for me to sleep." and no charge |
| Inside the walls | the whole house, as `Rest.inside` (`LC/160_Rest.rb:120`, `:all` for an owned home): every furniture record whose `map_id` is the house's runtime map number (`Homes.map_id_for`); wages, the pantry and the fire are read from these as from a base's |
| Spawn | after every `Game_Map#setup` of the house map (`Homes.home_at_map?` of the live map = her house; `Homes.setup_key` already turns a map number back into the file key); despawned on Move / Dismiss as before |
| Her room | `Homes.floor_tiles(map, id)` minus the tiles on or next to the map's `-point-StartPoint` / `-point-ExitPoint` (Shack 15,17 / 15,18; Stone House 15,18 / 15,19), so she never blocks the stairs; post tile = the free room tile nearest the fire, else a bed |
| Hiding tile | the free room tile farthest (`Raids.bfs` over the floor) from the StartPoint / ExitPoint; she goes there only when a hostile comes within `flee_radius` (no live raids in a house) |
| Raids | away raids never touch a house (`Maid.away_tile` only answers for a base post); `Raids.active?` is not read for a house post |
| Menus | hire and Move: `lonacraft_maid_choose` lists `Bases.pick_list` names, then the owned houses by `Homes.text(loc[:name])`, Cancel last, through the maid's own `\optB` ask (commas, brackets, colons and backslashes dropped); `Bases.choose_base` unchanged (the mercenaries keep it, base-only) |
| Texts | `Text/<lang>/Maid.txt`: Hire/offer, Hire/ask_base, Hire/no_base, Talk/opt_move, Talk/ask_base reworded for "camp or house"; new Talk/where "I look after BASE." appended to her status |
| Debug | Numpad . "Hire a maid free" inside an owned house posts her to that house |
| Self-test | runtime row "maid posts (bases and houses)": the saved shapes, every bought house can be a post, no rented room can |
## Change 2026-10-08: Boss Mama's bed refusal
Owner, 2026-10-08: "'There's no place for me to sleep' needs to be changed to 'There's no place for her to sleep' and fix the translations for it as well. We are talking to Big Momma, not the maid she sends."
| Key | Who says it | Before | Now |
|---|---|---|---|
| Hire/no_bed | Boss Mama (hire, `lonacraft_maid_offer`) | "There is nowhere for me to sleep." (CHT 這裡沒有我睡覺的地方。 KOR 제가 잘 곳이 없어요. RUS Мне негде спать. UKR Мені немає де спати.) | "There is nowhere for her to sleep." (CHT 那裡沒有她睡覺的地方。 KOR 그녀가 잘 곳이 없다. RUS Ей негде будет спать. UKR Їй ніде буде спати.) |
| Talk/no_bed (new) | the maid (her Move menu, `lonacraft_maid_talk`; it used Hire/no_bed) | - | her speaker line + "There is nowhere for me to sleep there." (CHT 那裡沒有我睡覺的地方。 KOR 거기엔 제가 잘 곳이 없어요. RUS Там мне негде спать. UKR Там мені немає де спати.) |
The other lines Boss Mama speaks were checked and already speak of the maid in the third person: Hire/offer ("One of the girls ... She cooks ..."), Hire/ask_base ("Which camp or house should she keep?"), Hire/no_base, Hire/no_coins, Hire/done ("NAME will be at BASE ..."), Hire/status ("NAME keeps BASE ..."). No other line was in the maid's voice. Talk/ask_base ("Which camp or house should she keep?") shows in the maid's own menu as a prompt (no speaker), unchanged.