User Tools

Site Tools


openomf:openomf_mod_folder_structure

This loosely defined structure is intended to support the overarching inclusion of all expected mod data. Any given mod will adhere to the structure provided below. The intent is for a mod to replace the existing assets within the game, with the future possibility to expand upon the current assets/feature set within the game in the future.

<mod root folder>/
└── <mod name>.zip/
    ├── arenas/
    │   ├── common/
    │   │   ├── animation/
    │   │   │   └── <animation id>/
    │   │   │       ├── <animation id>_<sprite id>.png
    │   │   │       └── <animation id>_animdata.ini - optional if replacing original assets
    │   │   └── audio/
    │   │       └── sounds/
    │   │           └── <audio #>_<audio id>.[opus|.ogg]
    │   └── <arena#>/
    │       ├── palettes/
    │       │   └── <#>.png - single pixel image containing arena palette.  Multiple palettes are allowed.
    │       ├── background/
    │       │   └── background.png
    │       ├── animation/
    │       │       ├── <animation id>_<sprite id>.png
    │       │       └── <animation id>_animdata.ini  - optional if just replacing original sprites
    │       └── audio/
    │           ├── sounds/
    │           │   └── <audio #>_<audio id>.[opus|ogg]
    │           └── music/
    │               └── <#>.[opus|ogg]
    ├── fighters/
    │   ├── common/
    │   │   ├── animation/
    │   │   │   └── <animation id>/
    │   │   │       ├── <animation id>_<sprite id>.png
    │   │   │       └── <animation id>_animdata.ini  - optional if just replacing original sprites
    │   │   └── audio/
    │   │       └── sounds/
    │   │           └── <audio #>_<audio id>.[opus|.ogg]
    │   └── <fighter#>/
    │       ├── animation/
    │       │   └── <animation id>/
    │       │       ├── <animation id>_<sprite id>.png
    │       │       └── <animation id>_animdata.ini  - optional if just replacing original sprites
    │       ├── attributes/
    │       │   ├── header.ini - optional if just replacing original sprites
    │       │   └── catalog.ini - optional if just replacing original sprites
    │       └── audio/
    │           └── sounds/
    │               └── <audio #>_<audio id>.[opus|ogg]
    ├── tournaments/
    │   ├── legacy/
    │   │   └── <tournament name>.trn - only for compiled/legacy tournaments. Will not overwrite default tournaments.
    │   └── <tournament name>/
    │       ├── palettes/
    │       │   └── 0.png - single pixel palette for tournament
    │       ├── logo/
    │       │   └── logo.png
    │       ├── pilots/
    │       │   └── <pilot id>/
    │       │       ├── <pilot id>.png
    │       │       └── <pilot id>_info.ini - contains pilot metadata; optional if just replacing original sprites
    │       └── dialog/
    │           └── <local id>/
    │               └── <local id>_metadata.ini - contains tournament victory info, pilot dialog, etc; optional if just replacing original sprites
    └── audio/
        └── common/
            ├── sounds/
            │   └── <audio #>_<audio id>.wav
            └── music/
                └── <#>.[opus|ogg] - menu music? other?
openomf/openomf_mod_folder_structure.txt · Last modified: 2025/03/28 22:34 by malfrex