Logo  

Home - Old Man Programmer

Displaying projects/Aq/README.md

Aq: The Mattel/Radofin Aquarius Emulator
========================================

Aq is an open source Mattel Aquarius emulator.  It provides a graphical
interface via SDL2 (see v0.1 for a curses-based interface, instead).  It
features a fairly complete cycle-exact Z80 emulator, which can also be run in
unlimited (turbo) mode.  It supports both built-in and expansion module sound
(including higher-level tape drive support) and expansion module game
controllers.  Turbo mode is both manually selectable and automatic for initial
BASIC file loads and tape operations.  It also comes with a few extras; BASIC
files are installed in `Aq/share/Aq/bas`, tapes in `Aq/share/Aq/tapes`, and ROMS
in `Aq/share/roms`:

 - All examples from the users' manual as BASIC text files and combined into a
   single tape file (`basic.tape`).
 - A number of expansion cartridge sound samples, in the form of BASIC files and
   combined into a single tape file (`sndtest.tape`).
 - An Extended BASIC ROM (`ebasic.bin`) which loads into the low Extended BASIC
   ROM slot.  Other cartridges can be loaded at the same time.  It has been
   verified to work with the QuickDisk ROM's Extended BASIC support.  It was
   generated by automatically disassembling the standard (high-loading) version
   combined with some hand-editing and re-assembly.
 - A sample ROM:  CamelForth/80-1.2 ported from CP/M to the Aquarius. It is
   available both as a ROM (`cam80-12.bin`) and a tape file (`cam80-12.tape`).
 - A sample ROM: ZexAll ported from CP/M to the Aquarius.  Unfortunately, this
   requires write access to the BASIC ROM area, which Aq secretly supports just
   for this ROM.  This is available both as a ROM (`zexall.bin`) and a tape file
   (`zexall.tape`).
 - Support for assembly language development for the Aquarius based around the
   [Small Device C compiler toolkit](http://sdcc.sourceforge.net), which may
   already be provided by your distribution.  This includes the tools `ihx2bin`
   and `asm2bas` as well as macros and symbols in `aquarius.mac` (in particular,
   a macro to easily create the magic ROM header).  This was used to build the
   provided ROMs and sound samples.
 - The HALT instruction stops the emulator.

There is also an optional GUI, based on either Qt or Dear ImGui.  The GUI adds a
menu, and allows run-time changes of tape and ROM files, and immediate pasting
of BASIC files.

While it might be possible for it to run on Windows or MacOS, it was developed
and tested only on Linux.  See CHANGES for a list of major changes.

See INSTALL.md for how to build and install Aq.

See the man pages for usage and configuration instructions.

See TODO.md for future plans.

Credits and License
-------------------

Original work, core emulator, and motivated self-interest (original Aquarius
owner): Steve Baker <steve.baker.llc@gmail.com>.  Sound, tape, game controller,
assembly language extras, cmake support, original Qt and Dear ImGui work, minor
fixes: Thomas J. Moore <darktjm@gmail.com>.

I have no idea what the license is.  While all code written by Thomas J. Moore
is in the Public Domain, as part of this project, it falls under the same
license as the rest of the code.