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,32 @@
# CheatFramework — интеграция LonaCraft и Booba
## Предметы
F9 → «Предметы LonaCraft»: материалы/постройки, мебель, инструменты,
качественные виды оружия и брони (`_LC2`–`_LC5`).
Стандартные списки предметов, оружия и брони также показывают их.
Для добавления/удаления используются стрелки, Shift ×10, Ctrl ×99.
Каталог формируется при открытии меню по актуальной базе данных,
а не по порядку подключения модов.
## Уровни
F9 → «Персонаж» → «Уровни»: изменение числом, +1, -1, максимум, сброс до 1,
множитель опыта и очки черт. Без RolePlay-S используется регулируемый
предел до 999, включая сборку с RemoveLevelCap.
## Совместимость с другими модами
Меню включения и отключения модов **отсутствует**. Установленные
моды продолжают автоматически загружаться как раньше; отдельная настройка
`disabled_mods.txt` больше не читается. Порядок загрузки сохранён:
Booba и RolePlay-S перед LonaCraft, чтобы дополнения предметов применялись.
«Косметический режим Booba» использует штатный `BoobaMod.toggle`,
который сохраняет конфиг и обновляет портрет/онлайн-настройку.
Устаревший переключатель «Старые соски» удалён: в текущей
сборке Booba такого режима нет.
Для сетевого режима нужны совместимые моды и разрешения.
Синтаксическая проверка Ruby не заменяет теста непосредственно в игре.
@@ -0,0 +1,50 @@
# Credits
## Code
- [Claude Code](https://claude.com/claude-code) \(assisted with code, mostly to brainstorm/implement the config menu which continued to confound me. Also helped with debugging and research. All contributions were thoroughly reviewed.\)
- [Archangel Dejavu](https://raidgame.ru/members/8694/) \(for fixes to the Friendly Fire code.\)
- [kenny567](https://f95zone.to/members/240807/) / [k3nny567](https://github.com/K3nny567) \(for editing/publishing/maintaining/distributing the latest version of the cheat mod as late as May 2025. (https://f95zone.to/posts/9588500)\)
- [darkprizm](https://f95zone.to/members/947058/) \(for the [original Cheats mod](https://f95zone.to/posts/5127580/)\)
- [SomeoneElseE](https://f95zone.to/members/306444/) \(for the [updated version of the Cheats mod](https://f95zone.to/posts/5509166/)\)
- [Tektaara](https://f95zone.to/members/3481219/) \(for the [dependency](https://f95zone.to/posts/8970645/) and the [summon fix]\) (<https://f95zone.to/posts/8977473/>)
- [forgotp](https://f95zone.to/members/1762692/) (for [being a central point to find the Cheats mod, dependency and the summon fix](https://f95zone.to/posts/9137109/))
- [Teravisor](https://f95zone.to/members/1966376/) (for the [code to toggle the Dirty stat](https://f95zone.to/posts/4250195/), [NoFriendlyFire mod](https://f95zone.to/posts/5007421/), and the [Summon Menu mod](https://f95zone.to/posts/4164791/) that the original Cheats mod was based on)
- DocNITE (for the code that was previously used in the translation support)
- Galenmereth / Tor Damian for the Plugin Framework
- And most importantly, Yanfly for the code that was previously used in the old Cheats Mod dependency file, and the remaining portions that still exist in the `Inventory Editor CheatModule`
## Inspiration
- [Braunray42](https://f95zone.to/members/braunray42.11194152/) \(Suggestion for EXP multiplier and Equip Anything to bypass race-specific restrictions.\)
- [Petaduo](https://f95zone.to/members/petaduo.3814433/) \(Suggestion to incorporate [Lona CAN Communicate Mod](https://raidgame.ru/mods/628/) as a cheat.\)
- [Lazi Ness](https://raidgame.ru/members/5664/) \(Mana Rage from [RolePlay-S](https://raidgame.ru/mods/565/) effectively gave night vision, which got me thinking...\)
- [Shadesishere](https://f95zone.to/members/shadesishere.3139110/) \(mod for monastery donation inspired world difficulty edit.\)
- [doujinftw](https://f95zone.to/members/doujinftw.3105652/) \(difficulty reset, item drop rate, equipment bypass and, indirectly, item despawn rate.\)
- [kastrom](https://vk.com/kactpom) \(their undead unique mod seemed limiting (e.g. Adam quest issues), so tried to improve on it.\)
- [thatdude64](https://f95zone.to/members/thatdude64.10884557/) \(inspired the Beast Fix cheat.\)
## Translations
- Russian language fixes courtesy of [Sado Yasashi](https://f95zone.to/members/sado-yasashi.7065366/) / [Sadorimatsu](https://raidgame.ru/members/1/)
- Google Translate (Please send me something better if you don't like it!)
## Notes
>
> [!WARNING]
> Credit where credit is due, removal of this file is forbidden.
@@ -0,0 +1,121 @@
Creative Commons Legal Code
CC0 1.0 Universal
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.
Statement of Purpose
The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").
Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.
For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.
1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:
i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.
2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.
3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.
4. Limitations and Disclaimers.
a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.
@@ -0,0 +1,431 @@
# Cheat Framework: Module Guide
This explains how to add a cheat to the Cheat Framework, written for someone who isn't necessarily
comfortable with Ruby or programming yet. It focuses on "what do I write, and what does it do" rather
than how the framework is built internally.
The best example file to read alongside this guide is
[`modules/Pregnancy.rb`](../modules/Pregnancy.rb) — nearly everything below shows up somewhere in it.
A few words you'll see a lot:
- **Module** — one `.rb` file, containing one or more related cheats.
- **`$something`** — a "global variable." Any file can read or change it. Most cheats store their
on/off state or number in one of these.
- **Symbol** (`:toggle`, `:my_key`) — just a label Ruby uses internally. You don't need to understand
why it's written that way, just copy the pattern shown in examples.
- **Monkey-patch** — changing how an existing piece of the game behaves, instead of adding something
new. Covered in §7.
---
## 1. How a module gets loaded
Drop a `.rb` file anywhere under `modules/`. The framework finds it automatically at startup — you
never have to register the file itself anywhere. It reads a small header at the top of your file (see
§2), then runs your file's code once, top to bottom, like any Ruby script.
## 2. Your module's header (optional, but recommended)
```ruby
FrameworkModule = {
name: "Pregnancy", # Just a label, shown in a couple of places
key: :pregnancy, # A short, unique name for your module (no spaces)
menu: :PREGNANCY, # Which menu group your commands land in by default
depends_on: [], # Other modules' :key values that must load before yours (usually empty)
}
```
If you skip this, the framework guesses reasonable defaults from your filename. Fine for a very small
file that only patches existing game behavior and doesn't add its own menu entries.
## 3. Adding a cheat to the menu
Every cheat — a toggle, an editable number, a button — is one `register_command` call:
```ruby
module MenuFramework
module SUBMENU
register_command(
group: :PREGNANCY,
type: :toggle,
key: "Protect Pregnancy",
label: "modules/pregnancy:commands/protect",
state: "$cheat_protect_pregnancy",
gdef: false,
)
end
end
```
- **`group:`** — which existing menu screen this shows up in (`:MISC`, `:TOGGLES`, `:LONA` are common
ones already used elsewhere — reuse one rather than inventing your own unless you're building a
whole new screen, see §4).
- **`type:`** — what kind of row this is. See the table below.
- **`key:`** — a name for this specific command. Must be unique within its `group:`.
- **`label:`** — the text shown to the player. This is a *text key*, not the literal words — see §9.
- **`state:`** — a piece of Ruby, written as **text** (in quotes), that reads the cheat's current value.
Almost always just a `$variable` name.
- **`gdef:`** — the default value, and a signal to the framework "please remember this setting between
play sessions for me." See §5.
## 4. Command types (`type:`)
| type | What it is | You must also provide | Example use |
|---|---|---|---|
| `:toggle` | A simple on/off switch | `state:` | "Infinite Health" |
| `:edit_num` | A number the player can raise/lower | `state:`, `min:`, `max:` | "Max Level" |
| `:edit_list` | Cycles through a fixed set of choices | `state:`, `list:` | "Drop Rate: x1/x2/x4" |
| `:action` | A button that just runs some code once | `action:` | "Heal Fully" |
| `:info` | Read-only text, nothing to press | `state:` | Shows a calculated value |
| `:scene` | Opens a whole new screen | `name:`, `dict:` | See §4a |
### `:toggle` example
```ruby
register_command(
group: :PREGNANCY,
type: :toggle,
key: "Protect Pregnancy",
label: "modules/pregnancy:commands/protect",
state: "$cheat_protect_pregnancy",
gdef: false,
)
```
### `:edit_num` example
```ruby
register_command(
group: :PREGNANCY,
type: :edit_num,
key: "Seedbed",
label: "modules/pregnancy:commands/seedbed",
state: "$game_player.actor.stat['WombSeedBed']",
min: 0,
max: 10,
action: ->(v) { FrameworkUtils.custom_state_edit("WombSeedBed", v) },
)
```
Left/Right in-game raises or lowers the number. `action:` here is a small piece of code that actually
applies the new value `v` to the game — needed because this cheat edits something that's already part
of the save file, not a setting the framework can just remember for you (more on that distinction in §5).
### `:edit_list` example
```ruby
register_command(
group: :PREGNANCY,
type: :edit_list,
key: "Pregnancy Difficulty",
label: "modules/pregnancy:commands/difficulty",
state: "$cheat_pregnancy_difficulty",
gdef: -1,
list: [
{ key: -1, label: "[#{$framework.txt("menu:cheat_toggle/off")}]" },
{ key: 0, label: "[#{$framework.txt("menu:commands/diff_hard")}]" },
{ key: 1, label: "[#{$framework.txt("menu:commands/diff_hell")}]" },
],
)
```
Each entry in `list:` is one choice: `key:` is the actual value stored, `label:` is what's displayed.
Unlike the top-level `label:`, each list entry's `label:` must already be the *finished, translated
text* — call `$framework.txt(...)` yourself, as shown, rather than passing a bare text key.
### `:action` example
```ruby
register_command(
group: :IMPREGNATE,
type: :action,
key: "Clear",
label: "modules/pregnancy:commands/clear",
action: -> { $game_player.actor.cleanup_after_birth },
)
```
Pressing this just runs the code in `action:` once. Nothing to remember, nothing to persist.
### `:info` example
```ruby
register_command(
group: :PREGNANCY,
type: :info,
key: "BabyRace",
label: "modules/pregnancy:info/babyRace",
state: "$game_player.actor.baby_race",
hide: -> { $game_player.actor.preg_level == 0 },
)
```
Just displays whatever `state:` currently is. `hide:` (see §6) is often paired with `:info` rows to
only show them when they're relevant.
## 4a. Adding a whole new screen
If your cheat needs its own dedicated page (like Pregnancy's own menu), register one `:scene` command
that opens into a new group, then register your real commands *into* that group:
```ruby
register_command(
group: :LONA, # the screen this link itself appears on
type: :scene,
key: :pregnancy,
label: "modules/pregnancy:commands/preg",
name: "CheatMenuPregnancy", # the framework builds a screen named after this automatically
dict: :PREGNANCY, # your new group - use this as group: on the commands that belong here
)
```
You don't need to build the screen by hand — the framework generates it the first time it sees that
`name:`. That's enough for the vast majority of cheats. Building a fully custom, hand-drawn screen is
possible but a much bigger topic — look at `Controls.rb` or `InvEdit.rb` for examples if you need it,
or ask someone familiar with the framework for help.
## 4b. Adding your own row to the *Main Menu* (root screen)
§4a's `group:` puts your new screen's link *inside* an existing category, like `:LONA`. If instead you
want your module to show up as its own row on the root screen — the one the player sees when pressing
the Main Menu key, alongside "Miscellaneous," "Toggles," "Character," and "NPC Options" — register with
`MenuFramework::MENU` instead of `MenuFramework::SUBMENU`:
```ruby
module MenuFramework
module MENU
register_command(
type: :scene,
label: "modules/mymodule:commands/root",
name: "CheatMenuMyModule",
order: 40,
)
end
end
```
If your `FrameworkModule` header (§2) already sets `menu:`, that value becomes this new screen's group
automatically — you don't need to pass `dict:` yourself, and any `MenuFramework::SUBMENU.register_command`
calls in the same file don't need `group:` either, for the same reason. `modules/Fixes.rb` is a small,
complete example of this: one `MENU` entry ("Game Fixes") holding several plain `SUBMENU` toggles, none of
which mention `group:` because the header's `menu: :FIXES` already ties them together.
Everything else about the `:scene` command (`type:`, `label:`, `name:`) works exactly like §4a. The only
difference is *where* the link to your new screen appears: `MENU` puts it on the root screen, `SUBMENU`
(with a `group:`) tucks it inside whichever existing category you choose instead.
## 5. Making your cheat remember its setting (`gdef:` + `state:`)
Pass both `gdef:` (a default value) and a `state:` that's a plain `"$variable"` name, and the framework
handles saving/loading for you automatically:
- When the game starts, it reads your cheat's last saved value (or uses your `gdef:` default the very
first time) and puts it into the variable.
- When the player changes it, the framework saves the new value for next time — you don't need to
write any extra code for this, as long as you didn't supply your own `action:`.
**When *not* to use `gdef:`:** if your cheat edits something that's already part of the save file
itself — health, level, an NPC's story flag — don't use `gdef:` at all. That kind of value is already
being saved by the normal game, and needs its own `action:` that actually changes the game object
(see the `:edit_num` example above). `gdef:` is only for a cheat's *own settings*, not for game data
that already exists.
## 6. Showing, hiding, and coloring rows
- **`hide:`** (`true`/`false`, or `-> { }` for a live check) — removes the row from the list entirely.
Use this when a row makes no sense right now (a pregnancy-only field while not pregnant).
- **`enable:`** (default `true`) — keeps the row visible, but grays it out and marks it "Cheat Active"
when `false`. Use this for "this is temporarily blocked by another setting," rather than hiding it.
- **`color:`** — a number that picks a text color, or a `-> { }` that returns one. `16` is commonly
used to highlight "this is the currently active choice"; `8` for a dimmed/informational row.
## 7. Changing how the game itself behaves
Everything so far adds a *new* row to a menu. Sometimes you want to change something the game
*already* does — for example, "block friendly fire" or "let True Deepone talk to NPCs normally."
That's done by replacing one of the game's own methods with your own version, a technique usually
called **monkey-patching**.
The key trick: keep a copy of the original under a new name first, so you can still fall back to it:
```ruby
if $cheat_my_fix >= 0 # only bother at all if the cheat isn't fully disabled
class Game_Actor # reopen whatever class already defines the thing you want to change
alias_method :my_fix_original_heal, :heal_wound # keep a working copy of the original, under a new name
def heal_wound # replace it with your own version
return my_fix_original_heal unless $cheat_my_fix == 1 # only actually change anything if the toggle is on
# ... do your own thing here ...
end
end
end
```
A few things worth understanding line by line:
- `class Game_Actor` doesn't create a new class — since `Game_Actor` already exists in the game, this
*reopens* it, letting you add or replace methods on it. This works for any class in the game.
- `alias_method :new_name, :old_name` copies the method currently called `old_name` and gives that copy
a second name (`new_name`). After this line, both names point at the *same, original* behavior.
- The `def heal_wound` right after it then replaces `heal_wound` with your version. Since you already
saved a copy under a different name, you can still call the original whenever you want (as shown:
falling back to it when the cheat is off).
- Wrapping the whole thing in `if $cheat_my_fix >= 0` means: don't even attempt any of this unless the
cheat has been turned on. If your cheat has ever been fully "Disabled," none of this code runs at
all — which matters if the game ever updates and changes how `heal_wound` works, since your patch
never touching it at all is the safest possible outcome.
- Checking `$cheat_my_fix == 1` *inside* the replaced method (rather than only in the outer `if`) is
what lets the player flip the cheat on and off during play without restarting — see §8.
Always alias to a name that's unique to your cheat (like `my_fix_original_heal`, not just `original`)
so two different modules changing the same method don't collide with each other.
**If you're only adding something new** (a brand-new method the game doesn't already have), you don't
need `alias_method` at all — there's nothing to fall back to. Just reopen the class and write your
method directly, the same way §7's `class Game_Actor` line reopens one.
### 7a. Running code every tick
Some cheats aren't triggered by the player pressing anything — they need to check something
continuously (an aura effect, a passive drain). Reopen `CheatFramework` itself and alias its
`hotkey_trigger` method, which the framework already calls once per frame:
```ruby
class CheatFramework
alias_method :my_fix_hotkey_trigger, :hotkey_trigger
def hotkey_trigger
my_fix_hotkey_trigger
# ... your own per-tick check here ...
end
end
```
Same pattern as §7 — keep a copy of the original under a new name, then call it alongside your own
code, so every other module's tick logic keeps running too.
### 7b. Checking if another mod is enabled
If your patch would conflict with a specific other mod, gate it out when that mod is enabled:
```ruby
if $mod_manager.mods['SomeOtherMod'] && !$mod_manager.mods['SomeOtherMod'].enabled
# ... your patch here ...
end
```
Pair this with `hide: -> { $framework.some_other_mod_enabled? }` (or an equivalent check) on the
`register_command` itself, so the row disappears entirely rather than sitting there doing nothing.
## 8. Restart behavior (`restart:`)
Some cheats can only take effect the moment the game starts (the monkey-patching in §7 can only run
once, when your file first loads) — so if a player turns one on for the first time, nothing will
actually happen until they restart. Left unmarked, that's confusing: the player sees their setting
saved as "On" but nothing changed.
If your cheat has this restart requirement, add `restart:` with the number your `list:` uses to mean
"fully off/disabled" (commonly `-1` or `0` — whatever you picked). For a plain `:toggle` with no such
number, use `restart: true` instead.
```ruby
register_command(
...
state: "$cheat_my_fix",
gdef: -1,
restart: -1, # -1 is this cheat's own "Disabled" value
)
```
With this set, the framework automatically compares "what's picked right now" against "what was
actually running when the game booted," and shows a small `[RESTART]` tag next to the row whenever
they disagree — for example, if the player just flipped it on but hasn't restarted since, or just
flipped it off but the old behavior is technically still active this session. You don't need to write
any of that comparison yourself — just tell it which value means "off."
If your cheat's live behavior is fully controlled by checking `$cheat_my_fix` *inside* the patched
method every time (like the `== 1` check in the §7 example), you generally don't need `restart:` at
all beyond marking the "off" value — the on/off switching itself is already live.
### 8a. Local/Global overrides (`global:`)
This is a separate feature from `gdef:` — it lets the player force a specific value for your cheat
from the Config > Edit Globals screen, independent of what's normally selected. Pass `global: true` or
`global: false` (whichever fits your cheat) to make it eligible:
```ruby
register_command(
...
gdef: false,
global: false, # opts this cheat into the Edit Globals screen
)
```
Most cheats don't need this — it's for settings a player might want to force on/off globally across
every save file regardless of that save's own setting. If you're not sure whether your cheat needs it,
it probably doesn't; just leave `global:` out entirely.
### 8b. Menu order (`order:`)
```ruby
register_command(
...
order: 40,
)
```
A plain number controlling where your row sits in its `group:`, lowest first. Players can also
reorder rows themselves from the in-game Edit Menu Order screen, so treat your number as a starting
default, not a guarantee.
## 9. Hotkeys
```ruby
hotkey: { key: "F4" }
hotkey: { key: "Shift+F4", sound: :sound_WaterSpla }
```
Add this to any command. Players can also assign or change hotkeys themselves from the in-game menu,
so this is just a starting default. `sound:` is optional (a small sound effect on press).
## 10. Text and translations
Any `label:`/`help1:`/`help2:` (and, less commonly, `help3:`/`help4:` for extra help lines) you pass
as a plain string (not starting with `->`) is a *text key*, not the literal words shown to the player.
It points at an entry in a text file:
- `"modules/pregnancy:commands/preg"` → the file `text/ENG/modules/pregnancy.txt`, entry `commands/preg`
- `"menu:commands/misc"` → the file `text/ENG/menu.txt`, entry `commands/misc`
Text files are simple: a key, then the text for it, then a blank line, repeated:
```
commands/preg
Pregnancy
commands/difficulty
Pregnancy Difficulty
```
Add your new keys under `text/ENG/modules/<yourfile>.txt`. That's the one language folder you should
edit yourself — leave the other language folders alone, since those are typically translated
separately by someone else.
## 11. Checklist for a new module
1. Create `modules/YourModule.rb`.
2. Add a `FrameworkModule` header (§2) — optional for something tiny.
3. Decide: are you adding rows to an existing menu, a whole new screen linked from one (§4a), or your
own row on the root Main Menu (§4b)?
4. Register your command(s) using the type table in §4.
5. If it's a cheat *setting* (not existing game data), add `gdef:` + a plain `$variable` `state:` and
skip `action:` — persistence is automatic (§5).
6. If it edits existing game/actor data, write your own `action:` instead.
7. If your cheat changes existing game behavior rather than just adding a menu row, see §7 for how to
do that safely, and §8 if it needs a restart to take effect.
8. Add text keys under `text/ENG/modules/yourmodule.txt` (§10).
9. Test with your cheat both on and off, including turning it on/off without restarting, to make sure
the behavior (and any `[RESTART]` tag) matches what you expect.
10. Optional: set `order:` to control where it sits in the list (§8b), or `global:` if it should
support a forced Local/Global override (§8a). Most cheats need neither.
@@ -0,0 +1,395 @@
# Quin2k's Cheat Framework Rework
![preview](ModScripts/_Mods/CheatFramework/preview.png)
[Latest version](../../releases/latest)
## 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)
- If you get an error during startup, you may need to edit LonaRPG\UserData\GameMods.ini to deactivate a mod.
- If any of my mods give you errors, please notify me on [F95zone](https://f95zone.to/members/quin2k.428612/) or [Discord](https://discord.com/users/292323791533506560).
## Requirements
Lowest game version tested: `0.10.0.2`<br>
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).
<details>
<summary>Default Hotkeys</summary>
- 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.
</details>
<details>
<summary>Menu Structure</summary>
- 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)
- 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
- Config
- View/Clear Hotkeys
- Edit Menu Order
- Edit Globals
- Reset Config Settings
</details>
## 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
<details>
<summary>Ver 0.9.0q Changelog</summary>
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.
</details>
<details>
<summary>Ver 0.9.1q Changelog</summary>
- Minor change to config file structure before initial release (split global/hotkeys/modules to separate ini files fixed quotes being added to hotkeys.)
</details>
<details>
<summary>Ver 0.9.2q Changelog</summary>
- 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](https://docs.google.com/spreadsheets/d/1hoDT0cJfvXVhomTkJyq5G6tgjrkiBAm26lsjEOWU3_k/edit?usp=sharing).
- 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.
</details>
<details>
<summary>Ver 0.9.3q Changelog</summary>
- 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.
</details>
<details>
<summary>Ver 0.9.4q Changelog</summary>
- 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.
</details>
<details>
<summary>Ver 0.9.5q Changelog</summary>
- 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.
</details>
<details>
<summary>Ver 1.0q Changelog</summary>
- 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.
</details>
<details>
<summary>Ver 1.1q Changelog</summary>
- 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.
</details>
<details>
<summary>Ver 1.2q Changelog</summary>
- "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
</details>
<details>
<summary>Ver 1.3q Changelog</summary>
- 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.
</details>
<details>
<summary>Ver 1.3.1q Changelog</summary>
- 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).
</details>
---
## Credits
See the [credits file](ModScripts/_Mods/CheatFramework/docs/Credits.md) 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.