Repository navigation
v1.6.0
Pre-releaseFTK Mod Framework 1.6.0 (preview)
Framework 1.6.0 adds Tweaks: small, switchable corrections to the base game
that the framework itself ships. They fix defects, show information the game already
tracks, and remove UI friction. Open Mods > Tweaks to see each tweak with its
summary, scope, default and any balance note. Choices save immediately, and
Reset all to defaults returns every row to its default.
This is a preview release. It is published as a GitHub pre-release, so the
Stable update channel does not install it. Choose Preview or pin v1.6.0 in
Mods > Updates to try it. Many tweaks are tested only by game-free checks so
far; see Verification and limits below.
Tweaks in this release
Each row reads "Title: On/Off", with "(default)" while it follows its default.
Only you tweaks change only your own screen or input and apply at once.
Shared rules tweaks are Session tweaks: they change the rules of a run, apply
in solo and local play, and take effect from the next run you start or resume.
Fixes
| Tweak | ID | Scope | Default | Balance note |
|---|---|---|---|---|
| Dungeon names in quest text | fix.quest-dungeon-name |
Only you | On | None |
| Clear the Wet icon after combat | fix.stale-wet-icon |
Only you | On | None |
| Clear the group shield icon after combat | fix.stale-group-shield-icon |
Only you | On | None |
| Show Taunt and Petrified status icons | fix.player-status-icons |
Only you | On | None |
| Correct Perfect chances | fix.perfect-chance |
Only you | On | None |
| Unstick the skip-turn popup | fix.stuck-skip-turn-popup |
Only you | On | None |
| Find Herb in dungeons | fix.dungeon-find-herb |
Shared rules | On | Herbalists can find herbs each party turn in dungeons, not once per visit; many more herbs in the Endless Dungeon. |
| Keep poison countdowns on load | fix.poison-decay-resume |
Shared rules | On | Poison no longer lasts extra turns after loading a save. |
- Dungeon names in quest text shows the dungeon's name in quest dialogue
instead ofSTR_DungeonNoneDisplay, as after the King's Maze. - Clear the Wet icon and Clear the group shield icon hide those status
icons on your HUD outside combat, as the game already does for other combat
statuses. - Show Taunt and Petrified status icons turns on the game's own Taunt and
Petrified icons on your HUD in combat, and names Dazed in the stunned icon's
tooltip when only Dazed applies. - Correct Perfect chances makes the Perfect figure on combat buttons count
Shocked, Illuminated and Darkness, and Taunt's own accuracy. Rolls are unchanged. - Unstick the skip-turn popup closes a skip-turn popup that was interrupted
before it closed, once, as the game would have closed it. - Find Herb in dungeons refreshes the party's Find Herb cooldown after each
full turn cycle in a dungeon, as a new round does outside. - Keep poison countdowns on load saves each character's poison countdown, so
poison wears off on the same end turn as if you had never saved. It never
shortens poison.
Information
All Information tweaks are Only you and off by default. None has a
balance note.
| Tweak | ID | What it shows |
|---|---|---|
| XP within the level | information.xp-in-level |
XP as progress through your current level, matching the XP bar, with your total in brackets |
| Poison turns left | information.poison-turns |
End turns left until your poison wears off, in the poison status tooltip |
| Sell price in item details | information.sell-price |
At a shop, what each unequipped item in your inventory sells for, on its item card |
| Mark encounters that vanish | information.vanishing-encounters |
On a known encounter's hover card, that leaving it or ending your turn there removes it |
| Name the achievements House Rules disable | information.house-rules-achievements |
When your House Rules count as easier, that the three Defeat Vexor achievements and win statistics won't be recorded |
Convenience
All Convenience tweaks are off by default. None has a balance note.
| Tweak | ID | Scope | What it does |
|---|---|---|---|
| Skip intro | convenience.skip-intro |
Only you | Skips the intro videos at startup, as if you pressed a key during each one |
| One-press inventory | convenience.one-press-inventory |
Only you | One press of the Inventory key opens your inventory on keyboard and mouse. Controllers keep the two-press belt |
| Refund movement focus | convenience.refund-movement-focus |
Shared rules | During your own turn, take back focus spent on movement while the extra move is unused and you have not set off. Click a faded focus pip or press Backspace. Keyboard and mouse only |
The refund key is [TweakKeys] RefundMovementFocus in
BepInEx/config/com.ftkmf.framework.cfg, default Backspace. None turns the
key off. A key that a game control also uses is ignored, with one warning.
Session rules and saves
Shared-rules tweaks are captured when a run is set up, locked when it starts,
and cleared when it ends. Changing one during a run affects only the next run.
In online co-op, every Session tweak stays off until the co-op contract ships.
A run keeps the Session rules it started with. Each save of a run with Session
tweaks carries a small record, the key ftkmf.session, listing which Session
tweaks were on. Resuming that save restores those rules even if you changed the
settings since. A save without a record, such as one made before 1.6.0, follows
your current settings and gains a record on its next save. With Keep poison
countdowns on load on, a poisoned character's save also carries
ftkmf.poison. Neither key changes save identity or save folders. Vanilla
ignores unknown keys and drops them on its next save.
Diagnostics
These [Diagnostics] settings live in BepInEx/config/com.ftkmf.framework.cfg.
Each is read at startup; restart the game after changing one.
| Setting | Default | Effect |
|---|---|---|
StuckTurnWatchdog |
true |
Writes one STUCK-TURN warning when your End Turn button stays unavailable for 20 seconds with nothing on screen explaining it (90 seconds behind a shop, inventory or message), or when the host waits over 15 seconds for a player's acknowledgement |
SoftlockSignatures |
true |
Writes one SOFTLOCK-SIGNATURE warning when a known softlock path appears: a POI that fails to load, a loot vote with no voter, a hidden place discovered repeatedly, a stale dungeon flag, or a combat flag with no fight |
LogLocalizationMisses |
false |
Writes one [loc-miss] line per missing text key, up to 256 keys. Never changes text |
RunSelfTests |
false |
Development only. Runs load-time self-tests and registers the Session lifecycle probe tweak. Leave it off for normal play |
The watchdog and signature lines change nothing in the game and never open a
report on their own. They reach BepInEx/LogOutput.log and therefore bug-report
diagnostics. Bug reports, manual and automatic, now also include your tweak
choices and the tweaks in effect, including the Session source and any tweak
turned off after an error.
Upgrade notes
- Stable users stay on 1.5.1 until a later stable release is published.
Preview-channel installations from 0.1.0 up to 1.5.1 on the verified game build
are in the automatic update range; other game builds keep their bundled version. - Every tweak follows its default until you change it. Fixes are on; Information
and Convenience tweaks are off. Your choices are stored in the[Tweaks]
section ofBepInEx/config/com.ftkmf.framework.cfg. - Saves from earlier versions resume with your current Session settings. Make a
backup before testing a preview. Returning to an earlier framework is expected
to ignore the new save keys, but loading such a save in vanilla or an earlier
framework is not yet verified. - Use a full game restart after updating.
Verification and limits
Game-free checks. The Release build and the full game-free matrix pass:
framework, Tweaks, Session record hooks, reporting, player-mod and performance
tests, installer fixtures, Go helper and catalog checks, launcher and
release-manifest checks, harness tests and the packaging dry run. A build or a
game-free test does not prove in-game behavior.
Live evidence comes from one macOS test copy, solo offline, keyboard and
mouse:
- The Tweaks tab lists, toggles, resets and persists choices.
- Session capture, lock and clear pass the self-test probe in solo play, and a
solo save carries and restores itsftkmf.sessionrecord in both directions. - Keep poison countdowns on load writes and restores a countdown on resume,
and Poison turns left shows the same count before saving and after
resuming. - Find Herb in dungeons clears the cooldown once per dungeon turn cycle, and
the overworld behaves as vanilla. - Sell price in item details shows prices for unequipped items that match
the Sell button, and none for equipped items. - One-press inventory opens and closes the inventory with one press, and
takes two presses when off. - XP within the level was seen only at level 0.
- Correct Perfect chances figures were seen, without an on/off comparison.
The other fixes, Mark encounters that vanish, Name the achievements House
Rules disable, Refund movement focus, and the three diagnostics settings
have game-free evidence only.
Known limitations:
- Session tweaks are off in online co-op until the co-op contract ships.
- Open live gates: a vanilla load of a save that carries records (#253 L8); a
second Find Herb in the same dungeon; the group shield icon; Skip intro on a
platform where the intro plays (it could not be observed on macOS); controllers;
local multiplayer and online co-op. - Controllers are not supported for Refund movement focus or One-press
inventory. - Windows and Linux/Proton gameplay is unverified. Windows launcher availability
remains a preview; Linux arm64 is helper tooling, not a native ARM game port.
macOS downloads are not notarized and may require right-click > Open. Steam may
need one restart to refresh shortcut artwork.
The verified game assembly remains
94cab5f9be9633f7f85f6f072e0b5b919c605bbecb3414422f8f008d9b2bc1c8.
See the Tweaks guide
for implementation details.