diff --git a/Asset-overrides.md b/Asset-overrides.md new file mode 100644 index 0000000..6aabb16 --- /dev/null +++ b/Asset-overrides.md @@ -0,0 +1,29 @@ +**You should never commit dumped assets to a git repository. This will get you in severe legal trouble!** + +If you tried to commit an asset and were sent to this page, please read it carefully. + +# The asset stack + +Instead, configure supports a feature we call the "asset stack". + +For example, say we wanted to override the asset `assets/us/bgm/Angry_Bowser_67.bin`. +We can do this by: +1. Modifying `ver/us/splat.yaml`'s `asset_stack` field to add "override" above "us": +```diff + asset_stack: ++ - override + - us +``` +2. Placing our replacement asset for the Angry Bowser song at `assets/override/bgm/Angry_Bowser_67.bin`. + +The `assets/override/` directory won't be gitignored, so you can commit it as normal. +This enables you to modify assets without committing any dumped assets. + +You can even have more folders in the asset stacks for different 'features' of a mod, for example: +``` +asset_stack: + - cool_texture_pack + - red_goombario + - us +``` +This will use assets from `assets/cool_texture_pack/...`, then, if an asset can't be found there, it will fall back to `red_goombario`, and then finally vanilla assets will be used. \ No newline at end of file