Cross-platform persistent save directory (IDBFS on WASM, filesystem on desktop)

Game code uses standard Python file I/O to mcrfpy.save_dir with no platform
branching. On WASM, builtins.open() is monkeypatched so writes to /save/
auto-sync IDBFS on close, making persistence transparent.

API: mcrfpy.save_dir (str), mcrfpy._sync_storage() (auto-called on WASM)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
John McCardle 2026-02-25 20:42:44 -05:00
commit e2d3e56968
7 changed files with 212 additions and 1 deletions

View file

@ -1,5 +1,6 @@
#include "GameEngine.h"
#include "ActionCode.h"
#include <sys/stat.h>
#include "McRFPy_API.h"
#include "PyScene.h"
#include "UITestScene.h"
@ -77,6 +78,15 @@ GameEngine::GameEngine(const McRogueFaceConfig& cfg)
Resources::font.loadFromFile("./assets/JetbrainsMono.ttf");
Resources::game = this;
window_title = "McRogueFace Engine";
// Ensure save/ directory exists for persistent game data
#ifndef __EMSCRIPTEN__
// Desktop: create save/ in working directory (WASM uses IDBFS mount from JS)
struct stat st;
if (stat("save", &st) != 0) {
mkdir("save", 0755);
}
#endif
// Initialize rendering based on headless mode
if (headless) {

View file

@ -44,6 +44,10 @@
#include "ldtk/PyAutoRuleSet.h" // LDtk auto-rule sets
#include "McRogueFaceVersion.h"
#include "GameEngine.h"
#ifdef __EMSCRIPTEN__
#include <emscripten.h>
#endif
#include <sys/stat.h> // mkdir
// ImGui is only available for SFML builds
#if !defined(MCRF_HEADLESS) && !defined(MCRF_SDL2)
#include "ImGuiConsole.h"
@ -103,6 +107,20 @@ static bool McRFPyMetaclass_initialized = false;
// ============================================================================
#ifdef __EMSCRIPTEN__
extern "C" void sync_storage();
#endif
// Flush persistent storage (IDBFS on WASM, no-op on desktop)
static PyObject* mcrfpy_sync_storage(PyObject* self, PyObject* args)
{
#ifdef __EMSCRIPTEN__
sync_storage();
#endif
// On desktop, writes go directly to disk — nothing to sync
Py_RETURN_NONE;
}
// #151: Module-level __getattr__ for dynamic properties (current_scene, scenes)
static PyObject* mcrfpy_module_getattr(PyObject* self, PyObject* args)
{
@ -135,6 +153,14 @@ static PyObject* mcrfpy_module_getattr(PyObject* self, PyObject* args)
return PyFloat_FromDouble(PyTransition::default_duration);
}
if (strcmp(name, "save_dir") == 0) {
#ifdef __EMSCRIPTEN__
return PyUnicode_FromString("/save");
#else
return PyUnicode_FromString("save");
#endif
}
// Attribute not found - raise AttributeError
PyErr_Format(PyExc_AttributeError, "module 'mcrfpy' has no attribute '%s'", name);
return NULL;
@ -347,6 +373,16 @@ static PyMethodDef mcrfpyMethods[] = {
"The algorithm ensures minimal grid traversal between two points.")
)},
{"_sync_storage", mcrfpy_sync_storage, METH_NOARGS,
MCRF_FUNCTION(_sync_storage,
MCRF_SIG("()", "None"),
MCRF_DESC("Flush save directory to persistent storage."),
MCRF_RETURNS("None")
MCRF_NOTE("On WebAssembly, flushes the /save/ directory to IndexedDB via IDBFS. "
"On desktop, this is a no-op since writes go directly to disk. "
"Call this after writing files to mcrfpy.save_dir to ensure persistence.")
)},
{NULL, NULL, 0, NULL}
};
@ -757,6 +793,53 @@ PyObject* PyInit_mcrfpy()
// - line() functionality replaced by mcrfpy.bresenham()
// - compute_fov() redundant with Grid.compute_fov()
#ifdef __EMSCRIPTEN__
// WASM: Monkeypatch builtins.open() so that writes to /save/ auto-sync IDBFS.
// This makes `with open(path, 'w') as f: ...` persist transparently on web.
PyRun_SimpleString(R"(
import builtins as _builtins
_mcrf_original_open = _builtins.open
class _McRF_SyncingFile:
__slots__ = ('_file',)
def __init__(self, f):
object.__setattr__(self, '_file', f)
def __getattr__(self, name):
return getattr(self._file, name)
def __enter__(self):
self._file.__enter__()
return self
def __exit__(self, *args):
result = self._file.__exit__(*args)
import mcrfpy
mcrfpy._sync_storage()
return result
def close(self):
self._file.close()
import mcrfpy
mcrfpy._sync_storage()
def __iter__(self):
return iter(self._file)
def __next__(self):
return next(self._file)
def writable(self):
return self._file.writable()
def readable(self):
return self._file.readable()
def seekable(self):
return self._file.seekable()
def _mcrf_syncing_open(path, mode='r', *args, **kwargs):
f = _mcrf_original_open(path, mode, *args, **kwargs)
if any(c in mode for c in 'wxa+') and str(path).startswith('/save'):
return _McRF_SyncingFile(f)
return f
_builtins.open = _mcrf_syncing_open
del _builtins
)");
#endif
//McRFPy_API::mcrf_module = m;
return m;
}

View file

@ -292,6 +292,18 @@ int get_python_globals_count() {
return (int)PyDict_Size(main_dict);
}
// Flush IDBFS to IndexedDB (called from Python via mcrfpy._sync_storage())
EMSCRIPTEN_KEEPALIVE
void sync_storage() {
EM_ASM(
FS.syncfs(false, function(err) {
if (err) {
console.error('McRogueFace: Failed to sync /save/ to IndexedDB:', err);
}
});
);
}
// Notify the engine that the browser canvas was resized (called from JS)
EMSCRIPTEN_KEEPALIVE
void notify_canvas_resize(int width, int height) {

View file

@ -673,6 +673,18 @@
// ===========================================
var Module = {
preRun: [function() {
// Mount IDBFS at /save/ for persistent game data
FS.mkdir('/save');
FS.mount(IDBFS, {}, '/save');
// Restore saved data from IndexedDB (synchronous before main())
Module.addRunDependency('idbfs-restore');
FS.syncfs(true, function(err) {
if (err) console.error('McRogueFace: Failed to restore /save/:', err);
else console.log('McRogueFace: /save/ restored from IndexedDB');
Module.removeRunDependency('idbfs-restore');
});
}],
print: (function() {
return function(text) {
if (arguments.length > 1) text = Array.prototype.slice.call(arguments).join(' ');

View file

@ -82,6 +82,18 @@
});
var Module = {
preRun: [function() {
// Mount IDBFS at /save/ for persistent game data
FS.mkdir('/save');
FS.mount(IDBFS, {}, '/save');
// Restore saved data from IndexedDB (synchronous before main())
Module.addRunDependency('idbfs-restore');
FS.syncfs(true, function(err) {
if (err) console.error('McRogueFace: Failed to restore /save/:', err);
else console.log('McRogueFace: /save/ restored from IndexedDB');
Module.removeRunDependency('idbfs-restore');
});
}],
print: function(text) {
if (arguments.length > 1) text = Array.prototype.slice.call(arguments).join(' ');
console.log(text);