WIP mod support by Vagabond · Pull Request #1313 · omf2097/openomf

Vagabond · 2025-09-22T23:42:16Z

Things to do:

Require a mod manifest in each zip file
Either do not load mods in netplay mode, or load only cosmetic changes (would require retaining original sprites for compatible collision detection)
Fix all the memory leaks
Support for replacing sound samples
Support for sprite information like collision coordinates, offsets and index reuse
Support for tournament pilot photos/logos to be higher resolution
Switch from file IDs to filenames (eg scene_id 8 -> "ARENA0", har_id 1 -> "FIGHTR1")
unify with https://www.omf2097.com/wiki/doku.php?id=openomf:openomf_mod_folder_structure

Depends on #1312 to properly display high-res assets.

src/resources/modmanager.h

src/resources/modmanager.c

src/utils/png_reader.c

src/game/common_defines.c

src/resources/modmanager.c

katajakasa · 2026-02-13T15:23:50Z

src/resources/modmanager.c

+                    unsigned long long entry_size = zip_entry_uncomp_size(zip);
+                    void *entry_buf = omf_calloc(entry_size, 1);
+                    if(zip_entry_noallocread(zip, entry_buf, entry_size) < 0) {
+                        log_warn("failed to load %s into memory", zip_entry_name(zip));


continue;

?

katajakasa · 2026-02-13T15:30:41Z

src/resources/modmanager.c

+    }
+
+    str filename;
+    str_from_format(&filename, "tournaments/%s/tournament.ini", tournament_name);


str_free() seems to be missing before the next call to str_from_format

katajakasa · 2026-02-13T15:31:59Z

src/resources/modmanager.c

+        // For arenas, check for 'common' for anim_ids 6 (round), 7 (number), 8 (you lose), 9 (you win), 10 (fight),
+        // 11 (ready), 24 (dust 1), 25 (dust 2), 26 (dust 3), 27 (match counters)
+
+        str_from_format(&filename, "scenes/common/%d/animdata.ini", anim_id);


matching str_free() missing

src/utils/png_reader.c

katajakasa · 2026-02-13T15:35:08Z

src/resources/af_loader.c


    // Convert
-    af_create(a, &tmp);
+    af_create(a, &tmp, &fn);


str_free(fn)

katajakasa · 2026-02-13T15:35:29Z

src/resources/bk_loader.c

+
    // Convert
-    bk_create(b, &tmp);
+    bk_create(b, &tmp, &fn);


str_free(fn)

katajakasa · 2026-02-13T15:35:38Z

src/audio/audio.c

+                unsigned char *buf;
+                size_t len;
+                // check the modmanager here for a music mod
+                path_stem(&music, &fn);


str_free(fn)

src/resources/modmanager.c

katajakasa · 2026-02-13T15:45:39Z

src/resources/modmanager.c

+#include <confuse.h>
+
+#define UPDATE_FIELD_INT(field_name, struct_field, new_value)                                                          \
+    if(new_value != 0 && struct_field != new_value) {                                                                  \


btw, I guess this means that mods cannot set field values intentionally to 0, ever ? Is that okay ?

Same for floats, I suppose

src/resources/modmanager.c

src/game/game_state.c

Vagabond · 2026-02-13T16:27:27Z

"Prevent most mod assets loading during netplay" -- most. What is allowed ?

music and arena backgrounds right now

src/resources/modmanager.c

src/audio/sources/opus_source.c

src/utils/png_reader.c

katajakasa reviewed Sep 22, 2025

View reviewed changes

src/resources/modmanager.h Show resolved Hide resolved

katajakasa reviewed Sep 23, 2025

View reviewed changes

src/resources/modmanager.h Outdated Show resolved Hide resolved

Nopey force-pushed the adt/mod-support branch from 38cfbe7 to c95cddd Compare September 23, 2025 01:31

Vagabond force-pushed the adt/mod-support branch from 49fe496 to b401e12 Compare September 23, 2025 18:35

katajakasa reviewed Sep 23, 2025

View reviewed changes

src/resources/modmanager.c Outdated Show resolved Hide resolved

katajakasa reviewed Sep 23, 2025

View reviewed changes

src/utils/png_reader.c Outdated Show resolved Hide resolved

Nopey reviewed Oct 10, 2025

View reviewed changes

src/game/common_defines.c Outdated Show resolved Hide resolved

Vagabond force-pushed the adt/mod-support branch from b50f862 to 7f414fd Compare October 11, 2025 20:53

Vagabond and others added 22 commits February 12, 2026 13:23

Import vendored zip library for mod loading

54484e6

WIP

9677023

Enumerate zip files in mod directories and their contents

d4928ea

Get background overrides working and make progress on sprites

21127f2

Support loading sprites from mods

fb7cb59

Support music mods

afa945b

Support multiple music remixes co-existing

ae15300

Allow selection of the music source (originals/remixes/both)

6356348

Support parsing bk/af animdata.ini and fighter header.ini from mods

215695b

Fix minizip build on Windows

ecc61b3

Fix clang-tidy issue and a leak

775498b

Try to fix another clang-tidy issue in miniz

0dc42c6

Handle "common" sprite loads and fix some naming to match wiki

77b8ebd

Add fallback "common" loads for AF/BK animdata

2c80b9a

Switch to filename, not id lookups, fix sprite load bug

b8dbd2d

Remove unused var

173d42b

Cleanup some leaks

d91ef7f

Try to fix #1317

0846c04

Improvements to mod loading

dd43f7e

Sort mods by load order and dedup by version

a04d4cf

WIP on tournament support

ddc5fc3

Fixes and clang-tidy issues

255de71

katajakasa reviewed Feb 13, 2026

View reviewed changes

src/resources/modmanager.c Outdated Show resolved Hide resolved

katajakasa reviewed Feb 13, 2026

View reviewed changes

src/utils/png_reader.c Show resolved Hide resolved

katajakasa reviewed Feb 13, 2026

View reviewed changes

src/resources/af_loader.c

// Convert

af_create(a, &tmp);

af_create(a, &tmp, &fn);

Copy link
Copy Markdown

Member

katajakasa Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

str_free(fn)

katajakasa reviewed Feb 13, 2026

View reviewed changes

src/resources/bk_loader.c

// Convert

bk_create(b, &tmp);

bk_create(b, &tmp, &fn);

Copy link
Copy Markdown

Member

katajakasa Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

str_free(fn)

katajakasa reviewed Feb 13, 2026

View reviewed changes

src/resources/modmanager.c Outdated Show resolved Hide resolved

katajakasa reviewed Feb 13, 2026

View reviewed changes

src/resources/modmanager.c Outdated Show resolved Hide resolved

katajakasa reviewed Feb 13, 2026

View reviewed changes

src/resources/modmanager.c Outdated Show resolved Hide resolved

katajakasa reviewed Feb 13, 2026

View reviewed changes

src/resources/modmanager.c Outdated Show resolved Hide resolved

katajakasa reviewed Feb 13, 2026

View reviewed changes

src/resources/modmanager.c Outdated Show resolved Hide resolved

katajakasa reviewed Feb 13, 2026

View reviewed changes

src/game/game_state.c Show resolved Hide resolved

Vagabond added 3 commits February 13, 2026 08:32

Some review comments

45cb6a9

More review comments

5c31ddb

More memory leak fixes from review

d0c9efb

katajakasa reviewed Mar 29, 2026

View reviewed changes

src/resources/modmanager.c Outdated Show resolved Hide resolved

katajakasa reviewed Mar 29, 2026

View reviewed changes

src/resources/modmanager.c Outdated Show resolved Hide resolved

katajakasa reviewed Mar 29, 2026

View reviewed changes

src/resources/modmanager.c Outdated Show resolved Hide resolved

katajakasa reviewed Mar 29, 2026

View reviewed changes

src/resources/modmanager.c Outdated Show resolved Hide resolved

katajakasa reviewed Mar 29, 2026

View reviewed changes

src/audio/sources/opus_source.c Show resolved Hide resolved

katajakasa reviewed Mar 29, 2026

View reviewed changes

src/utils/png_reader.c Outdated Show resolved Hide resolved

Vagabond added 4 commits March 29, 2026 20:13

Parse hit coordinates and sprite origin from hitcoord.png

c13290c

free -> omf_free

60997d4

add rb_free

fa9576e

Fix signature of fallback function def

7c2df61

Vagabond force-pushed the adt/mod-support branch from 690eeee to 7c2df61 Compare March 30, 2026 03:26

Conversation

Vagabond commented Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Vagabond commented Feb 13, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Vagabond commented Sep 22, 2025 •

edited

Loading