Short:        Hardware-accelerated GLQuake for ZZ9000
Author:       Xanxi (ZZ9000/XACP port), id Software (original Quake)
Uploader:     Xanxi - hassani hakim gmail com
Type:         game/shoot
Version:      1.0
Requires:     ZZ9000, XACP XX19d-RIX or later compatible XACP, Picasso96
Architecture: m68k-amigaos >= 3.0

ZZQuakeGL 1.0 - RasterIX-accelerated GLQuake for the MNT ZZ9000
=============================================================

ZZQuakeGL runs the original Quake / GLQuake engine on the ZZ9000 ARM
Cortex-A9 Core1, with 3D graphics accelerated by RasterIX in the FPGA.
The Amiga 68k launcher manages Picasso96, input, files and audio.
This is NOT a conventional 68060 MiniGL or Warp3D port.

REQUIRED FIRMWARE - IMPORTANT
-----------------------------
You MUST use XACP XX19d-RIX or later XACP firmware explicitly compatible
with the RasterIX interface, plus the matching
XACP-compatible Picasso96 zz9000.card driver.

ZZQuakeGL is NOT compatible with official MNT ZZ9000 firmware versions
1.0 through 1.13. It is NOT compatible with third-party BlitterStudio
ZZ9000 firmware or its corresponding driver.

Firmware XX19d-RIX (including matching XACP drivers):
https://github.com/Xanxi-Amiga/XACP-ZZ9000/releases/tag/XX19d-RIX

Do not mix firmware and zz9000.card from different firmware families.
The release was tested on an Amiga 4000/68060 and an Amiga 4000/68030 with a ZZ9000.

PERFORMANCE
-----------
Measured with timedemo demo1, A4000/68060 + ZZ9000, 16-bit Picasso96:

  320x240      106.5 FPS
  640x480       48.0 FPS
  800x600       35.2 FPS
  1024x768      24.1 FPS

All modes use RasterIX in the FPGA. Results refer to the tested system.

INSTALLATION
------------
Extract ZZQuakeGL.lha into its own drawer. Keep the launcher, Workbench
icon and four ARM Core1 blobs together:

  ZZQuakeGL          Amiga 68k launcher
  ZZQuakeGL.info     Workbench icon
  zzqgl.bin          640x480
  zzqgl_320.bin      320x240
  zzqgl_800.bin      800x600
  zzqgl_1024.bin     1024x768

Provide your own Quake game data in the id1/ directory:

  id1/pak0.pak       Quake shareware or registered data
  id1/pak1.pak       Additional file for the registered version

Quake game data, music and other commercial assets are not included.

WORKBENCH TOOLTYPES
-------------------
Select the ZZQuakeGL icon, choose Information from the Workbench Icons
menu, and edit its Tool Types. The included icon defaults to:

  640
  MUSIC=MP3
  MAXFPS=50

To change resolution, activate ONE of these ToolTypes:

  320       320x240
  640       640x480 (default)
  800       800x600
  1024      1024x768

Disable the other resolution ToolTypes using parentheses, for example
(640), and enable the desired resolution by removing its parentheses.
Other supported options include:

  DEPTH=16       16-bit Picasso96 output (default)
  DEPTH=32       Request 32-bit Picasso96 output
  MAXFPS=50      Frame-rate cap; set MAXFPS=0 to remove it
  MUSIC=MP3      Music from id1/music/track02.mp3, etc.
  MUSIC=MHI      Music using an MHI driver
  MUSIC=CD       Play CD audio (configure CDDEVICE and CDUNIT)
  MUSIC=NONE     Disable music

MP3 files should be encoded at no more than 128 kbps CBR.
Example Shell commands (options also work as ToolTypes):

  ZZQuakeGL
  ZZQuakeGL 320
  ZZQuakeGL 800 MUSIC=MP3
  ZZQuakeGL 1024 DEPTH=16 MAXFPS=50

LIMITATIONS
-----------
Version 1.0 supports the original Quake game (id1) only.
HIPNOTIC and ROGUE mission packs and custom mods selected with GAME=
are not supported. Use the original software-rendered ZZQuake instead.

SOURCES AND LICENCES
--------------------
The four ARM engine binaries are distributed under their applicable GPL
terms, with complete corresponding sources and offline build scripts
available on GitHub. The separate Amiga 68k launcher is freeware with
private sources; its binary is included in the archive.

GPL sources for this release:
https://github.com/Xanxi-Amiga/XACP-ZZ9000/releases/download/ZZQuakeGL-1.0/ZZQuakeGL_1.0_GPL_sources.zip

Project documentation:
https://github.com/Xanxi-Amiga/XACP-ZZ9000/tree/main/applications/games/ZZQuakeGL

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

Gameplay video:
https://youtu.be/cV312wjwoPc

Quake / GLQuake: id Software (GPL v2).
quakegeneric: erysdren (GPL v2).
RasterIX: ToNi3141.
ZZ9000 hardware: MNT Research.
ZZQuakeGL / XACP port: Xanxi (GPL contributions).
ZZGL and librixgpu: Xanxi (0BSD components).

Independent port, not affiliated with id Software or MNT Research.