==============================================================================
REKKR for DOS (M.B.F. version)                                          v1.02a
2024/08/07                                               compiled by MrFlibble
==============================================================================
1. General Information & Features
==============================================================================

This is a DOS version of REKKR, 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 REKKR 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 the original Doom code

REKKR-specific improvements:

- extended menus in REKKR menu font
- 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.

REKKR for DOS is open source, 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).

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

DMXOPL is licensed under the MIT license.

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

2022/07/03 - v1.00 - initial release

2023/11/23 - v1.01 - Allegro & misc updates

adlib.c, midi.c      updated Allegro library w/ fixes by Gerwin
info.c               fixed font colour ranges to properly navigate MBF menus
m_menu.c             changed menu font colour definitions
info.c               replaced MBF helper dogs w/ CC-BY sprites by Nash
                     replaced dog sounds with CC-BY/CC0 versions from GZDoom
                     replaced menu reset button with sprite created from
                     a REKKR switch
m_misc.c             changed default automap colours to imitate Sunken Land
                     automap colour scheme
d_main.c             fixed a couple of warnings

2024/01/18 - v1.02 - native GENMIDI support, various fixes; fully stand-alone

liballeg.a           replaced the library w/ ludicrous_peridot's version to
                     enable the use of GENMIDI lump and secondary instruments
                     is MUS music playback
mmus2mid.c           added ludicrous_peridot's code to enable GENMIDI and
mmus2mid.h           secondary instrument support
i_sound.c            >
i_sound.h            >
s_sound.c            >
d_main.c             added routines to autoload REKKR.wad and extra PWADs
                     REKKR credits now shown before M.B.F. credits between
                     self-running demos
g_game.c             copied map par times from MAPINFO lump in REKKR.wad
info.c               replaced the MBFTEXT lump w/ a version that uses old
                     Freedoom font
m_misc.c             changed filename pattern for screenshots
                     default compat settings are now closer to vanilla Doom
dstrings.c           fixed a typo (missing space) in one exit message
d_englsh.h           replaced generic strings w/ Freedoom counterparts

2024/08/07 - v1.02a - maintenance release, Allegro library update

info.c               cleaned up or replaced unused data leftovers
                     tweaked HUD font colour palswaps
m_misc.c             tweaked automap colours and font colour presets
d_main.c             minor tweaks (see changes.txt)
d_net.c              >
d_englsh.h           >
g_game.c             >
m_cheat.c            >
rekpat.wad           removed redundant data, added a simpler menu reset button

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

REKKR for DOS will run both natively and in DOSBox.

REKKR for DOS requires a specific patched version of the REKKR main data file
that fixes the "column without patch" error with certain textures. This file
may be obtained from the Doomworld forums (REKKR116a_tf.zip):

https://www.doomworld.com/forum/post/2290941

No other files are needed to play.

To install and set up REKKR for DOS, unpack the contents of dosrekkr.zip into
any directory (i.e. C:\REKKR\).

Unpack REKKR.wad from REKKR116a_tf.zip and put it into the same directory as
REKKR.EXE. Run SETUP.EXE to configure the sound and music devices, then run
REKKR.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. 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

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

REKKR - V1.16 (Doomworld forum topic)
https://www.doomworld.com/forum/topic/90862-rekkr-v116/

HacX 1.2 and Boom/MBF (DRD Team forum topic)
https://forum.drdteam.org/viewtopic.php?t=6623#p56999

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 intrument 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

==============================================================================
5. Credits
==============================================================================

REKKR                           Revae/Mockingbird Software (see REK_CREDS.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

REKBONUS                        brightentayle

Dog sprites                     Nash Muhandes

Dog sounds                      Kinsie

Miniwad                         Simon Howard (Fraggle)

miniwadm                        brightentayle

DMXOPL                          Shannon Freeman (sneakernets)

MIDI2MUS                        id Software

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

                       --- END OF FILE (2024/08/07) ---
