The Amiberry XML Builder - HoraceAndTheSpider/Amiberry-XML-Builder GitHub Wiki

About The Amiberry XML Builder

The Amiberry XML Builder is an automated tool which will routinely scan available Amiga WHDLoad Packs (Games) and pre-set various option which are to be used by the Amiga Emulator Amiberry to aid game compatibility; storing the end results in an output XML file.

If the above sounds like another language, or makes no sense, please leave this Wiki, and consider visiting https://github.com/midwan/amiberry/wiki to learn more about why this tool exists.

What is this GitHub for?

This GitHub exists to ensure that the host machine for this tool has a central repostiry for it's information, and to give Amiberry somewhere to download the latest XML.

It is intended to be a route for users to supply updated 'community led' proposed changes. However, to achieve this across over 3000+ supported games, information provided needs to be clear and concise.

I want to contribute, and supply game settings

There are only two acceptable ways to do this :

  1. Create a fork of you own for this repo, make the necessary changes, and create a 'pull' request for your changes. Providing there are no fundemental changes to the main Python script, these will be accepted.

  2. Create a single 'issue' for the specific game you wish the settings to be ammended for.

Acceptable ways to submit issues

Please read before posting any issues on this GitHub

There are certain rules which must be adhered to when posting proposed changes which will be applied to the repo and eventually filter to the XML. Faiulre to follow these will result in requests being ignored and eventually deleted.

  1. Post one issue per game please.

  2. Clearly identify the game, and version of the game you are working from

  • Supply the exact filename in use from the 'RetroPlay' packs
  • Supply from the existing XML the <subpath> tag for a shared name, which will allow the setting to be applied on future versions.
  • e.g. "Change requested for Bloodwych_v2.51_0439.lha , subpath: Bloodwych
  1. Clearly identify the changes to be made, and whether any existing settings should be removed.
  • e.g. "Current SCREEN WIDTH is set to 256 and this should be set to 262.
  1. State the reason for the change
  • e.g. "This fixes a screen issue and allows the menu to be viewed correctly"
  1. Do not provide an updated XML file or sections of the XML file.
⚠️ **GitHub.com Fallback** ⚠️