emulators.scummvm

Root of the RomM library mount (env ROM_ROOT, default /romm).

A resolved game folder must sit under it; anything resolving outside is discarded.

ScummVM's config directory (env SCUMMVM_CONFIG_DIR, default /config/.config/scummvm).

Safe to move, because every ScummVM the broker runs is told where it is: --config names INI_PATH on the launch command line and on --add's. Without that the knob would move only the file the broker patches while ScummVM kept resolving its own, so the pinned settings and the registered game targets would land in a file nothing opens.

The config the broker pins before every launch and reads game targets back out of.

ScummVM's data directory (env SCUMMVM_DATA_DIR, default /config/.local/share/scummvm).

Where ScummVM writes every save, which is also where the working slot lives.

Log file the broker appends this emulator's output to (env SCUMMVM_LOG_PATH).

Where archived games are extracted and booted from (env SCUMMVM_CACHE_DIR, default DATA_DIR/extracted).

An extraction is kept and reused by every later launch of the same archive, and its folder is what gets registered in scummvm.ini, so the target and the saves named after it stay the same from one launch to the next.

Cap on the extraction cache in GB (env SCUMMVM_CACHE_MAX_GB, default 10).

The least recently booted games are evicted to make room for a new one.

Seconds 7z or unrar gets to list an archive's members before it is considered hung.

ScummVM's own autosave slot.

MetaEngine::getAutosaveSlot returns 0 and MetaEngine::listSaves marks it setWriteProtectedFlag(true), so the save chooser refuses to write there. It is never the working slot, and a save request that names it lands in STATE_SLOT like any other.

The one slot the broker saves into (env SCUMMVM_STATE_SLOT, default 1).

Low on purpose: the chooser is walked with one Down per slot, so a high slot would spend a keystroke per row getting there. Slot 0 is unavailable (see AUTOSAVE_SLOT), which makes 1 the first usable row.

Seconds to wait for the save macro's write to land (env SCUMMVM_STATE_WAIT).

Seconds size and mtime must both hold still before a save counts as written.

From env SCUMMVM_STATE_STABLE, default 1.0. Long enough that a write still in progress on a loaded host does not read as a finished one.

Seconds between the macro's steps (env SCUMMVM_KEY_DELAY).

The GMM animates itself in and its chooser fades in after it, and a keystroke sent into either transition is dropped without a trace.

Seconds scummvm --add gets to scan a folder (env SCUMMVM_ADD_TIMEOUT).

Generous because detection reads through every file in the folder, which on a network mount holding a CD rip is not fast.

Seconds a deferred resume waits for RomM to push its state (env SCUMMVM_RESUME_LOAD_WAIT).

Seconds a deferred resume gives the game to reach a menu-able state (env SCUMMVM_RESUME_LOAD_SETTLE).

Whether the game is grown to fill the stream (env SCUMMVM_FILL_SCREEN, default on).

A ScummVM window is its game's own resolution, 640x480 for most, which is a postage stamp in the middle of the stream. The obvious fix is ScummVM's own fullscreen, and it is the wrong one: going fullscreen makes SDL grab the pointer and confine it to a rect (SdlWindow::createOrUpdateWindow: shouldGrab = ... || fullscreenFlags, then SDL_SetWindowMouseRect) and ask for an explicit display mode on the way in. Both are harmless on a real X server and both fight a streaming stack that feeds an absolute pointer and owns the display size itself: the pointer stops tracking while clicks still land, and these games are nothing but mouse. fullscreen is therefore pinned off in the ini whatever this setting says.

What works is asking the window manager for the size instead. The window is resized to the display after launch, SDL sees an ordinary resize and scales its output into it, letterboxing to keep the game's aspect on its own, and never sets the flag that triggers the grab. The cost is the title bar, which no tool in this image can remove (xdotool 3.2016 has no windowstate, and there is no wmctrl); a labwc window rule in the image would.

window_maximized is deliberately not used either: labwc leaves the window at its own size regardless, so it fills nothing.

Seconds to wait for the game window before giving up on resizing it.

Seconds between checks that the window still matches the display.

The display is resized by whichever client is connected, so the window has to follow it rather than being sized once at launch.

Key that opens the Global Main Menu (env SCUMMVM_MENU_KEY, default F11).

Bound to the global keymap in scummvm.ini on every launch rather than trusting a default, for two reasons. ScummVM ships the global menu on C+F5, and a modifier does not survive injection into this container's Xwayland: the key arrives without its Ctrl, so the menu never opens. The unmodified F5 that does work belongs to the engine keymap, which an engine is free to take for itself (gob answers it with Gobliiins' own panel, which has no Save). Pinning one unmodified key on the global keymap avoids both.

The language codes ScummVM itself accepts (Common::parseLanguage).

Not ISO-639: ScummVM keeps a few of its own spellings (Brazilian Portuguese is br, Chinese splits into zh/cn/tw), so a code from outside has to be translated before it means anything on the command line.