djhackersdev / bemanitools

Runs recent Konami arcade games and emulates various arcade hardware.
The Unlicense
77 stars 15 forks source link

"New" launcher, bootstrap.xml compatible #277

Open icex2 opened 5 months ago

icex2 commented 5 months ago

Fundamentally re-think how launcher operates and bootstrapping the games is managed and configured.

This brings it significantly closer to how the original bootstrap is doing the job: launcher now utilizes the data (structures) provided by the bootstrap.xml configuration file. This creates compatibility with vanilla data dumps and original stock images. Note that bemanitools does not include any code or means to run DRM'd data, only decrypted.

But, this allows users to keep decrypted dumps as stock as possible which means:

A list of key features of the "new" launcher:

Move everything to new launcher.xml configuration files. Adjust the bootstrapping of launcher in the .bat files. Features such as copying the default props/ files to nvram are now handled by launcher.

Using the PATH variable, bemanitools binaries can live in their own dedicated bemanitools/ subfolder next to props/ and modules/ now. All original binaries are expected to be kept in a modules/ folder like on stock data.

Due to the significant architectural changes, this also breaks with any backwards compatibility to existing launcher setups. Thus, users need to migrate by re-applying the new configuration format and migrating their config parameters accordingly.

Further migration instructions and updated documentation will be provided upon release.

icex2 commented 5 months ago

Remark: This is currently not rebased to https://github.com/djhackersdev/bemanitools/pull/278 which is pre-work required for the major refactoring. Just the last two commits account for the actual refactoring work relevant in this PR. I will rebase accordingly to clean-up the history once https://github.com/djhackersdev/bemanitools/pull/278 is merged.

icex2 commented 5 months ago

These are still open TODOs and feedback that are not addressed by this PR but will be followed-up to once this is merged.