Merge pull request #156 from NotAkitake/omnifix

datamods: Omnifix and minor changes
This commit is contained in:
auxbh 2025-09-24 14:45:05 +02:00 committed by GitHub
commit 0550dfca39
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,6 +1,6 @@
!!! info "Synopsis"
This guide will cover how to mod your BEMANI game's data folder in a non-destructive way.
This guide will cover how to mod your KONAMI game's data folder in a non-destructive way.
No files will be removed or overwritten.
## Pre-requisites
@ -14,24 +14,20 @@
- Please make sure the mod you're installing is **compatible with YOUR specific game and game version**
- If connecting to an **online network**, make sure they **explicitly allow** the mod you're about to install
- TWO-TORIAL will **NOT** provide support with issues caused by mods besides **Omnimix** for beatmania IIDX
## Preparing data_mods
## Installing mod files
!!! tip ""
Let's place your mod files in the right folder.
- Create a `data_mods` folder next to the others in your game files
- Create a `data_mods` folder next to the others in your game files if it doesn't exist
<img src="/img/extras/datamods/1.webp">
Depending on how your mod is packaged, you may or may not need to create another folder to contain it.
Inside that folder, the structure should follow the one in `data/`.
- Place your mod files inside data_mods in a way that respects the following structure
`data_mods/mod_folder/<data folders/<data_files>`
- Place your files inside that `data_mods/mod_folder/`
If you're confused, the following may help you understand what this means.
You can think of the mod folder coming to overwrite your game's data folder at runtime.
If you're confused, the following may help you understand what we mean.
``` hl_lines="6-11"
📂data
@ -58,13 +54,12 @@
**Directory**: `contents/data_mods/omnimix_31`
<img src="/img/extras/datamods/3.webp">
## Loading data_mods
### Installing ifs_layeredfs
## Loading mods data files (ifs_layeredfs)
!!! tip ""
We now need a way for our game to load our mods.
Overwriting game files with mods is heavily discouraged, as there is no clean way of undoing that.
This is where ifs_layeredfs comes in, to load modded data files without permanently modifying your game data.
- Download the most recent release of [ifs_layeredfs](https://github.com/mon/ifs_layeredfs/releases/)
@ -74,8 +69,6 @@
<img src="/img/extras/datamods/5.webp">
What we're interested in are the `64bit` and `32bit` folders:
- Your game is 32bit *(spice.exe to launch)*: go in the `32bit` folder
- Your game is 64bit *(spice64.exe to launch)*: go in the `64bit` folder
@ -85,25 +78,40 @@
<img src="/img/extras/datamods/7.webp">
### Loading ifs_layeredfs
Follow the [Injecting DLL Hooks](#injecting-dll-hooks) section to load this DLL.
## Installing Omnifix (for IIDX Omnimix only)
!!! info "Compatibility"
[Supported game versions](https://github.com/aixxe/omnifix?tab=readme-ov-file#compatibility)
For unsupported game versions, you'll have to patch Omnimix with [spice2x](patchsp2x.md) or [web](patchweb.md) patching.
!!! tip ""
All that should be left to do is tell spice2x to load `ifs_hook.dll`.
Omnimix files require modification of your game DLL which can't be handled by ifs_layeredfs.
This is where Omnifix comes in, as a commonly agreed upon way of loading Omnimix for beatmania IIDX.
- Download the latest release archive for [omnifix](https://github.com/aixxe/omnifix/releases/) much like you did with ifs_layeredfs
- Extract the `omnifix.dll` file contained in the archive to your game's `modules` folder
Follow the [Injecting DLL Hooks](#injecting-dll-hooks) section to load this DLL.
Note that Omnifix also offers optional [launch parameters](https://github.com/aixxe/omnifix?tab=readme-ov-file#options) you may want to consider.
## Injecting DLL Hooks
!!! tip ""
Adding DLL files to your modules folder won't necessarily make them load automatically.
You sometimes need to tell spice2x to load each file individually, like with the DLLs mentioned in this guide.
- Open your game's `spicecfg.exe`
- Head to the `options` tab
- Find the `Inject DLL Hooks` option under `Common` and type in `ifs_hook.dll` then press Enter
- Find the `Inject DLL Hooks` option under `Common`
- Add the name of the DLL file(s) you want to load inside the text box
Note: If you have other DLL hooks, simply add more by having a space in between them..
Example: `ifs_hook.dll somehook.dll`
Example: `ifs_hook.dll omnifix.dll`
Note: You may list one or multiple DLL files separated by a space.
<img src="/img/extras/datamods/8.webp">
Assuming your `data_mods` folder has been made properly, that's it!
!!! danger "Extra step for beatmania IIDX Omnimix"
You also need to patch your game's DLL with the `Omnimix` patch.
For more information on how to patch your game, head over to the [spice2x Patching](/extras/patchsp2x.md) page!
<img src="/img/extras/datamods/8.webp">