mirror of
https://github.com/tangerineturtle1/NX2navi.git
synced 2026-11-16 09:39:58 -04:00
The launcher's home has a Saves screen: Export Save writes NX2navi-save-<date>_<time>.zip into Downloads (or a chosen folder) with a manifest, the save the game would load next and, for a bug report, the game's latest log and nx2navi.ini, never a key file; Import a Save checks a zip's manifest, game, paths and CRCs, backs the current save up into the saves folder and replaces it while the game is not running. The game's Game tab has the same exports and an import that waits in profile/save-import and becomes the save at the next start, since the running game would write its progress back over a save replaced under it. The zip code (runtime/save_zip.c) and the import at start are checked without game files by tests/save_zip_check.py and tests/save_share_check.py; the launcher side by its test suite. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
59 lines
3.1 KiB
Python
59 lines
3.1 KiB
Python
"""data/launcher.json: the player's choices and what the launcher remembers between runs."""
|
|
import json
|
|
import os
|
|
import shutil
|
|
from pathlib import Path
|
|
|
|
DEFAULTS = {
|
|
'game_dir': '', # the built game; empty until the first install picks one
|
|
'dump': '', # the .nup (or the folder with exefs/ and romfs/) the game was built from
|
|
'auto_check': True, # look for a new version when the launcher opens, and every hour while it runs
|
|
'auto_install': True, # install a downloaded update by itself whenever the game is not running
|
|
'channel': 'stable', # 'stable' or 'preview' (GitHub pre-releases)
|
|
'hide_while_playing': True, # hide the window while the game runs, show it again when it exits
|
|
'keep_cache': True, # keep build-cache/ (the lift and objects) so an update recompiles only changes
|
|
'desktop_shortcut': True,
|
|
'save_export_dir': '', # where Saves > Export Save writes its zip; empty: the Downloads folder
|
|
'export_with_log': True, # Export Save adds the game's latest log and nx2navi.ini (for a bug report)
|
|
'feed_repo': '', # owner/name overriding feed.json, for testing a fork's releases
|
|
'github_token': '', # only for a private release repository; stored as plain text
|
|
'last_check': 0.0,
|
|
'last_seen': '', # the newest version the player was told about
|
|
'rolled_back': '', # the last version that failed to start; it is never downloaded or installed by itself
|
|
}
|
|
|
|
|
|
class Settings(dict):
|
|
def __init__(self, path):
|
|
super().__init__(DEFAULTS)
|
|
self.path = Path(path)
|
|
self.unreadable = False # the file is there but is no JSON; a copy of it is kept as launcher.json.bad
|
|
try:
|
|
# utf-8-sig: the docs ask players to edit the file by hand, and an editor may save it with a BOM
|
|
data = json.loads(self.path.read_text(encoding='utf-8-sig'))
|
|
if isinstance(data, dict):
|
|
self.update({k: v for k, v in data.items() if k in DEFAULTS and type(v) is type(DEFAULTS[k])})
|
|
except OSError:
|
|
pass
|
|
except ValueError:
|
|
# a typo made by hand: keep what the player wrote before the next save() replaces it with the defaults
|
|
self.unreadable = True
|
|
try:
|
|
shutil.copyfile(self.path, self.path.with_name(self.path.name + '.bad'))
|
|
except OSError:
|
|
pass
|
|
|
|
def save(self):
|
|
self.path.parent.mkdir(parents=True, exist_ok=True)
|
|
tmp = self.path.with_name(self.path.name + '.tmp')
|
|
tmp.write_text(json.dumps(dict(self), indent=1), encoding='utf-8')
|
|
os.replace(tmp, self.path)
|
|
|
|
def reset(self):
|
|
"""Default Settings: the choices go back to their defaults; the game folder, dump and history stay."""
|
|
keep = {k: self[k] for k in ('game_dir', 'dump', 'last_check', 'last_seen', 'feed_repo', 'github_token',
|
|
'rolled_back')}
|
|
self.clear()
|
|
self.update(DEFAULTS)
|
|
self.update(keep)
|