mirror of
https://github.com/tangerineturtle1/NX2navi.git
synced 2026-11-17 09:19:58 -04:00
Add a Mods screen to the launcher and build the mods' code patches into the launcher's game.
Mods, on the home screen, opens the game's mods folder, adds a downloaded mod from its .zip, .7z or .rar file or its folder, switches each mod on or off, and sets the load order (mods_disabled and mods_order in nx2navi.ini, written as the game writes them). Each mod's description says what it changes, which other mod changes the same files and which of the two wins, and why the game leaves it off when it does. Before the game starts, Play puts the mods folder in order (launcher/mods.py prepare): an archive in it is unpacked into a folder of its name and kept, a mod whose files sit a folder or more down has them moved up, and a romfs, exefs or cheats folder put straight into the mods folder becomes a mod of its own. An archive that would write outside its folder is refused, and nothing is deleted. The launcher's build (tools/make_game.py) left the mods' code cheats and ExeFS patch files out, so those mods stayed off. The lift now turns them into patch sets first, as the setup does, with the files in the lift's key and build-cache/mod-code.json recording what it took up. Play builds the game again before it starts when an enabled mod brings code no build has seen. The shaders' key names the lift and the compile without the mods' code, so such a build compiles only what the patches change and leaves the shaders prepared. tools/mod_files.py is the one place the tools, the build and the launcher find a mod's parts. Tested: a zipped mod holding its own folder, put into a mods folder, was unpacked and moved up by the launcher's code, and the game served its file in place of the game's. The lifter took a code cheat and a pchtxt patch made for the game's main as patch sets. The launcher's and the setup's tests pass. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -88,7 +88,9 @@ identity (`NX2navi.Launcher`), so the taskbar groups and pins it under NX2navi r
|
||||
Screens (`launcher/ui/app.py`): first run (dump, install folder, Desktop Shortcut, Check for Updates at Start,
|
||||
Update Channel, Begin Installation); the steps of an install, update or rebuild with their progress, the build log's
|
||||
last lines and Cancel, and after a failure Try Again and Copy Report; home (Play, Updates, Game Folder, Saves,
|
||||
Rebuild the Game, Customize Launcher, Settings); customize (Color Scheme, with Custom Background Color, Panel Color and
|
||||
Mods, Rebuild the Game, Customize Launcher, Settings); mods (Open Mods Folder, Add a Mod, Add a Mod Folder, one On/Off
|
||||
row for each mod, More Mods when they fill more than a page, Load Order, Back); load order (each mod with its place,
|
||||
left and right to move it); customize (Color Scheme, with Custom Background Color, Panel Color and
|
||||
Button Color, Background, with a picture set Background Dimming and Remove Background, Animations, Sounds, Add to Steam on
|
||||
Windows, Back); the colour picker (Hue, Saturation, Brightness, Hex Code, Reset, Done); saves (Export Save, Add Log and Settings, Export To, Import a Save, Import a Save Folder,
|
||||
Open Saves Folder, Back); settings (update check, Install Updates Automatically, Hide Launcher While Playing, Keep
|
||||
@@ -338,6 +340,38 @@ copies the current save to `saves/backup <date time>` and makes the import the s
|
||||
(`runtime/fs_host.c` `import_pending`), and the menu says where the old save went. An import in the launcher replaces
|
||||
one still waiting from the menu.
|
||||
|
||||
## Mods
|
||||
|
||||
Mods (home, under Saves; `launcher/mods.py`) is where the player puts the mods they download. The game reads the game
|
||||
folder's `mods` folder (`runtime/mods.c`; `mods_dir` in nx2navi.ini names another): one folder per mod, holding a
|
||||
`romfs` folder with the game files it replaces, an `exefs` folder with code patches (`.ips`, `.pchtxt`) or a `cheats`
|
||||
folder, either at its top or in the Atmosphere layout (`atmosphere/contents/0400486024DEC000/romfs` and the others
|
||||
`tools/mod_files.py` lists).
|
||||
|
||||
A mod goes in as it came. Play first puts the folder in order (`mods.prepare`): an archive (`.zip`, and `.7z` or
|
||||
`.rar` through Windows' own `tar`, which reads them on Windows 10 and 11) is unpacked into a folder of its name unless
|
||||
that folder is there already, and the archive stays; a mod folder whose files sit one or more folders down (an archive
|
||||
that held the mod's own folder) gets them moved up; a `romfs`, `romfslite`, `exefs` or `cheats` folder put straight into
|
||||
the mods folder becomes a mod of its own, *Unnamed mod*. An archive that would write outside its folder is refused.
|
||||
Nothing is deleted. Add a Mod and Add a Mod Folder do the same for an archive or folder the player picks, which is
|
||||
unpacked or copied into the mods folder under a free name; Open Mods Folder opens it.
|
||||
|
||||
Each mod has an On/Off row; its description says what it changes (how many game files, code patches, cheats), which
|
||||
other mod changes the same files and which of the two wins, and why the game leaves it off when it does: a code module
|
||||
(`subsdk*`), a download with options to pick from (several folders that each hold a mod), a mod for another game or
|
||||
another version, or nothing the game reads. Load Order sets which mod wins a file two of them change: the higher one.
|
||||
The switches and the order are the game's own settings, `mods_disabled` and `mods_order` in nx2navi.ini, written as the
|
||||
game writes them; they apply at the game's next start, so they wait while it runs.
|
||||
|
||||
**Mods that change the game's code.** The game is lifted from the console's code ahead of time, so code cheats and
|
||||
ExeFS patches cannot be applied while it runs: the build turns them into patch sets of the lifted code
|
||||
(`tools/cheats.py`, `tools/exefs_patches.py`) that the game switches on with their mod, and the Cheats tab of the
|
||||
game's menu switches each cheat. The lift step's key names those files, so a build lifts and compiles again when they
|
||||
change (only the changed parts compile, and the shaders stay prepared), and `build-cache/mod-code.json` records the
|
||||
files it took up. When an enabled mod brings code no build has seen, Play builds the game again first (a few minutes;
|
||||
the home's Mods row says "Build Waiting") and starts it after. A Play from Steam then opens the window for that build.
|
||||
Code mods are built from the game folder's own `mods` folder only.
|
||||
|
||||
## Importing a save folder
|
||||
|
||||
Import a Save Folder (Saves) makes another save the game's own. A save put into the game folder's `saves` folder (its
|
||||
|
||||
@@ -55,6 +55,13 @@ for the launcher; a GPU with Vulkan 1.3 and `VK_EXT_external_memory_host` (curre
|
||||
|
||||
## New
|
||||
|
||||
- **Mods in the launcher.** Mods, on the launcher's home screen, opens the mods folder and adds a mod you downloaded,
|
||||
as its .zip, .7z or .rar file or its folder; one put into the mods folder by hand works as well. Before the game
|
||||
starts, the launcher unpacks archives and moves a mod's files to where the game looks for them when they sit a folder
|
||||
or two down. Each mod has an On/Off switch and says what it changes, which other mod changes the same files and
|
||||
which of them wins, and why the game cannot use it when it cannot; Load Order sets which mod wins. A mod with code
|
||||
patches or code cheats is built into the game before it starts, which takes a few minutes the first time: the
|
||||
launcher's own build left those out until now.
|
||||
- **One Anti-aliasing setting**: the game's own SMAA, off, FXAA, SMAA at its Ultra preset, or TAA.
|
||||
- **Direct mouse camera on game 1.1.1**: the camera takes the mouse's own movement after the stick's dead zone.
|
||||
Contributed by Gaetarra (pull request #462).
|
||||
|
||||
Reference in New Issue
Block a user