WHDLoad Auto booting

dudleydes edited this page Sep 1, 2018 · 20 revisions

The WHDLoad AutoBooter is designed to allow games/demos installed via the WHDLoad system (www.whdload.de) to be loaded by Amiberry in a single-file format (e.g. a .ZIP or .LHA archive). The file should be specified from command line with the option -autowhdload=<file>


Emulator Requirements

The following archive should exist adjacent to the Amiberry binary file: (These folders/files are provided with Amiberry)

  • whdboot/boot-data.zip must contain the Amiga WHDLoad Booter program.

However, an unpacked whdboot/boot-data folder may also be used.

The following directories must exist:

  • whdboot/game-data must contain game specific data which can improve the compatibility of an individual game.

  • whdboot/save-data will contain game specific written information. this should contain the following sub-folders, which can be empty by default;

    • Autoboots (Will be written to by the Booter)
    • Debugs (Will be written to by the Booter)
    • Savegames (Will be written to by WHDLoad)
    • Kickstarts (Symlinks will be created here - see below)

How it Works:

The booter will automatically mount the HD booter and the game data to the emulated system for easy loading. It will also attempt to select appropriate settings for the game, based on the information available.

The WHDLoad booter uses an A1200 Kickstart 3.1 rom and will search for availability of this rom in the kickstarts path already selected on previous ROM scanning. This is essential for the booter to work.

Where a game requires a slower CPU (e.g. 68000) the A600HD Kickstart 2.05 rom will be searched for and used if available, otherwise the system will revert to a 68020 ECS setup.



A note on WHDLoad Kickstart files (Maximising Booter Compatibility)

Some WHDLoad games require Kickstart files to be made available in Devs:Kickstarts\. These files should either be manually copied save-data/Kickstarts, or otherwise Amiberry will attempt to make 'symlinks'to these files if they are already available in the Kickstart paths location.

For maximum compatibility it is recommended to have the following files, located in the position pointed to by the 'kickstart path' value, which can be set via the Paths panel.

Should you wish to create actual copies of these in Devs/Kickstarts, the renamed name is also stated below.

  • Kickstart v1.2 rev 33.180 (1986)(Commodore)(A500-A1000-A2000).rom - named: kick33180.A500
  • Kickstart v1.3 rev 34.5 (1987)(Commodore)(A500-A1000-A2000-CDTV) - named: kick34005.A500
  • Kickstart v3.1 rev 40.68 (1993)(Commodore)(A1200).rom - named: kick40068.A1200

The full list of compatibile / symlinked Kickstart files is detailed in the Kickstart ROMS (BIOS) section of this Wiki.



Game Specific Settings (Improving Game Compatibility)

The preferences from an individual game can be loaded in one of two ways;

  • From the whdload_db.xml file
  • From a file named equivalent to the selected file, with the extension changed to .whd e.g. Infection_v1.0.whd would accompany booting of the file Infection_v1.0.lha

The .whd file should be placed in the same location as the whdload_db.xml file.

If available, the .whd file will act as the source for hardware settings, and will take priority over the XML settings. However, this is not stored in the standard .uae file format and is instead specified using the following format;

;PRIMARY_CONTROL=MOUSE/JOYSTICK
;PORT0=MOUSE/JOY/CD32
;PORT1=MOUSE/JOY/CD32
;FAST_COPPER=TRUE
;CPU=68000/68010/68020/68040
;BLITTER=NORMAL/WAIT/IMMEDIATE
;CHIPSET=OCS/ECS/AGA
;JIT=TRUE
;CPU_COMPATIBLE=TRUE
;SCREEN_HEIGHT=216
;SCREEN_Y_OFFSET=10
;LINE_DOUBLING=TRUE
;NTSC=TRUE
;SPRITES=NONE/PLAYFIELD/SPRITES/FULL
;FAST_RAM=1/2/4/8
;Z3_RAM=16/32/64/128
;CLOCK=7/14/28/MAX

Note: the above values are all commented out using the ; character in from of each line!

This layout is also used in the <hardware> tag within the XML file. The XML file can also contain an identifier for games packages using it's SHA1 value and custom control options within the <custom_controls> tag. The latter follows the Amiberry .uae options format. E.g. joyport2_amiberry_custom_none_south=Right Shift

When loading a game, if an equivalent .uae config file for the game is found in the Configurations Path, this (and only this) will be used for the game's individual preferences. This allows the user to create bespoke configurations for individual games, which will not be erased when updating the XML/Database files.



Host Specific Settings (The User's Specific Requirments)

In the file whdboot/hostprefs.conf you can specify a number of options to be used as the defaults when running a game in this way. These relate to general Amiberry settings. These are generally used to decide what controller or non-game specific settings you would like applied to the game on loading. Examples are given (although commented out) in the provided file.

;CONTROLLER_1=joy1
;CONTROLLER_2=joy2
;CONTROLLER_3=joy0
;CONTROLLER_4=joy3
;CONTROLLER_MOUSE_1=joy2
;CONTROLLER_MOUSE_2=joy1
;RETROARCH_QUIT=TRUE
;RETROARCH_MENU=TRUE
;RETROARCH_RESET=TRUE
;KEY_FOR_QUIT=F12
;KEY_FOR_MENU=F11
;DEADZONE=33
;STEREO_SPLIT=1
;SOUND_ON=FALSE
;ASPECT_RATIO_FIX=TRUE
;FRAMESKIP=TRUE
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.