Additional Info

As is stated numerous times around this repository, the assets are not included in this repository. It is up to the user to find the original v1.0.0 release of the game and provide their own assets.

With that said, some assets have been updated. To avoid providing the assets directly, updated assets are handled with xdelta3 patches. I have created a migration tool to update the v1.0.0 assets to the latest versions. It will copy the assets from the "assets_original" folder to the source code folder of the game "ladxhd_game_source_code". If a patch is found in the "assets_patches" folder that matches the name of the file being copied, it will instead apply the patch to file and create it in the source code directory. The migration tool can also scan both the original and modified assets, hash the files, detect differences, and create new patches from any modified assets.

Basically, the migration tool handles all modifications to the assets file. Once the original 1.0.0 assets have been added to the "assets_original", they should be kept to retain the ability to create new patches if you decide you want to modify these assets. When submitting a PR of modified assets, instead of uploading the assets directly, submit the xdelta3 patch that modifies that asset.

At any time a new patch is created, a user currently modifying the game can download the patch, copy it to their "assets_patches" folder, and click the "Migrate Assets From v1.0.0" button to update their assets to the latest versions. This is the reason to keep the v1.0.0 assets around. Any patches created should be created from the v1.0.0 assets so there is a static source to work from. Creating patches from modified assets would create issues down the road.

I am hoping this system makes modifying assets as painless as possible. The unfortunate reality is we can not be sharing the copyrighted assets without worrying about incurring the wrath of the big N. Hopefully this method will keep this project in the clear, as xdelta patches are just useless data on their own, and have been used to update ROMs for years.