19 KiB
Quin2k's Cheat Framework Rework
Install Instructions
- Put the CheatFramework folder into LonaRPG\ModScripts_Mods. (e.g. LonaRPG\ModScripts_Mods\CheatFramework_init_.rb)
- Once in place, open the MODS menu from within LonaRPG (right above EXIT).
- Press action key (Z) to activate mods, left/right to change their order.
- The one that loads last 'wins'
- When using a new mod or bringing mods to a new version of LonaRPG, it is good practice to activate only a few at a time.
- Once you've made your changes, move to the top and select "Restart to Apply" (or Accept and just restart manually)
Requirements
Lowest game version tested: 0.10.0.2
Highest game version tested: 0.10.8.12
Hotkeys
These should populate in the config when you load the mod for the first time. If you want to disable any of these, go to Config > View/Clear Hotkeys. Any command or toggle can be assigned a hotkey by pressing C to edit, a key or combo, then C again to save.
Key combos can include Shift/Ctrl/Alt. Usable keys are any unused F-key, letter (T, Y, U, I, O, P, G, H, J, K, L, V, B, N, M), digit (1, 2, 3, 4, 5, 6, 7, 8, 9, 0), or symbol ; = , - . / [ \ ] ' that is not otherwise assigned in a known Mod or the Keyboard Key Bindings Menu. If there is a conflict, the shortcut key will not update. .
The Cheat Menu still defaults to F9. You can change this in the hotkeys.ini, the Key Bindings Menu or in Config > View/Clear Hotkeys in the cheat menu. Can't get into the cheat menu? It is also mapped to the Settings Menu (the save/load screen).
Default Hotkeys
- MENU.Main Menu = F9
- MISC.Remove Clothes = F3
- MISC.Force Remove Clothes = Shift+F3
- MISC.Bank Anywhere = F2
- TOGGLES.Infinite Health = F4
- TOGGLES.Infinite Stamina = F4
- TOGGLES.Infinite Food = F4
- ROLEPLAY.Infinite Mana = F4 (RolePlay-S mod only)
Conflict Resolution: If the RolePlay-S mod is active, quick-save/load will override any hotkeys assigned to F5/F6. Similarly, if you reassign Cheat Menu's hotkey, any overlapping hotkeys will be unbound.
Menu Structure
- Misc. Cheats
- Heal
- Heal a Wound
- Exhausted
- Give Money
- Remove Clothes [F3]
- Force Unequip [Shift+F3]
- Open Bank Inventory [F2]
- Toggles
- Infinite Health/Stamina/Food/Money
- Disable Dirt
- Auto-Bandage
- Auto-Clean
- Auto-Cure
- Unlock Gallery
- Lona Vulnerable
- Summon
- Arena Submenu
- Auto-populated
- Character
- Primary Stats
- Health Edit
- Stamina/Food Edits
- Mood Edit
- Dirt Edit
- Arousal/Morality Edits
- Levels & Traits
- Max Levels
- Current Level
- Traits per Level
- Set Max Traits
- Set current Trait Points
- Traits
- Edit Combat/Scoutcraft/Wisdom/Survival/Constitution
- Reset Traits (points allocated to skills, etc.)
- Set Race
- Set Lona's Race
- Race Cheats
- ---Deepone---
- Deepone Can Communicate
- Deepone Summon Max
- Enable Awaken skill
- ---Abomination---
- Abomination Eat Fix
- Enable Desecrate/Tendril Whip skills
- Pregnancy
- Preg Difficulty / Womb Seedbed (Impacts pregnancy length)
- Protect Pregnancy (Infinite Baby Health)
- Impregnate Lona (Submenu, force specific race)
- Appearance
- Hair Color
- Freckles
- Pubic Hair
- Sexual
- Vaginal/Urethra/Anal Damage Edit
- Vaginal/Urethra/Anal Damage Toggle
- Reset Sex Stats (Virginize)
- Primary Stats
- Game Tweaks
- Night Vision
- Noclip
- Equip Anything
- Fast Nap
- Prevent Discard
- From The Shadows Fix
- Difficulty Achievement Fix
- NPC Tweaks
- Friendly Fire Fix
- Endless Contracts
- Prevent Death
- Irresistible
- Beast Fix
- Companion Rape
- Revive Unique NPCs Submenu
- Difficulty
- Edit World Difficulty
- Item Decay Control
- Increased Drops
- Addiction Effects (Off/Hard/Hell)
- Milk Overflow (Off/Hard/Hell)
- Preg Difficulty (same setting as under Character > Pregnancy)
- Reset Game Difficulty (Doom Mode only)
- Items/Weapons/Armors/Status
- Auto-populated
- Other Mods
- RolePlay-S (if installed)
- Infinite MP
- Edit Mana Rage Max
- Edit Mana Rage
- Disable Save Limiter
- Lona Belly & Booba (if installed)
- Booba Cosmetic Mode
- Old Nipples
- Filter Visuals (if installed)
- White Cum
- Recolored Events
- Filter Nipple Melanin
- Filter Pubic Hair
- Filter Dirt
- Filter Wounds
- Filter Bleeding
- RolePlay-S (if installed)
- Config
- View/Clear Hotkeys
- Edit Menu Order
- Edit Globals
- Reset Config Settings
Known Issues
- Currently in need of proper translation for default languages. I didn't want to publish something I couldn't test, so I did not include custom languages from the original.
- Any native speakers should contact me ASAP with fixes!
- Should be loaded after RolePlay-S. It's minor - local-turned-global variables won't write until you save-and-load the first time.
Planned Improvements
- Identify global variables that should be able to act as local.
Changelog
Ver 0.9.0q Changelog
This started out as "I'd like to be able to edit variables" and when I realized the last editor for the Cheat Mod didn't seem active anymore, I decided to try my hand at it. Since then, I've done the following:
- Completely refactored Init, Config, Menu. Added library resources to Utils file to simplify loading.
- Created a 'default' UI that can handle commands, toggles, editing numbers and lists, and even nested menus.
- Added the ability to dynamically created menus and structures for the menu without preventing the old format.
- Also added a way to register hotkeys as part of the command creation process.
- Set up default sections for toggles and miscellaneous commands.
- Added ways to simplify and streamline command creation/mapping so that a few tags can create most commands.
- Incorporated dynamic hotkey generation into the command mapping system.
- Developed a variables interface to directly edit various stats for Lona (Health, Stamina, Food, Mood, Arousal, Levels, Traits, etc.)
- Incorporated Morality and Hair Color into the menu. Added World Difficulty for good measure.
- Drew inspiration from code on the Wiki (Author Unknown) for Max Level Increase, Max Stat Increase, and Traits per Level mods.
- Added recalculation functions for traits and a way to rest all traits easily (effectively reroll your character).
- Revamped Pregnancy module:
- Improved code for pregnancy duration edit.
- Added a way to edit baby health and lock it to max.
- Added special difficulty setter that would only influence pregnancy (for longer/shorter lengths)
- Put a convenient Womb Seedbed setter in the page and improved UI.
- Created a sub-menu called Character to house Levels, Traits, Primary, Pregnancy, Appearance and Race editors.
- Added toggling of Race Skills to Race Edit menu (can of course also unlock them legitimately!)
- Imported Stat (I'm calling it Status), Item, Weapon, and Armor editors.
- Developed a CG Unlock Toggle that doesn't edit achievements (watching the scenes could possibly add them).
- Merged Infinite Stats, Infinite Money and Dirt toggles along with legacy commands that aren't redundant from changes above.
- Tried to incorporate features to reduce lag issues mentioned in previous version.
- Updated Auto-Bandage and Auto-Clean splitting it for internal (cum tanks) and external and added a new Auto-Cure (STDs, parasites).
- Implemented unequip and force unequip hotkeys, also adding Force Unequip as a menu item just in case.
- Added the various 'fixes' and made them toggleable - this should allow users to disable ones that are causing crashes.
- NOTE: ALL OF THESE TOGGLES REQUIRE RESTART BEFORE THEY WILL ENABLE/DISABLE.
- Fixed issues with StripOnlyUnequips (now "Prevent Discard")
- Imported Abomination Desicrate skill fix which makes eating corpses heal wounds and sate hunger.
- Included toggleable fixes for difficulty-based achievements and a fix to "Into the Darkness" stealth.
- Improved on the Friendly Fire code to completely prevent damage/aggro between player and followers.
Ver 0.9.1q Changelog
- Minor change to config file structure before initial release (split global/hotkeys/modules to separate ini files fixed quotes being added to hotkeys.)
Ver 0.9.2q Changelog
- Fixed some issues with Friendly Fire Fix not recognizing summons (e.g. Cocona undead) as allies.
- Fixed issue where editing pregnancy wasn't updating Lona's belly until the next day.
- Found and fixed an issue with Traits Per Level global not loading properly. If you have issues, delete that line or capitalize "Per"
- Determined the low-lag features were voiding the whole point of max hp/sat/sta (wasn't preventing death!!) so sped up the check frequency.
- Main menu is now prioritized over other commands and doesn't check for Ctrl/Shift/Alt. Keep that in mind if customizing hot keys.
- Moved the "fixes" to their own menu named "Game Tweaks"
- Moved Prevent Discard to that section.
- Added some features inspired by doujinftw in F95zone
- Option to edit mob drop quantity.
- Option to adjust/remove dropped item decay.
- Option to disable equipment restrictions (MagicEQ, HighQuEQ, SaintEQ) no matter what traits you have.
- I wanted to do "learn any skill" but this is more future-proof.
- Added a menu in the Game Tweaks to revive unique NPCs. Inspired by one of kastrom's mods on raidgame.ru.
- Included some rebirth traits in "Appearance" menu including freckles, pubic/anal hair, and pube growth rates (if active).
- Tried to improve language support. If you would like to contribute, go to Google Docs Translation.
- Russian updated courtesy of Sadorimatsu at F95zone.to / raidgame.ru
- If you aren't comfortable accessing via Google Docs, DM me and I'll send an excel version.
Ver 0.9.3q Changelog
- Fixed a typo in Protect Pregnancy code that prevented Baby Health updates.
- Added a command to access the bank from anywhere. For those who have hoarding issues.
- Set it to F2 as a shortcut.
- Finally ported over Summon interface from the original mod. Merged some sections.
- It should work exactly the same, BUGS AND ALL, so use with caution!
- Moved Revive, Summon, World Difficulty, and Bank to new "NPC" Submenu.
- Revive menu will now display non-dead NPCs as grayed out (so the menu isn't blank)
- Added a "Sexual" menu under "Character"
- Adds number editing and toggles for Vag/Urethra/Anal Damage
- Has a command to reset all sex stats - essentially restoring virginity.
- Added option to "Reset Game Difficulty" to the Misc Cheats Menu.
- Basically force-disables Doom Mode. Only visible in Doom Mode.
- Use with caution, can delete your Doom Save. When testing, entering the game menu before running the cheat seemed to preserve it - but no promises.
Ver 0.9.4q Changelog
- RolePlay-S Compatability update!
- Disabled cheats for Max Level (redundant) and Traits Per Level (conflict) if RolePlay-S mod enabled.
- Disabled font overrides for cheat menu. Could still force it by removing the default font.
- Added a new RolePlay-S Menu for mod-specific cheats:
- Unlimited Saves: Cheat will prevent counting saves, and will reset save count upon load (for games saved before cheat enabled).
- Infinite MP: Functions similar to infinite HP/Sta/etc.
- Tied to F5 toggle too.
- Mana Rage & Mana Rage Max: Allows you to edit variables.
- Rage increases 1:1 for every MP used and if maxed you die.
- Probably only necessary to edit with Infinite MP active.
- Moved Friendly Fire to NPC Category
- Added a cheat to edit max summonable Sirens for Deepone to NPC Category.
- Changed UKR to MTL from Russian instead of English. Figured it'd be more accurate.
Ver 0.9.5q Changelog
- Minor corrections to fonts (missed some menus impacted by the RolePlayS mod).
- Code fix for Friendly Fire courtesy of Archangel Dejavu at RaidGame.ru
- Identified and hopefully fixed file loading issues for some non-english characters.
- Started utilizing mod loader to read files vs. attempting to do it directly.
Ver 1.0q Changelog
- Having finally done the to-do-list left by the original author, I think this deserves a 1.0.
- Added a in-menu way to access the Cheat Menu (same page as Load/Save).
- Added a way to set/clear hotkeys directly (Only works w/ Commands and Toggles)
- Added the ability to set hotkeys in-game with C, (key), C.
- Includes conflict resolution, preventing/clearing hotkeys that conflict.
- Implemented Config Menu with the following features:
- View Hotkeys
- Ability to edit Cheat Menu hotkey in-game (F2, F3, F4, F7, F8, F9, F11)
- Ability to view/clear existing hotkey bindings.
- Edit Menu Order
- Ability to customize all menus (including the config menu, globals menu).
- Edit Globals
- Ability to force some local variables to act as global variables (across saves)
- Ability to force select global variables to act as local variables
- (let me know if I should add more).
- Ability to set these variables in a centralized area.
- Reset Config Settings
- Returns config settings (order, hotkeys, etc.) back to default.
- View Hotkeys
Ver 1.1q Changelog
- Moved ini files to mod folder (heard that has less conflicts for JoiPlay).
- Effectively 'refreshes' ini files, solving conflicts with hotkey changes.
- Added an 'alert' to inform if a cheat may not be working until restart.
- Added "Deepone Can Communicate" fix toggle inspired by Lona Can Communicate.
- Added "Night Vision" cheat. Let me know if you want a toned-down version.
- Added "Endless Contracts" cheat to prevent auto-dismisal of companions.
- Added "Fast Nap" cheat similar to the stand-alone mod or what is in RolePlay-S.
- Fixed "Force Remove" cheat to not remove hair (still removes chains/bondage).
- Reworked fixes that require restart to be more clear about their function. Added a way to 'disable' these for future proofing (the reason I took up this mod was crashes related to one of these fixes).
- Fixed long load times for Items/Armors/Weapons/States menus.
- Fixed (?) and mererged Auto-Clean toggle.
- Moved some menu items around.
- Removed call to save keys that was causing JoiPlay to crash.
- Added untranslated text (lambda) support to main menus registration.
- Added visual cues to cheat menus when there are off-screen options.
- Several fixes for "Deepone Can Communicate" from 1.1.1-4.
Ver 1.2q Changelog
- "Equip Anything" now also bypasses True Deepone's weapon/armor locks.
- Added "Exp Rate" cheat (x1/x2/x4/x8) to Levels & Traits.
- Should be compatible with RoleplayS.
- Added "Noclip" cheat. Walk through terrain, walls, and NPCs - also freezes overworld changes.
- Added "Forage Glow" cheat that will highlight spawned items in the wild.
- Added Difficulty-related 'features' similar to Pregnency Difficulty:
- Added "Addiction Effects" cheat (Off/Hard/Hell) to unlock (or lock) Ograsm/Semen/Drug addiction overevents.
- Added "Milk Overflow" cheat (Off/Hard/Hell) to unlock (or lock) milk overflow/splash overevent.
- Added some additional Companion Cheats
- "Prevent Death" - Locks Companion and Lona HP to >1. Companions will not fall below 0 stamina.
- "Irresistible" - Crawling Companions and Lona now bypass other agro checks, favoring "fucker" interactions.
- Improved on Summon Menu
- Added support for Arena summons.
- Filtered some crash-inducing summons.
- Filtered out the babies.
- Added some 'lost' NPCs.
- Rearranged menus
- See above for in-depth details.
- Moved Summon to it's own menu.
- Added a "Race Cheats" to Character menu (houses deepone/abomination cheats/skills).
- Added a "Difficulty" menu for difficulty-related cheats (both good and bad).
- Added code fixes needed for 0.10.8.05+
- Added fix for issue where F9 hotkey was not being set by default
Ver 1.3q Changelog
- Added "Other Mods" menu for cross-mod support - thanks to thatguy88 for the original idea.
- Lona Belly & Booba: toggle Cosmetic Mode and Old Nipples can be edited directly.
- Filter Visuals: Toggle all 7 filters (White Cum, Recolored Events, Nipple Melanin, Pubic Hair, Dirt, Wounds, Bleeding).
- White Cum and Recolored Events require a restart due to their nature.
- All of these write straight to that mod's own config, so the change sticks even if you disable CheatFramework.
- Only shows up if you actually have one of those mods installed.
- Added support for a new mod I'm working on (LonaRecolored) to leverage CheatFramework's menus.
- Too lazy to integrate that mod into the shops, so CheatFramework will likely be a dependency.
- Added support for per-choice help text, mostly in support of this mod.
- Moved RolePlay-S cheats into the Other Mods menu (Infinite MP, Mana Rage, Mana Rage Max, Disable Save Limiter).
- RESTART tag is now smarter and realizes if you changed your mind.
- Difficulty: fixed Despawn Fix's restart tag and its event-matching logic.
- Fixed issue with custom hotkeys being unbound on the next restart instead of saving.
- Added a fix to Infinite Stamina it'll disable when Lona is giving birth to prevent a softlock.
- Added "Lona Vulnerable" toggle. Caps her stamina at 0 releases when she collapses.
- Added "Beast Fix" and "Companion Rape" to NPC Tweaks.
- Beast Fix corrects the "Others" alignment issue and simultaneously unlocks some additional beasts
- Warning: Beast Fix changes Horse Carry and Doggy preferences (were locked).
- Idea credit: thatdude64.
- Companion Rape lets companions evaluate Lona as a target (based on existing preferences).
- Best paired with "Irresistable", "Infinite Stamina" and "Lona Vulnerable" for endless fun.
- Beast Fix corrects the "Others" alignment issue and simultaneously unlocks some additional beasts
Ver 1.3.1q Changelog
- Tied the health refill for Prevent Death / Infinite Health to the code that handles hits instead of per tick.
- Fixed crash for Companion Rape on older versions. Thank you zerk0000 for pointing out these issues.
- Fixed an error with CompDoggy not having any grapple moves (not just art was sabotaged).
Credits
See the credits file for details.
Note from Quin2k: I freely give permission to improve on and use any of my contributions to the code as long as you respect / retain the credits of the original authors. That includes previous authors taking up the project again.
