diff --git a/runtime/cfg.c b/runtime/cfg.c index f078e50f..720e254d 100644 --- a/runtime/cfg.c +++ b/runtime/cfg.c @@ -43,7 +43,7 @@ static const char *const known[] = { "FULLSCREEN", "FXAA", "GPL", "GPL_DRAW_BUILD", "GPU", "GPU_INDEX", "GPU_NAME", "HDR", "HDR_GAME_NITS", "HDR_PEAK_NITS", "HDR_UI_NITS", "HIGHFPS_FIX", "INPUT", "INPUT_RECORD", "INPUT_SCRIPT", "LANG", "LIB_PREBUILD", "LIB_PREBUILD_KEEP", "LIB_PREBUILD_THREADS", "LOCALE", "LOD_GUARD", "LSTICK_DEADZONE", "MEMORY", "MENU_LANG", "MENU_TEST", - "MENU_TEST_DIR", "MENU_TEST_SET", "MINIMAL_LAYOUT", "MIRROR_GAP", "MOTION", "MOUSE_SENS", "MOVIE_HOST", "MOVIE_PACE", + "MENU_TEST_DIR", "MENU_TEST_SET", "MINIMAL_LAYOUT", "MIRROR_GAP", "MODS_DIR", "MODS_DISABLED", "MODS_ORDER", "MOTION", "MOUSE_SENS", "MOVIE_HOST", "MOVIE_PACE", "ONE_PER_CORE", "OPERATION_MODE", "OUTPUT_RES", "PAD_LAYOUT", "PATCH_OUTPUT", "PATCH_SCENE", "PCSS", "PCSS_K", "PERF_OVERLAY", "PERF_SLOW_MS", "PIPELINE_CACHE", "PIPE_MEMO", "PIPE_PREBUILD", "PIPE_SKIP", "PIPE_SYNC", "PIPE_WAIT", "PREWARM_XLATE", "PROBE_MOVIE", "PROBE_MOVIE_SHOT", "PROFILE", "PROFILE_CHAINS", "PROFILE_DIR", "PROFILE_FRAMES", "PROFILE_MAIN", "PROFILE_RENDER", "PROMPTS", "PUSH_SKIP", "PUSH_STAGE", "RDOC", "RDOC_DIR", "RDOC_DLL", "REALTIME", "REC_END", "REEXEC", @@ -74,6 +74,7 @@ static const struct { const char *key, *section; } sections[] = { {"DEVICE_PROFILE", "display"}, {"ASSUME_FOCUS", "display"}, {"SHADOW_SCALE", "display"}, {"SHADOW_RANGE", "display"}, {"CONTACT_SHADOWS", "display"}, {"PCSS", "display"}, + {"MODS_DIR", "mods"}, {"MODS_ORDER", "mods"}, {"MODS_DISABLED", "mods"}, {"MENU_LANG", "language"}, {"LANG", "language"}, {"OPERATION_MODE", "language"}, {"VOLUME", "audio"}, {"MOTION", "input"}, {"RUMBLE_STRENGTH", "input"}, {"RUMBLE_CURVE", "input"}, {"RUMBLE_TRIGGERS", "input"}, diff --git a/runtime/cfg_probe.c b/runtime/cfg_probe.c index 815bc811..866f4cc5 100644 --- a/runtime/cfg_probe.c +++ b/runtime/cfg_probe.c @@ -456,6 +456,11 @@ int probe_cfg(void) { if (!ok) fprintf(stderr, "FAIL cfg: default '%s' of %s is not one of its values '%s'\n", m->def, m->key, m->values), fails++; } CHECK(listed >= 30, "the defaults table was walked"); + // cfg_meta answers with the first row of a key: a second row would be dead, and Reset would visit the key twice + for (int i = 0; cfg_meta_at(i); i++) + for (int j = i + 1; cfg_meta_at(j); j++) + if (!strcmp(cfg_meta_at(i)->key, cfg_meta_at(j)->key)) + fprintf(stderr, "FAIL cfg: %s has two rows in the defaults table\n", cfg_meta_at(i)->key), fails++; printf("probe-cfg: %s\n", fails ? "FAIL" : "ok"); return fails ? 1 : 0; } diff --git a/runtime/host.h b/runtime/host.h index e071f182..a0bd2675 100644 --- a/runtime/host.h +++ b/runtime/host.h @@ -308,6 +308,7 @@ void rt_boot(void); // boot.c // process exit code. int probe_cfg(void); // cfg_probe.c int probe_dpi(void); // dpi_probe_win.c (Windows only) +int probe_mods(void); // mods_probe.c int probe_loader(void), probe_kernel(void), probe_ipc(void), probe_services(void), probe_fs(void); int probe_gfx_abi(void); // gfx_abi_probe.c int probe_vkdevice(void); // vk_device.c diff --git a/runtime/main.c b/runtime/main.c index 9bd1009a..e6ced76e 100644 --- a/runtime/main.c +++ b/runtime/main.c @@ -2,6 +2,7 @@ // // totk.exe [--exefs DIR] [--romfs DIR] [--profile DIR] // --selftest layout, dispatch table and host-function registry; needs no game files +// --probe-mods the mods folder scan, order and switches (mods.c); needs no game files // --probe-loader load and relocate the modules, check them against the measured 1.2.1 values // --probe-kernel, --probe-ipc, --probe-services, --probe-fs host probes // --probe-dpi the process DPI awareness (per-monitor v2) and the primary monitor's size; no game files @@ -440,7 +441,7 @@ static int selftest(void) { static int usage(const char *argv0) { fprintf(stderr, "usage: %s [--exefs DIR] [--romfs DIR] [--profile DIR] [--selftest | --probe-loader | " - "--probe-cfg | --probe-dpi | --probe-kernel | --probe-ipc | --probe-services | --probe-fs | --probe-gfx-abi | " + "--probe-cfg | --probe-dpi | --probe-mods | --probe-kernel | --probe-ipc | --probe-services | --probe-fs | --probe-gfx-abi | " "--probe-nvn | --probe-nvn-tex | --probe-window | --probe-shader | --probe-vkmem | " "--probe-vkexec | --probe-astc | --probe-movie | --prepare-shaders | --warm-shaders | --boot |--seconds S [--shot PNG]]\n", argv0); return 2; @@ -534,6 +535,7 @@ int main(int argc, char **argv) { #ifdef _WIN32 if (!strcmp(mode, "--probe-dpi")) return probe_dpi(); // the Win32 DPI awareness of totk.manifest #endif + if (!strcmp(mode, "--probe-mods")) return probe_mods(); if (!strcmp(mode, "--probe-kernel")) return probe_kernel(); if (!strcmp(mode, "--probe-ipc")) return probe_ipc(); if (!strcmp(mode, "--probe-services")) return probe_services(); diff --git a/runtime/mods.c b/runtime/mods.c new file mode 100644 index 00000000..73508222 --- /dev/null +++ b/runtime/mods.c @@ -0,0 +1,247 @@ +// Player mods: the scan of the mods folder, its order and switches (mods.h). +// +// One subfolder per mod, as emulators take them. The RomFS root is the first of /romfs, /romfslite (TKMM's +// name for it when it bypasses Atmosphere's RomFS build), /atmosphere/contents//romfs, +// <mod>/contents/<title>/romfs and <mod>/<title>/romfs that exists; the ExeFS and cheats folders likewise. A mod is +// listed whatever it holds; what the port cannot use is its problem, shown in the menu and logged, and never stops the +// start. romfs.c serves the RomFS files of the enabled mods, the top one winning a path. +// +// The order and the switches are totk.ini keys (cfg.c): TOTK_MODS_ORDER lists names top first, separated by '|' (a +// Windows file name cannot hold '|'; a folder whose name does on Linux is listed as unusable); a folder it does not name +// goes below the named ones, by name. TOTK_MODS_DISABLED lists the switched-off names. The menu changes the list in +// place and writes both keys; the scan's state is kept to tell the menu a restart is due. +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <strings.h> + +#include "cfg.h" +#include "host.h" +#include "mods.h" +#include "platform/platform.h" + +#define TITLE "0100F2C0115B6000" +#define MAX_MODS 512 + +static ModInfo *mods; +static int nmods; +static char dir[2048]; +static char start_order[MAX_MODS][256]; // names in the scan's order and their switches, for mods_changed +static int start_enabled[MAX_MODS]; + +// 1 when a file lies anywhere under path. +static int has_file_cb(const char *name, int kind, uint64_t size, void *ctx); +static int has_file(const char *path) { + struct { const char *path; int found; } c = {path, 0}; + plat_fs_list(path, has_file_cb, &c); + return c.found; +} +static int has_file_cb(const char *name, int kind, uint64_t size, void *ctx) { + (void)size; + struct { const char *path; int found; } *c = ctx; + if (kind == PLAT_FS_FILE) { + c->found = 1; + } else if (kind == PLAT_FS_DIR) { + char sub[2100]; + if (snprintf(sub, sizeof sub, "%s/%s", c->path, name) < (int)sizeof sub) c->found = has_file(sub); + } + return !c->found; +} + +// The first of the emulator and Atmosphere places of <mod>/<part> that is a folder, into out ("" none). +static void find_root(const char *mod, const char *part, char *out, size_t cap) { + static const char *const forms[] = {"%s/%s", "%s/atmosphere/contents/" TITLE "/%s", "%s/contents/" TITLE "/%s", + "%s/" TITLE "/%s"}; + for (size_t i = 0; i < sizeof forms / sizeof *forms; i++) { + if (snprintf(out, cap, forms[i], mod, part) < (int)cap && plat_dir_exists(out)) return; + } + out[0] = 0; +} + +static int ends_with_ci(const char *s, const char *tail) { + size_t n = strlen(s), t = strlen(tail); + return n >= t && !strcasecmp(s + n - t, tail); +} + +// What the ExeFS folder holds: MOD_EXEFS for patches (.ips, .pchtxt), MOD_SUBSDK for code modules (subsdk* plugins, a +// replaced main). main.npdm alone is the process's metadata, not code: it counts as neither. +static int exefs_cb(const char *name, int kind, uint64_t size, void *ctx) { + (void)size; + int *k = ctx; + if (kind != PLAT_FS_FILE) return 1; + if (ends_with_ci(name, ".ips") || ends_with_ci(name, ".pchtxt")) *k |= MOD_EXEFS; + else if (!strncasecmp(name, "subsdk", 6) || !strcasecmp(name, "main")) *k |= MOD_SUBSDK; + return 1; +} + +// MOD_CHEATS when the cheats folder holds an Atmosphere cheat file (<build id>.txt). +static int cheats_cb(const char *name, int kind, uint64_t size, void *ctx) { + (void)size; + if (kind == PLAT_FS_FILE && ends_with_ci(name, ".txt")) *(int *)ctx |= MOD_CHEATS; + return 1; +} + +// 1 when name is one of the '|'-separated names of list. +static int listed(const char *list, const char *name) { + size_t n = strlen(name); + for (const char *p = list; p && *p;) { + const char *bar = strchr(p, '|'); + size_t len = bar ? (size_t)(bar - p) : strlen(p); + if (len == n && !memcmp(p, name, n)) return 1; + p = bar ? bar + 1 : NULL; + } + return 0; +} + +// The position of name in the '|'-separated list, or -1. +static int list_pos(const char *list, const char *name) { + size_t n = strlen(name); + int k = 0; + for (const char *p = list; p && *p; k++) { + const char *bar = strchr(p, '|'); + size_t len = bar ? (size_t)(bar - p) : strlen(p); + if (len == n && !memcmp(p, name, n)) return k; + p = bar ? bar + 1 : NULL; + } + return -1; +} + +static const char *order_list; // TOTK_MODS_ORDER while sorting +static int by_order(const void *a, const void *b) { + const ModInfo *x = a, *y = b; + int px = list_pos(order_list, x->name), py = list_pos(order_list, y->name); + if (px >= 0 && py >= 0) return px - py; + if (px >= 0 || py >= 0) return px >= 0 ? -1 : 1; + return strcmp(x->name, y->name); +} + +static const char *problem_name(ModProblem p) { + switch (p) { + case MOD_EMPTY: return "empty"; + case MOD_PLUGIN: return "has a code module (subsdk or main), not supported; the whole mod stays off"; + case MOD_EXEFS_LATER: return "ExeFS patches need a game code rebuild, not applied; the whole mod stays off"; + case MOD_CHEATS_LATER: return "cheats only, not loaded yet"; + case MOD_BAD_NAME: return "its folder name holds '|', which the order list uses; rename the folder"; + default: return "ok"; + } +} + +// One mod folder of the scan. +static int scan_cb(const char *name, int kind, uint64_t size, void *ctx) { + (void)size; + const char *disabled = ctx; + if (kind != PLAT_FS_DIR) return 1; + if (nmods == MAX_MODS) { + rt_log("mods: more than %d folders in %s; the rest are left out", MAX_MODS, dir); + return 0; + } + ModInfo *m = &mods[nmods]; + memset(m, 0, sizeof *m); + char path[2100]; + if (snprintf(m->name, sizeof m->name, "%s", name) >= (int)sizeof m->name || + snprintf(path, sizeof path, "%s/%s", dir, name) >= (int)sizeof path) { + rt_log("mods: %s: name too long, left out", name); + return 1; + } + find_root(path, "romfs", m->romfs, sizeof m->romfs); + if (!m->romfs[0]) find_root(path, "romfslite", m->romfs, sizeof m->romfs); + find_root(path, "exefs", m->exefs, sizeof m->exefs); + find_root(path, "cheats", m->cheats, sizeof m->cheats); + if (m->romfs[0] && has_file(m->romfs)) m->kind |= MOD_ROMFS; + if (m->exefs[0]) plat_fs_list(m->exefs, exefs_cb, &m->kind); + if (m->cheats[0]) plat_fs_list(m->cheats, cheats_cb, &m->kind); + // a mod whose code part the port cannot use is off as a whole: its RomFS files may expect that code + m->problem = strchr(m->name, '|') ? MOD_BAD_NAME + : m->kind & MOD_SUBSDK ? MOD_PLUGIN + : m->kind & MOD_EXEFS ? MOD_EXEFS_LATER + : m->kind & MOD_ROMFS ? MOD_OK + : m->kind & MOD_CHEATS ? MOD_CHEATS_LATER + : MOD_EMPTY; + m->enabled = !listed(disabled, m->name); + nmods++; + return 1; +} + +void mods_scan(void) { + static int done; + if (done) return; + done = 1; + const char *d = cfg_get("TOTK_MODS_DIR"); + if (d && *d) { + snprintf(dir, sizeof dir, "%s", d); + } else { + char exe[2048]; + if (!plat_exe_path(exe, sizeof exe)) return; + char *cut = strrchr(exe, '/'), *back = strrchr(exe, '\\'); + if (back > cut) cut = back; + if (!cut) return; + *cut = 0; + snprintf(dir, sizeof dir, "%s/mods", exe); + } + if (!plat_dir_exists(dir)) { + rt_log("mods: no folder %s", dir); + return; + } + mods = calloc(MAX_MODS, sizeof *mods); + if (!mods) return; + plat_fs_list(dir, scan_cb, (void *)cfg_get("TOTK_MODS_DISABLED")); + order_list = cfg_get("TOTK_MODS_ORDER"); + qsort(mods, nmods, sizeof *mods, by_order); + order_list = NULL; + for (int i = 0; i < nmods; i++) { + snprintf(start_order[i], sizeof start_order[i], "%s", mods[i].name); + start_enabled[i] = mods[i].enabled; + const ModInfo *m = &mods[i]; + rt_log("mods: %s: %s,%s%s%s%s%s, %s", m->name, m->enabled ? "on" : "off", m->kind & MOD_ROMFS ? " romfs" : "", + m->kind & MOD_EXEFS ? " exefs" : "", m->kind & MOD_SUBSDK ? " subsdk" : "", + m->kind & MOD_CHEATS ? " cheats" : "", m->kind ? "" : " no files", problem_name(m->problem)); + } + rt_log("mods: %d folders in %s", nmods, dir); +} + +const char *mods_dir(void) { return dir; } +int mods_count(void) { return nmods; } +ModInfo *mods_at(int i) { return i >= 0 && i < nmods ? &mods[i] : NULL; } + +// TOTK_MODS_ORDER as every listed name top first; TOTK_MODS_DISABLED as the switched-off names. A name holding '|' +// would split into two; it is left out of both (its mod is unusable anyway). +static void write_keys(void) { + size_t cap = (size_t)nmods * 257 + 1; + char *order = calloc(cap, 1), *off = calloc(cap, 1); + if (order && off) { + for (int i = 0; i < nmods; i++) { + if (mods[i].problem == MOD_BAD_NAME) continue; + if (*order) strcat(order, "|"); + strcat(order, mods[i].name); + if (!mods[i].enabled) { + if (*off) strcat(off, "|"); + strcat(off, mods[i].name); + } + } + cfg_set("TOTK_MODS_ORDER", order); + cfg_set("TOTK_MODS_DISABLED", off); + } + free(order); + free(off); +} + +void mods_set_enabled(int i, int on) { + if (i < 0 || i >= nmods) return; + mods[i].enabled = on != 0; + write_keys(); +} + +void mods_move(int i, int delta) { + int j = i + delta; + if (i < 0 || i >= nmods || j < 0 || j >= nmods || i == j) return; + ModInfo t = mods[i]; + mods[i] = mods[j]; + mods[j] = t; + write_keys(); +} + +int mods_changed(void) { + for (int i = 0; i < nmods; i++) + if (strcmp(mods[i].name, start_order[i]) || mods[i].enabled != start_enabled[i]) return 1; + return 0; +} diff --git a/runtime/mods.h b/runtime/mods.h new file mode 100644 index 00000000..07d4c311 --- /dev/null +++ b/runtime/mods.h @@ -0,0 +1,41 @@ +// Player mods (mods.c): one folder per mod under mods/ next to totk.exe (TOTK_MODS_DIR), unpacked as emulators take +// them: <mod>/romfs, <mod>/exefs and <mod>/cheats, the Atmosphere layout (atmosphere/contents/<title id>/romfs) or +// TKMM's merged output (romfs or romfslite, exefs, cheats). The list is scanned once at start (romfs.c overlay_init); +// its order and switches live in totk.ini [mods] (TOTK_MODS_ORDER: names top first, separated by '|'; +// TOTK_MODS_DISABLED: names switched off). The top mod wins a file two mods replace. +#pragma once +#include <stdint.h> + +enum { MOD_ROMFS = 1, MOD_EXEFS = 2, MOD_SUBSDK = 4, MOD_CHEATS = 8 }; // ModInfo.kind bits +typedef enum { + MOD_OK, + MOD_EMPTY, // no RomFS file, no ExeFS patch, no cheat file + MOD_PLUGIN, // has code modules (exefs/subsdk*, a replaced exefs/main): the port has no module loader, so the + // whole mod stays off (its RomFS files may expect that code) + MOD_EXEFS_LATER, // has ExeFS patches (.ips, .pchtxt): a rebuild of the game code applies them, not yet here; the + // whole mod stays off until then + MOD_CHEATS_LATER, // only cheat files, which the port does not load yet + MOD_BAD_NAME, // its folder name holds '|', the separator of the order keys +} ModProblem; + +typedef struct { + char name[256]; // folder name, UTF-8 + char romfs[2048]; // UTF-8 path of its RomFS root; "" none + char exefs[2048]; // UTF-8 path of its ExeFS folder; "" none + char cheats[2048]; // UTF-8 path of its cheats folder; "" none + int kind, enabled; + ModProblem problem; + uint32_t replaced, added, overridden; // romfs.c: files served (replacing / added), files a higher mod serves + uint32_t other_version; // romfs.c: files for another game version (*.Product.<n>.*), not served + char overridden_by[256]; // the first higher mod that took one of its files +} ModInfo; + +void mods_scan(void); // once; later calls return at once +const char *mods_dir(void); // the folder scanned (default: <dir of totk.exe>/mods) +int mods_count(void); +ModInfo *mods_at(int i); // 0 = top of the order; NULL out of range +// Menu edits (present path). They change the list mods_at shows and write TOTK_MODS_ORDER / TOTK_MODS_DISABLED with +// cfg_set; romfs.c used the start state, so they apply at the next start. +void mods_set_enabled(int i, int on); +void mods_move(int i, int delta); // -1 up, +1 down; nothing at the ends +int mods_changed(void); // 1 when the order or a switch differs from the start diff --git a/runtime/mods_probe.c b/runtime/mods_probe.c new file mode 100644 index 00000000..349d82d5 --- /dev/null +++ b/runtime/mods_probe.c @@ -0,0 +1,121 @@ +// --probe-mods: the mods folder scan, its order and switches (mods.c). Builds a mods folder of its own next to totk.exe, +// scans it and removes it. Needs no game files. +#include <stdio.h> +#include <string.h> + +#include "cfg.h" +#include "host.h" +#include "mods.h" +#include "platform/platform.h" + +static int fails; +#define CHECK(c, what) do { if (!(c)) { fails++; fprintf(stderr, "FAIL mods: %s\n", what); } } while (0) +#define EQ(a, b) ((a) && !strcmp((a), (b))) + +// root/rel as a file of a few bytes (rel ends in '/': a folder), with every folder above it. +static void put(const char *root, const char *rel) { + char p[2048]; + snprintf(p, sizeof p, "%s/%s", root, rel); + char *slash = strrchr(p, '/'); + *slash = 0; + plat_file_mkdir_p(p); + *slash = '/'; + if (slash[1]) plat_file_write(p, "probe", 5); +} + +static int remove_cb(const char *name, int kind, uint64_t size, void *ctx); +static void remove_tree(const char *dir) { + plat_fs_list(dir, remove_cb, (void *)dir); + plat_fs_rmdir(dir); +} +static int remove_cb(const char *name, int kind, uint64_t size, void *ctx) { + (void)size; + char sub[2048]; + snprintf(sub, sizeof sub, "%s/%s", (const char *)ctx, name); + if (kind == PLAT_FS_DIR) remove_tree(sub); + else plat_fs_unlink(sub); + return 1; +} + +// s ends in tail, either path separator matching either. +static int ends_with(const char *s, const char *tail) { + size_t n = strlen(s), t = strlen(tail); + if (n < t) return 0; + for (size_t i = 0; i < t; i++) { + char a = s[n - t + i], b = tail[i]; + if (a == '\\') a = '/'; + if (b == '\\') b = '/'; + if (a != b) return 0; + } + return 1; +} + +int probe_mods(void) { + char root[1024]; + if (!plat_exe_path(root, sizeof root)) return 1; + char *cut = strrchr(root, '/'), *back = strrchr(root, '\\'); + if (back > cut) cut = back; + if (!cut) return 1; + strcpy(cut + 1, "mods-probe"); + remove_tree(root); + plat_file_mkdir_p(root); + static const char *const files[] = { + "A/romfs/x.bin", "B/atmosphere/contents/0100F2C0115B6000/romfs/x.bin", + "C/contents/0100F2C0115B6000/romfs/y.bin", "D/exefs/main.pchtxt", "E/exefs/subsdk9", "F/romfs/", + "G/romfs/z.bin", "G/exefs/1234.ips", "Ultra \xD0\x96/romfs/u.bin", + "H/romfs/h.bin", "H/exefs/subsdk9", "I/romfs/i.bin", "I/exefs/main", "J/cheats/0123456789ABCDEF.txt", + "K/romfslite/k.bin", "L/romfs/l.bin", "L/cheats/0123456789ABCDEF.txt", "L/exefs/main.npdm", + }; + for (size_t i = 0; i < sizeof files / sizeof *files; i++) put(root, files[i]); + + cfg_set("TOTK_MODS_DIR", root); + cfg_set("TOTK_MODS_ORDER", "B|A|Gone"); + cfg_set("TOTK_MODS_DISABLED", "C"); + mods_scan(); + + static const char *const order[] = {"B", "A", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "Ultra \xD0\x96"}; + enum { N = sizeof order / sizeof *order }; + CHECK(mods_count() == N, "thirteen mod folders"); + int in_order = mods_count() == N; + for (int i = 0; in_order && i < N; i++) in_order = EQ(mods_at(i)->name, order[i]); + CHECK(in_order, "order: mods_order first, the rest by name"); + if (mods_count() == N && in_order) { + ModInfo *a = mods_at(1), *b = mods_at(0), *c = mods_at(2), *d = mods_at(3), *e = mods_at(4), *f = mods_at(5), + *g = mods_at(6), *hm = mods_at(7), *im = mods_at(8), *jm = mods_at(9), *km = mods_at(10), + *lm = mods_at(11), *u = mods_at(12); + CHECK(hm->kind == (MOD_ROMFS | MOD_SUBSDK) && hm->problem == MOD_PLUGIN, "RomFS + subsdk plugin: unusable"); + CHECK(im->kind == (MOD_ROMFS | MOD_SUBSDK) && im->problem == MOD_PLUGIN, "RomFS + replaced exefs/main"); + CHECK(ends_with(b->romfs, "B/atmosphere/contents/0100F2C0115B6000/romfs"), "Atmosphere RomFS root"); + CHECK(ends_with(c->romfs, "C/contents/0100F2C0115B6000/romfs"), "contents RomFS root"); + CHECK(ends_with(a->romfs, "A/romfs") && a->kind == MOD_ROMFS && a->problem == MOD_OK, "plain RomFS mod"); + CHECK(!c->enabled && a->enabled && b->enabled && g->enabled && u->enabled, "mods_disabled switches C off"); + CHECK(d->kind == MOD_EXEFS && d->problem == MOD_EXEFS_LATER, "ExeFS patch mod"); + CHECK(e->problem == MOD_PLUGIN, "subsdk-only mod is a plugin mod"); + CHECK(f->problem == MOD_EMPTY, "empty RomFS folder"); + CHECK(g->kind == (MOD_ROMFS | MOD_EXEFS) && g->problem == MOD_EXEFS_LATER, "RomFS + ExeFS mod"); + CHECK(jm->kind == MOD_CHEATS && jm->problem == MOD_CHEATS_LATER && ends_with(jm->cheats, "J/cheats"), + "cheats-only mod"); + CHECK(km->kind == MOD_ROMFS && km->problem == MOD_OK && ends_with(km->romfs, "K/romfslite"), "TKMM romfslite"); + CHECK(lm->kind == (MOD_ROMFS | MOD_CHEATS) && lm->problem == MOD_OK, "RomFS + cheats, main.npdm is no code"); + CHECK(u->kind == MOD_ROMFS && ends_with(u->romfs, "Ultra \xD0\x96/romfs"), "Unicode folder name"); + CHECK(!mods_changed(), "nothing changed after the scan"); + + mods_move(1, -1); + CHECK(EQ(mods_at(0)->name, "A") && EQ(mods_at(1)->name, "B"), "move up"); + CHECK(EQ(cfg_get("TOTK_MODS_ORDER"), "A|B|C|D|E|F|G|H|I|J|K|L|Ultra \xD0\x96"), + "order written without the gone name"); + mods_move(0, -1); + CHECK(EQ(mods_at(0)->name, "A"), "move up at the top does nothing"); + mods_move(N - 1, 1); + CHECK(EQ(mods_at(N - 1)->name, "Ultra \xD0\x96"), "move down at the bottom does nothing"); + mods_set_enabled(2, 1); + const char *dis = cfg_get("TOTK_MODS_DISABLED"); + CHECK(mods_at(2)->enabled && (!dis || !*dis), "switching C on empties mods_disabled"); + mods_set_enabled(0, 0); + CHECK(EQ(cfg_get("TOTK_MODS_DISABLED"), "A"), "switching A off writes it"); + CHECK(mods_changed(), "changes seen"); + } + remove_tree(root); + printf("mods: %s\n", fails ? "FAIL" : "ok"); + return fails ? 1 : 0; +} diff --git a/totk.ini.example b/totk.ini.example index 9611a192..bb0065ed 100644 --- a/totk.ini.example +++ b/totk.ini.example @@ -278,8 +278,18 @@ # bind_X = pad:west, key:space # bind_Y = pad:north, key:mouse_l +[mods] +# Folder with the player's mods, one subfolder per mod (<name>/romfs, <name>/exefs, <name>/cheats). Default: mods next +# to totk.exe. +# mods_dir = +# Load order, top first, names separated by |. The in-game menu (Mods) writes it; a mod not listed goes to the bottom. +# mods_order = +# Mods switched off, names separated by |. +# mods_disabled = + [files] -# Folder with RomFS mod files that replace or add game files. Default: none. +# Developer overlay: a folder with RomFS files and a manifest.tsv (tools/make_romfs_patches.py format). Players put +# their mods into the mods folder instead ([mods]). Default: none. # romfs_mods = # Folder with the Switch shared fonts (BFTTF files, tools/extract_fonts.py output), for Chinese and Korean text. # Default: shared-fonts next to totk.exe. TOTK_SHARED_FONTS overrides it.