==============================================================================
BarX - enhanced HACX port for DOS based on M.B.F.                   revision 1
2026/04/09                                               compiled by MrFlibble
==============================================================================
1. General Information & Features
==============================================================================

This is an enhanced port of HacX: Twitch n' Kill by Banjo Software, based on
the code of M.B.F. (Marine's Best Friend) Maintenance Release version 2.04
(Upload no. 019) by Gerwin Broers, with additional code from ludicrous_peridot
for improved sound and OPL3 music.

HACX was originally a commercial add-on for Doom II that was made freeware in
2000 and converted into a full stand-alone game in 2010.

BarX is compatible with the original releases of HACX as well as with the
updated stand-alone version. In both cases, no other files are needed to play.

BarX main features include:

- accurate recreation of original HACX mechanics and gameplay
- various bug fixes compared to the original Doom code
- improved support for accurate demo playback
- optimised performance both on period hardware and in DOSBox
- support for high-resolution (640x400) modes
- optional cosmetic features (e.g., translucency) and AI improvements
- optional helper dogs that follow and assist the player
- improved OPL3 music thanks to ludicrous_peridot's modified Allegro library
- restored variable sound pitch from early Doom versions (optional)
- custom automap colour scheme
- various minor spelling fixes, etc.

==============================================================================
1a. Licenses & Permissions
==============================================================================

Hacx is now a royalty free item. This means that Hacx may NOT be used to
generate income of any kind nor can it be used to promote any activity that
would generate income.

BarX 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).

Miniwad, upon which HACX0.WAD IWAD (required to play HACX v1.0/1.1) is based,
is released under the Modified BSD license.

DMXOPL is licensed under the MIT license.

Tone libraries for OPL2 and OPL3 chips produced by The Fat Man are released
under the MIT license (please see LICENSE-TheFatMan.txt in the DOCS folder).

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

2026/04/09 - r1 - initial release

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

BarX will run both natively and in DOSBox. You will need the main HACX data
file (HACX.WAD), not included in this package.


The following releases of HACX are upported:

> freeware version 1.1

  https://www.gamers.org/pub/idgames/themes/hacx/hx11pack.zip

> commercial CD version 1.0

> community-updated version 1.2V:

  https://www.doomworld.com/forum/topic/157709-hacx-12v-vanilla-for-dos-based-on-doomnew-release-candidate/

No other files are required to play.

!!! IMPORTANT NOTE !!!

The original version 1.2 release from 2010 is NOT supported and will not work.


To install and set up BarX:

- make sure your OS can run DOS applications or set up an emulator like DOSBox

- unpack the contents of barx.zip into any directory (e.g. C:\BARX\)

- place HACX.WAD into the same directory as BARX.EXE

- run SETUP.EXE to configure the sound and music devices

- run BARX.EXE to play

NOTE: If you have the commercial CD version of HACX, please start the game by
running HACXCD.BAT instead.

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

BarX will accept all standard DOOM command line parameters like -file, -warp,
-skill, -record, -playdemo, etc.

You can use DMXOPL timbres to improve the quality of OPL3 music in the game by
loading DMXOPL.WAD when playing. This can be done either by using DMXOPL.BAT
to start the game, adding DMXOPL.WAD to the autoload list in BarX menus or
manually with the -file command-line parameter.

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

> HACX - Twitch 'n Kill (official website)

  http://drnostromo.com/hacx/

> 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

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

> DMXOPL - improved intrument patches for OPL music synthesis

  https://github.com/sneakernets/DMXOPL

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

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

> OPL3BankEditor

  https://github.com/Wohlstand/OPL3BankEditor

> libADLMIDI

  https://github.com/Wohlstand/libADLMIDI

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

HACX                            Banjo Software

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

Dog sprites                     Nash Muhandes

Dog sounds                      Kinsie

Miniwad                         Simon Howard (Fraggle)

DMXOPL                          Shannon Freeman (sneakernets)

OPL3BankEditor                  Vitaliy Novichkov (Wohlstand)

OPL2/OPL3 tone libraries        George Alistair Sanger (The Fat Man)
                                K. Weston Phelan

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

                       --- END OF FILE (2026/04/09) ---
