Short:        Quake using ZZ9000 ARM coprocessor
Author:       Xanxi
Uploader:     Xanxi - hassani hakim gmail com
Type:         game/shoot
Version:      1.0
Requires:     68020+ Amiga; MNT ZZ9000; firmware XX19b / XACP v1.7; Picasso96; original Quake PAK data
Architecture: m68k-amigaos

ZZQuake 1.0
============

ZZQuake runs the original Quake engine and software renderer on the second
ARM Cortex-A9 core of the MNT ZZ9000 through XACP. AmigaOS handles the
launcher, Picasso96 display, input, file access and audio integration.

This first public release targets 320x240 in 32-bit RTG mode.

IMPORTANT - FIRMWARE REQUIREMENT
--------------------------------

COMPATIBILITY
-------------

ZZQuake 1.0 requires the XACP firmware branch and was validated with
XX19b / XACP v1.7.

It is not compatible with the official MNT firmware 1.13 or with
BlitterStudio firmware builds.

Use the XX19b / XACP v1.7 firmware provided with the XACP-ZZ9000 project 
or any later XACP firmware revision.

INSTALLATION
------------

Copy the complete ZZQuake directory to your hard disk.

Place your own Quake data files in:

    ZZQuake/id1/

Shareware Quake:

    id1/pak0.pak

Registered Quake:

    id1/pak0.pak
    id1/pak1.pak

Quake game data is not included.

OFFICIAL MISSION PACKS
----------------------

Quake Mission Pack No. 1: Scourge of Armagon
(Hipnotic Interactive)

Place its data in:

    hipnotic/pak0.pak

Launch with:

    ZZQuake HIPNOTIC

or enable the HIPNOTIC Workbench ToolType.


Quake Mission Pack No. 2: Dissolution of Eternity
(Rogue Entertainment)

Place its data in:

    rogue/pak0.pak

Launch with:

    ZZQuake ROGUE

or enable the ROGUE Workbench ToolType.

Other Quake mods can be selected with GAME=name.

MUSIC
-----

ZZQuake provides three mutually exclusive music backends:

MUSIC=MP3
    Uses the native XACP MP3 decoding pipeline on the ZZ9000 ARM.

MUSIC=MHI
    Uses an external MHI-compatible decoder.

MUSIC=CD
    Plays audio tracks from a physical Quake CD.

MP3 replacement tracks are stored in:

    id1/music/

using names such as:

    track02.mp3
    track03.mp3
    track04.mp3
    ...

For both MUSIC=MP3 and MUSIC=MHI, 128 kbit/s CBR MP3 files are recommended
for best playback stability.

SOURCE AND LICENSING
--------------------

The ARM Core1 engine in zzquake.bin is derived from GPL-licensed Quake /
quakegeneric source.

Complete corresponding source for the GPL-covered ARM component is available
in the public repository under:

    applications/games/ZZQuake/source/arm/

The published source rebuilds the released ARM blob bit-identically.

The Amiga 68k launcher is a separate proprietary freeware component.

No Quake PAK files, music or commercial game assets are distributed with
ZZQuake.

PROJECT AND RELEASE
-------------------

ZZQuake 1.0 release:
https://github.com/Xanxi-Amiga/XACP-ZZ9000/releases/tag/ZZQuake-1.0

Project and source:
https://github.com/Xanxi-Amiga/XACP-ZZ9000/tree/main/applications/games/ZZQuake

ZZQuake / XACP port: Xanxi, 2026.