Document the new features in README and CLAUDE.md

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
funman300
2026-07-10 14:08:22 -07:00
parent cbbf9babf5
commit 38d4f5d1b7
2 changed files with 38 additions and 8 deletions
+15 -3
View File
@@ -74,12 +74,24 @@ Three-layer split; `JCA` is the single global namespace:
- UI hooks: wraps `Card:generate_UIBox_ability_table` to append a tooltip entry
to `aut.info` (format: array of rows-of-UIT-nodes plus a `.name` string —
must match what vanilla `info_tip_from_rows` expects), and wraps
`Card:update` for the ~2.5s pulse on recommended shop cards. Both hook bodies
are pcall-wrapped so a scoring bug can never crash a run — keep it that way.
`Card:update` for the ~2.5s pulse on recommended shop cards and the
partner highlight (hovering a joker juices its owned partners ~0.9s;
partner set cached on the card as `jca_hl`, dropped when hover ends).
All hook bodies are pcall-wrapped so a scoring bug can never crash a
run — keep it that way.
- Sell advisor: `JCA.weakest_link()` (full board + ≥3 jokers + a strict
minimum required, else nil) flags the lowest-total owned joker with a
red verdict row; suppressed by learning mode, toggled by
`config.sell_advisor`.
- Public API for other mods: `JCA.register(key, gives, wants, opts)`,
`JCA.register_pair(a, b, blurb)` (sets `JCA._pairs_dirty` so the
Combos tab re-sorts), `JCA.register_clash(a, b, warning)`. Unknown
tags are dropped with a log line, never an error.
- Config tab: registered on `SMODS.current_mod.config_tab`, guarded by
`if SMODS.current_mod` so standalone tests don't need full stubs.
- Synergy catalog: `SMODS.current_mod.extra_tabs` adds Combos/Engine/
Economy/Hands tabs that render real `Card` objects in `CardArea`s
Economy/Hands tabs (plus a text-only Progress tab with discovery
completion bars) that render real `Card` objects in `CardArea`s
(collection-style, so hover shows each joker's own tooltip). One theme
per page; pagers swap the `tab_contents` UIBox from an option-cycle
callback — the same pattern as SMODS's achievements tab. Because pages