==============================================================================
MUSE: Harmony Compatible for DOS                                         v1.00
2025/04/21                                               compiled by MrFlibble
==============================================================================
1. General Information & Features
==============================================================================

MUSE is a dedicated DOS version of Harmony Compatible, a Doom engine game/TC,
powered by the M.B.F. (Marine's Best Friend) Doom source port. It is based on
the code of Gerwin Broers' M.B.F. Maintenance Release version 2.04 (Upload no.
019), with additional code from ludicrous_peridot for improved sound and OPL3
music.

By using M.B.F. as its base, this version of Harmony Compatible for DOS makes
several functional and cosmetic improvements over other ports.

General M.B.F. features:

- optimised performance both on period hardware and in DOSBox
- high-resolution (640x400) support
- various bug fixes compared to original Doom code

Harmony Compatible-specific improvements:

- restored original HUD font from Harmony v1.1
- restored original par times for MAP01-11 from Harmony v1.1
- extended menus in Harmony menu font with various backgrounds
- fixed colours on the minimized HUD
- improved OPL3 music thanks to ludicrous_peridot's modified Allegro library
  & DMXOPL instrument patches
- custom cheat codes

For the full list of game code changes, please see CHANGES.TXT.

MUSE is open source software, and the game code is licensed under the GNU
General Public License, version 2 (please see the GNU.TXT file for the full
text of the license).

Harmony Compatible game data is licensed under the Creative Commons
Attribution-NonCommercial-ShareAlike 4.0 International License. To view a
copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/4.0/

DMXOPL is licensed under the MIT license.

==============================================================================
2. Revision History
==============================================================================

2025/04/21 - v1.00 - initial release

==============================================================================
3. Installation and Usage
==============================================================================

Harmony Compatible for DOS will run both natively and in DOSBox.

You will the main data file of Harmony Compatible, which can be obtained from
the idgames archive (harmonyc.zip):

https://www.doomworld.com/idgames/levels/doom2/Ports/g-i/harmonyc

No other files are required to play.

To install and set up Harmony Compatible for DOS:

1. Unpack the contents of muse100.zip into any directory (i.e. C:\HARMONY\).

2. Unpack HarmonyC.wad from harmonyc.zip into the same directory as MUSE.EXE.

3. Run SETUP.EXE to configure the sound/music devices. Run MUSE.EXE to play.

Game controls can be reconfigured from in-game options menus.

Please refer to CHEATS.TXT for the list of cheat codes in this version.

==============================================================================
4. Known Bugs/Issues
==============================================================================

Switching to high resolution may in some cases corrupt the game palette. If
this happens, quit and restart the game, which will fix the problem.

==============================================================================
5. Credits
==============================================================================
        
Harmony Compatible              Thomas van der Velden (see HarmonyC.txt)

M.B.F. 2.04                     Gerwin Broers

Allegro 3.0 modifications       ludicrous_peridot

M.B.F. 2.03 with fixes          Simon Howard (Fraggle)

M.B.F. 2.03                     Lee Killough (see MBF.TXT)

BOOM 2.02                       Team TNT

Miniwad                         Simon Howard (Fraggle)

DMXOPL                          Shannon Freeman (sneakernets)

MIDI2MUS                        id Software

Dog sprites (unused)            Nash Muhandes

Dog sounds (unused)             Kinsie

==============================================================================
6. Web Links for Reference
==============================================================================

> Doom 'MBF' for DOS, Maintenance release 2.04 (VOGONS forum topic)

  https://www.vogons.org/viewtopic.php?f=24&t=40857

> ludicrous_peridot's updated Allegro library & music code (GitHub repo)

  https://github.com/drivelling-spinel/alleg30b

> ludicrous_peridot's updated Allegro library & music code (VOGONS forum posts)

  https://www.vogons.org/viewtopic.php?p=1209531#p1209531
  https://www.vogons.org/viewtopic.php?p=1215418#p1215418

> M.B.F. with fixes by Fraggle

  https://soulsphere.org/projects/smmu/mbf-fixes/

> M.B.F. Code Notes from PrBoom

  https://prboom.sourceforge.net/mbf-bugs.html

> 'Harmony Compatible' now available! (Doomworld forum topic)

  https://www.doomworld.com/forum/topic/141216-harmony-compatible-now-available/

> HacX 1.2 and Boom/MBF (DRD Team forum topic)

  https://forum.drdteam.org/viewtopic.php?t=6623#p56999

> Miniwad - Minimal Doom IWAD

  https://github.com/fragglet/miniwad/

> Miniwad - Minimal Doom IWAD (Doomworld forum topic)
  
  https://github.com/fragglet/miniwad/

> miniwadm - a 300K IWAD (Doomworld forum topic)

  https://www.doomworld.com/forum/topic/136409-miniwadm-a-300k-iwad/

> DMXOPL - improved instrument patches for OPL music synthesis

  https://github.com/sneakernets/DMXOPL

> MIDI2MUS - MIDI to MUS converter

  https://www.doomworld.com/idgames/utils/sound_edit/midi2mus

> Free dog sprites by Nash Muhandes (ZDoom forum topic)

  https://forum.zdoom.org/viewtopic.php?f=59&t=58035

==============================================================================

                       --- END OF FILE (2025/04/21) ---
