Fomalhaut for AIMP
==================

Retro music visualisations - the classics from before 2000, heavily inspired
by Cthugha: Cthugha 5.3 DOS, Cthugha98, Cthugha-L, Cthugha-4-Winamp, the Atari
Video Music C240 (1977), VSG+ DOS, the screens of 18 music trackers (Amiga,
DOS, Windows, C64, CPC), the Compact Cassette with cassette decks of the 70s,
80s and 90s, the Credits and a Mix of all of them.

Requirements: AIMP 5.x for Windows, 64-bit or 32-bit (the package contains
both). Also runs with the AIMP 6 beta.


Installation
------------

Recommended: AIMP installs the package itself.
1. Double-click aimp_fomalhaut-<version>.aimppack, or in AIMP: Preferences >
   Plugins, click "Install" (bottom left) and choose the .aimppack file.
   AIMP picks the 64-bit or 32-bit version.
2. Tick "Fomalhaut" in the list of plugins, click OK and restart AIMP.

By hand (the .aimppack file is a ZIP archive - rename it to .zip to open it):
1. Close AIMP.
2. Copy the folder aimp_fomalhaut from the archive into the Plugins folder of AIMP
   (for example C:\Program Files\AIMP\Plugins).
3. 64-bit AIMP only: move aimp_fomalhaut\x64\aimp_fomalhaut.dll one folder up,
   replacing the 32-bit aimp_fomalhaut.dll there.
4. Start AIMP and tick "Fomalhaut" under Preferences > Plugins if needed.

Choose a visualisation: right-click the visualisation area of AIMP and pick
one of the "Fomalhaut: ..." entries (one entry per mode).


Use
---

- Left click: next effect; on the cassette decks the buttons, switches and
  knobs work like on the real device (also drag and mouse wheel).
- Middle click: Fomalhaut menu (modes, presets, CRT filter, effect parts such
  as flame/wave/deck, Atari Video Music controls, settings).
- Right click: AIMP's own menu (choose the visualisation, fullscreen).
- Move the mouse to the top of the picture: the control bar slides in.
- Atari Video Music: move the mouse to the bottom of the picture and the front
  panel slides in.
- Fullscreen: AIMP's fullscreen (Alt+Enter), or Fomalhaut's own fullscreen
  window from the menu (with the full frame rate of the screen).
- Keys: AIMP keeps all keys for itself. Fomalhaut's commands (next effect,
  keys F, W, D, P ..., lock, screenshot ...) can be assigned to keys under
  Preferences > Hotkeys, group "Fomalhaut".
- Settings: Preferences > Plugins > Fomalhaut (five pages), also via
  "Fomalhaut settings..." in AIMP's main menu or "Preferences..." in the
  Fomalhaut menu. They are stored in AIMP's profile.

AIMP draws a visualisation about 32 times a second and passes only short
pieces of the sound (512 values per picture). Fomalhaut keeps its modes running
in real time and joins the pieces into a continuous stream; the gaps are
filled. In foobar2000 (foo_fomalhaut) all modes get the full sound.

If AIMP reports that the plugin crashed, please send the file
%TEMP%\fomalhaut_aimp_crash.log (if present) with a short description.


Credits and license
-------------------

Inspired by Cthugha (c) 1993-1998 Kevin "Zaph" Burfitt, Torps Productions, and
Cthugha-L (c) 1995-1998 Harald Deischinger; Cthugha-4-Winamp (c) 1998 Krunoslav
Pisacic. Full credits: visualisation "Fomalhaut: Credits", and
THIRD-PARTY-NOTICES.txt. Fomalhaut is free of charge and not affiliated with
the Cthugha authors or with AIMP; the unmodified package may be passed on, as
long as no fee is charged for it. See LICENSE.txt.

Videos (Vimeo): 1.3 - Cassette mode and AIMP: https://vimeo.com/1244941482
                1.2 - presentation:          https://vimeo.com/1244943326

Fomalhaut for foobar2000 (Windows and macOS), Winamp and news:
https://github.com/Oxensepp/fomalhaut
