Short:        Doom port for MNT ZZ9000 ARM Core1
Author:       Hakim Hassani / Xanxi
Uploader:     Hakim Hassani <hassani hakim gmail com>
Type:         game/shoot
Version:      1.1
Requires:     MNT ZZ9000, XX18c XACP firmware, Picasso96, AHI, camd.library
Architecture: m68k-amigaos >= 3.0

ZZDoom is a doomgeneric-based Doom port for Amiga systems equipped
with the MNT ZZ9000.

This is not a normal 68k Doom port. The Doom engine runs on the
ZZ9000 ARM Core1, while AmigaOS handles RTG display, input, AHI sound,
CAMD music, file access and savegames.

Version 1.1

This release is mainly a compatibility and input update.

Changes since version 1.0:

* Fixed `OpenScreen failed` on systems using recent Individual Computers
  Picasso96 versions.
  * Some newer P96 setups rejected the previous strict `OpenScreenTags()`
    call.
  * ZZDoom now uses a more compatible screen opening path while keeping the
    ZZ9000 RTG framebuffer / deferred PAN rendering model.

* Mouse pointer is now hidden while playing.

* Mouse controls have been improved.
  * Mouse button handling has been changed to avoid stuck buttons.
  * Left mouse button now works reliably as fire.
  * Right mouse button now works reliably for strafe.
  * The mouse button path now uses the same reliable input logic as the
    keyboard controls.

* General launcher-side robustness improvements.
  * No change to the Doom WAD format.
  * No change to savegame format.
  * No change to AHI sound effects.
  * No change to CAMD MIDI music support.
  * No change to the ARM Core1 Doom engine.

Important firmware note:

ZZDoom still requires a matching XACP-compatible ZZ9000 firmware and
`zz9000.card`.

Do not mix `BOOT.BIN`, `zz9000.card` and ZZDoom executables from different
packages. A mismatched set may boot but fail at runtime, show display
glitches, or fail to open the RTG screen.

The matching firmware/card package can be downloaded here:

```
https://github.com/Xanxi-Amiga/XACP-V1/releases/tag/XX19_firmware

```


Features:

* ZZ9000 ARM Core1 Doom engine
* fullscreen 4:3 RTG display
* deferred PAN page flipping
* low 68k CPU usage
* AHI sound effects
* CAMD music support for external MIDI synths
* future ZZMIDI releases will allow internal SoundFont-based music
  playback
* save/load through PROGDIR:
* six save slots
* ZZDoom320 and ZZDoom640 executables
* ZZDoom320 can be combined with ZZScanlinesV2 for optional scanlines

Usage from Shell:

ZZDoom320 DOOM.WAD

or:

ZZDoom640 DOOM.WAD

Workbench launch is also supported. Put the WAD in the same directory
as the executable and set the icon ToolType:

WAD=DOOM.WAD

Supported WADs for this first release must be below 16 MB:

DOOM1.WAD   Shareware Doom
DOOM.WAD    Registered / complete Doom
DOOMU.WAD   Ultimate Doom
DOOM2.WAD   Doom II

No commercial WAD is included. You must provide your own legal Doom WAD.

Known limitations:

* WAD size is currently limited to less than 16 MB.
* Doom II is playable, but there is currently a known rendering issue
  affecting some floor textures on some setups. This will be investigated
  in a later version.
* Final Doom / Plutonia / TNT are not yet supported.
* Music currently uses CAMD with an external MIDI synth, or can be
  disabled.
* Internal ZZMIDI / SoundFont music support is planned and will be
  compatible with ZZDoom.


Important firmware note:

ZZDoom requires an XACP-compatible ZZ9000 firmware with Core1 launch,
shared DDR communication and deferred PAN support.

Currently supported:

* Xanxi XACP branch XX18c or later
* the matching zz9000.card supplied with the XX18c package
* any later firmware explicitly marked as XACP / ZZDoom compatible

Not supported:

* standard MNT firmware 1.0 to 1.13
* BlitterStudio / MidWan firmwares 2.0, 2.1, 2.2
* any zz9000.card / firmware combination that does not include the
  required XACP and deferred PAN features

Do not mix BOOT.BIN, zz9000.card and ZZDoom executables from different
packages. ZZDoom fullscreen output relies on a matched deferred-PAN
implementation. Mixed versions may boot and run but can show severe
screen tearing or refresh glitches.

This is not a criticism of other firmware branches. ZZDoom simply relies
on additional low-level Core1 and deferred-PAN features that are not part
of the standard ZZ9000 firmware interface.

This Aminet upload does not include the required ZZ9000 firmware. Please
check GitHub for the latest release package, firmware, documentation,
updates and additional technical details:

https://github.com/Xanxi-Amiga

This release is provided as a binary technical preview. The source
code and additional technical documentation are being cleaned up and will
be published in a later update.