Short:        Replacement binaries for AB3D2
Uploader:     0x4badc4fe gmail com
Type:         game/patch
Version:      1.0
Architecture: m68k-amigaos >= 3.1

Replacement engine binaries for AB3D2 - The Killing Grounds, built from the
updated source at https://github.com/mheyer32/alienbreed3d2

The engine contains many bug fixes, performance improvements and additional
features. There are separately compiled binaries for 68030+, 68040 and 68060.

- 68030+ This version should work on any 68020-68060 configuration and still
  contains CPU specific optimisations for certain tasks, e.g. C2P conversion.
  Akiko is supported on compatible hardware. Code is tuned for 68030 which is
  considered the minimum viable specification.

- 68040 This version is tuned specifically for 68040 and drops any code
  specific to 68030. This version should work best on actual 68040 and JIT
  based emulations of it, e.g. Emu68 and UAE and AmiBerry.
  
- 68060 This version is tuned specifically for 68060 and drops any code
  specific to lower processors. Includes various drawing routine replacements
  optimised for superscalar execution on the CPU.

Simply replace your existing tkg binary with the one that is a best fit for
your system.

Changes

- Both AGA and RTG are supported. Under RTG, AGA is no longer a requirement
  and the game can be ran on ECS configurations provided they have a graphics
  card with a suitable 320x256, 320x240 or 320x200 mode. Note that 320x256 is
  recommended.
- Game runs system-friendly and can be safely exited back to Workbench.
- Player settings are saved on exit. These are stored in a text file that
  contains additional settings that cannot otherwise be set in-game.
- Default input mode is mouse + keyboard using a more modern WASD scheme. The
  original mouse input mode is available via the Custom Options menu.

Special Keys

- Esc exits the current level.
- Tab toggles automap overlay.
- F1 / F2 adjust the automap zoom level.
- F3  cycles audio modes.
- F4  toggles dynamic lighting effects.
- F6  toggles render quality.
- F7  cyles through frame rate caps.
- F8  toggles between full and simplified wall lighting.
- F9  toggles pixelmodes. Currenly only 1x1 and 1x2 are supported.
- F10 toggles between fullscreen and 2/3 screen mode.
- Numpad +/- adjust the vertical border size.
- Numpad * exits to the desktop (aka "ragequit" key)
- K enables keyboard only input
- M enables keyboard and mouse input. Repeated selection chooses between
  normal and inverted mouse mode.
- J enables joystick mode.

When the automap overlay is enabled:

- Numpad 5 centres on the player.
- Numpad 1/2/3/4/6/7/8/9 scroll the map in the implied direction.
- Numpad . (period) toggles between green and transparent overlay.

When the automap overlay is not enabled:
- Numpad 7/8/9 adjust gamma (7 decreases, 8 resets, 9 increases)
- Numpad 4/5/6 adjust contrast (4 decreases, 5 resets, 6 increases)
- Numpad 1/2/3 adjust black point (1 decreases, 2 resets, 3 increases)

Custom Options

The Custom Options menu includes the following features:

- Original Mouse uses the original Team17 mouse and keyboard input behaviour.
- Always Run enables run by default, run key slows to walking pace.
- Show FPS shows a small overlay showing the current FPS and frame cap.
- Disable Auto Aim disables automatic aiming for projectile weapons. When in
  use, a crosshair is shown.
  
Configuration File

All settings are persisted as plaintext in a file called prefs.cfg in the 
main game directory. If the file is not found, it will be created and is
written whenever the game is exited. Many of the settings in this file are
mirrors of the options that can be set in the options or chosen in-game. The
rest control the behaviour of internal changes and optimisations. For more,
see: https://github.com/mheyer32/alienbreed3d2/blob/main/docs/settings.md