Leahnaya/ifs_layeredfs
1
0
Fork 0
mirror of https://github.com/mon/ifs_layeredfs.git synced 2026-04-25 15:57:45 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

2.0 BETA

Browse Source
This commit is contained in:
Will Toohey 2020-07-29 21:59:37 +10:00
parent ef9e14722a
commit 9477105226
2 changed files with 58 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
data_mods/MOD_README.txt
View File

@ -1,59 +1,57 @@
IFS LayeredFS will search every directory in this folder for modded files to use.
Search order
Alphabetical via mod folder name
The first folder with a matching mod will be used for that file
This is done on a per-file basis
If two mods change the same IFS but different images, there are no conflicts
EXAMPLE:
data_mods/Boltex/test_ifs/logo.png
data_mods/Loltex/test_ifs/logo.png
data_mods/Loltex/test_ifs/title.png
Game asks for logo image : Boltex used
Game asks for title image: Loltex used
Folder structure
Mods get their own folder, eg "english" or "custom_songs"
The structure inside that folder is identical to the "data" folder
Any files that exist here will be used instead
Special case: IFS files and their textures
IFS file contents can be modded by replacing ".ifs" with "_ifs" and creating a folder
Most textures live inside the "tex" folder eg "somefile_ifs/tex/image.png"
You can just use "somefile_ifs/image.png" for neater folders
Replacement images must match the dimensions of the image they are replacing
If not, the error is logged and the image is not used
Images that do not exist in the original IFS will be added to its texture list
This is especially useful for preview jackets
Special case: IFS files that do not exist
IFS LayeredFS cannot create IFS files out of nothing
Either use a packed ".ifs", or modify an existing file with "_ifs"
Special case: XML files
XML files with the same name as the default will be used normally
XML files that end in ".merged.xml" instead of ".xml" will be merged into the default
eg: music_db.merged.xml
Merged files must have valid structure (<?xml ... ?> header and single root)
eg: music_db.merged.xml must have the "<mdb>" root element
The _cache folder
Any files that are adjusted are placed into the _cache folder for redirection
It can be deleted at any time
Textures are compressed as they are loaded for the first time
First launch compression of textures may slow down first launch a little
Beatstream is annoying
There is a data2 folder alongside data
For now, if you want to mod data2, use this folder structure
data_mods/
my_bst_mod/
graphic/
some_mod_for_data
data2/
graphic/
some_mod_for_data2
I am aware this is not ideal.
If you really hate it, get in touch and I might upgrade the code
IFS LayeredFS will search every directory in this folder for modded files to use.
Search order
Alphabetical via mod folder name
The first folder with a matching mod will be used for that file
This is done on a per-file basis
If two mods change the same IFS but different images, there are no conflicts
EXAMPLE:
data_mods/Boltex/test_ifs/logo.png
data_mods/Loltex/test_ifs/logo.png
data_mods/Loltex/test_ifs/title.png
Game asks for logo image : Boltex used
Game asks for title image: Loltex used
Folder structure
Mods get their own folder, eg "english" or "custom_songs"
The structure inside that folder is identical to the "data" folder
Any files that exist here will be used instead
Special case: IFS files and their textures
IFS file contents can be modded by replacing ".ifs" with "_ifs" and creating a folder
Most textures live inside the "tex" folder eg "somefile_ifs/tex/image.png"
You can just use "somefile_ifs/image.png" for neater folders
Replacement images must match the dimensions of the image they are replacing
If not, the error is logged and the image is not used
Images that do not exist in the original IFS will be added to its texture list
This is especially useful for preview jackets
Special case: IFS files that do not exist
IFS LayeredFS cannot create IFS files out of nothing
Either use a packed ".ifs", or modify an existing file with "_ifs"
Special case: XML files
XML files with the same name as the default will be used normally
XML files that end in ".merged.xml" instead of ".xml" will be merged into the default
eg: music_db.merged.xml
Merged files must have valid structure (<?xml ... ?> header and single root)
eg: music_db.merged.xml must have the "<mdb>" root element
The _cache folder
Any files that are adjusted are placed into the _cache folder for redirection
It can be deleted at any time
Textures are compressed as they are loaded for the first time
First launch compression of textures may slow down first launch a little
Mods that don't live in data/
Some games (Beatstream, Nostalgia) have extra data folders (data2, data_op2)
These subfolders must exist in the mod folder if you want to mod them.
For example, for a Beatstream mod using data2:
data_mods/
my_cool_mod/
graphic/
some_mod_for_data
data2/
graphic/
some_mod_for_data2

2
layeredfs/hook.cpp
View File

@ -36,7 +36,7 @@ using std::string;
#undef max
#undef min
#define VER_STRING "2.0"
#define VER_STRING "2.0_BETA"
#ifdef _DEBUG
#define DBG_VER_STRING "_DEBUG"