Mod Settings¶
Mod Settings controls the public identity of the mod and optional gameplay rules. Open it from the selected mod's in-game editor menu.
Basic Fields¶
Name is the mod's display name and editable folder name. Avoid changing it, because character logic, sprite references, sounds, music, palettes, and replacement data may have direct references to the mod name - renaming the mod can break those references.
Description is shown to players when browsing mods. Use it to describe the experience, required dependencies, or the scope of the mod.
Preview Image changes the thumbnail shown for the mod in menus. Pick an image that identifies the mod clearly at small sizes.
Gameplay Settings¶
Enable gameplay settings when the mod should be playable and should not rely on existing settings from a dependency mod.
Choose Gameplay Rules... for the mod's permanent rules. These are stored in the mod's config.json and travel with the exported mod. The Custom Game screen configures a play session instead.
| Group | What you can change |
|---|---|
| Combat and co-op | Friendly fire, enemy infighting, direction on hit, shadow clones, killer or exploding enemies, instant spawns, infinite continues, starting health and player limits. |
| Balance overrides | Enemy health, damage and speed; player damage; scroll speed; doubled enemy spawns; enemy randomizer and seed; score thresholds for extra lives. |
| Classic behaviour and controls | Widescreen, New Era improvements, smooth controls, classic slowdown, camera advance checks and the sprite buffer fix. |
thrownCharactersSparePlayers has no button: set it in config.json to keep friendly fire while bodies thrown by a player never hit other players. See config.json.
Click an On/Off button to switch a rule. Click a choice button to cycle its options. Scroll to see the remaining groups; keyboard/controller selection also brings rows into view.
Save Rules validates and saves your changes. Cancel discards changes made on this screen. Opening the screen first saves the name, description and basic settings from the parent menu.
For multipliers, 1 means 100% and 1.5 means 150%. Leave an override blank to use the difficulty's value; blank scroll speed uses the normal speed. Extra-life scores are comma-separated, for example 20000, 50000, 150000.
Use Difficulty Settings for lives, credits and balance that varies by difficulty or number of players. A global override takes precedence over its corresponding difficulty value.
Disabling gameplay settings after changing them can discard those gameplay-specific values. The editor asks for confirmation when the current settings differ from the defaults.
Practical Guidance¶
Use gameplay settings for total conversions, curated level packs, balance mods, and mods that rely on a custom enemy count or damage curve. Leave them disabled for asset-only mods such as character packs, audio packs, or palette packs.
A mod with just gameplay settings can be exported as a new way of playing the classic game. The Ninpo Kage Bunshin mod is an example of that: it uses the classic content, just with new gameplay settings.
Pack imports, character restrictions and global Lua hooks still require config.json. Existing values are preserved when saving gameplay rules. Shared lives, duplicate character selection and stiffness belong to the current session configuration; they are not persistent mod fields.
Related pages: Create New Mod, Difficulty Settings, Test Mod, Export Mod.