Short:        Matrix Storm 3D saver for PiStorm3D
Author:       Aleksandar Vojnic (rtyp3r@yahoo.com)
Uploader:     rtyp3r yahoo com (Aleksandar Vojnic)
Type:         util/blank
Version:      0.1
Requires:     PiStorm + Raspberry Pi 4, PiStorm3D MiniGL 29.1, RTG, MUI 3.8
Architecture: m68k-amigaos >= 3.0.0
Distribution: Aminet

===========================================================================
                          MATRIX STORM 3D  v0.1
         Layered 3D "digital rain" screensaver for AmigaOS 3
===========================================================================

Matrix Storm is a 3D screensaver in the style of the falling green code from
"The Matrix", drawn with real 3D hardware through MiniGL. On a PiStorm with
PiStorm3D it runs at a steady 60 fps at 1280x720 with every effect on.

It comes with an installer, a live settings panel (press F1 while it runs),
a MUI settings editor, and a commodity that starts it when the computer is
idle - and stays out of the way of games and demos.


SUPPORTED HARDWARE - PLEASE READ
--------------------------------

Matrix Storm is only for a PiStorm with a Raspberry Pi 4 and the PiStorm3D
MiniGL drivers, and has only been tested there. It is not supported on
classic Amigas, accelerator cards or other Warp3D/MiniGL graphics cards.
Raspberry Pi 3 support is planned.


FEATURES
--------

  * Up to 16 depth layers of falling glyphs with parallax and fog.
  * Fixed (stepping) trails that type characters into a grid and fade like
    phosphor, or classic sliding trails. Four colour schemes.
  * The red and white Amiga Boing Ball bouncing through the rain.
  * Retro TV: CRT scanlines, TV static and VHS tape damage in random
    bursts.
  * Any RTG screen mode, optional tear-free vertical sync, a frame rate
    limit (60 fps by default) that gives the CPU back to other programs,
    and an on-screen FPS counter.
  * Press F1 while it runs for a live settings panel, in the Topaz font
    from your own Kickstart ROM. Mouse or keyboard; Esc or F1 closes it.
  * MatrixStormPrefs: MUI settings editor. Every setting can also be given
    as a Shell argument or ToolType.
  * MatrixStormCx: blanker commodity. Starts the saver after 1-60 idle
    minutes, appears in Exchange, and does not blank over games, demos or
    (optionally) any screen but Workbench.


REQUIREMENTS
------------

  * PiStorm with a Raspberry Pi 4 and the PiStorm3D MiniGL drivers,
    minigl.library 29.1 or newer (older versions refuse to open for it).
  * Emulated CPU with an FPU (68040/68060).
  * AmigaOS 3.x (tested on 3.2) with RTG; about 10 MB free Fast RAM.
  * MUI 3.8+ for the settings editor only.
  * Installer 43+ for the installer (standard on AmigaOS 3.1.4 and 3.2).


PERFORMANCE
-----------

PiStorm3D, every effect on, MP3 playing in the background, no fps limit:

  Default settings, 1280x720                         70 fps
  Default settings, 1920x1080                        45 fps
  Vertical sync on (tear-free), 1280x720             30 fps
  Vertical sync on (tear-free), 800x600              60 fps


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

 1. Unpack the archive anywhere and double-click "Install-MatrixStorm".
 2. The installer asks where to put the MatrixStorm drawer (default
    SYS:Utilities), whether to install the blanker into SYS:WBStartup and
    after how many idle minutes, and whether to keep existing settings.
 3. To see it at once, double-click MatrixStorm in the new drawer. Any key
    or mouse movement ends it. MatrixStormPrefs changes the settings.

 Double-clicking MatrixStormCx starts the blanker in the background; it
 does not show the saver straight away. It is listed in Exchange as
 "Matrix Storm Blanker".

 To remove everything, double-click Uninstall-MatrixStorm in the
 MatrixStorm drawer.

 By hand: copy MatrixStorm, matrix64.atlas and MatrixStormPrefs (with
 their icons) into one drawer. For the blanker, copy MatrixStormCx and its
 icon into SYS:WBStartup and set its tool type
 SAVER=<your drawer>/MatrixStorm.


ARCHIVE CONTENTS
----------------

  Install-MatrixStorm       Installer script
  Uninstall-MatrixStorm     Uninstaller
  MatrixStorm               The screensaver
  matrix64.atlas            Glyph texture (must sit beside MatrixStorm)
  MatrixStormPrefs          MUI settings editor
  MatrixStormCx             Idle blanker commodity
  MatrixStorm.readme        This file
  *.info                    Icons


KNOWN LIMITATIONS
-----------------

  * Without vertical sync the picture can tear (MiniGL's buffer switching
    on PiStorm3D is not synchronised to the display).
  * Resolution, display type and vertical sync take effect the next time
    the saver starts; everything else changes live with F1.
  * The blanker cannot see a joystick-only program on the Workbench
    screen.
  * Intuition's mouse pointer stays visible beside the F1 panel's pointer.
  * Windowed mode cannot use vertical sync.


TECHNICAL NOTES
---------------

Written in C with bebbo's m68k-amigaos-gcc 6.5.0b. Renders through MiniGL
fixed-function OpenGL; no shaders are needed.


CREDITS
-------

  Matrix Storm 3D for AmigaOS  Aleksandar Vojnic
  Idle detection approach      after AROS Blanker and the "matrix" AGA
                               blanker's MatrixCx
  PiStorm, PiStorm3D           the PiStorm team and the PiStorm3D team
  The Boing Ball               a tribute to the 1984 Amiga demo

"The Matrix" is a trademark of its respective owners. This is an
unofficial fan-made screensaver, not affiliated with or endorsed by them.

LICENSE: Freeware. Free to use, copy and distribute, provided the archive
is unchanged. It may not be sold or included in commercial collections
without the author's permission. Provided as-is, without any warranty;
use at your own risk.

Contact: rtyp3r@yahoo.com