MUE Music Editor upgrade patch v1.1
-----------------------------------
(c) 2013, 2019 by FRS

This patch upgrades the MUE Music Editor by HAL to a homebrew v1.1, that fixes
some bugs and implements mouse and turbo support.

- Bugfix: Disk drive detection was buggy and didn't work when the software
  was run as a cartridge. Only if executed from disk (.BIN) that it would work. 
- Bugfix: Screen corruption that happened if the MSX booted in 80 columns mode
- On MSX2, there now mouse support on either joyport1 or joyport2
- Bugfix: the mouse was moved too quickly to the left or right, it would warp
  to the other side of the screen
- Automatically set the frame rate to 60Hz on MSX>=2. Press "5" on boot to
  force 50Hz
- The copyright message on boot will show "v1.1", so you can easily know that
  this patch was applied.

Notes:
- The built-in "Fuga II by Bach" built-in music (easter egg) had to be removed
  to make space for the changes. This music is included as a separate
  FUGAII.MUE file now.
- When run under DiskBIOS v1.x/DOS1, this software requires you to boot with the
  CTRL key pressed. If you run it under DiskBIOS2/DOS1/Nextor, this won't be
  necessary and you will be able to use more than one disk drive.
- Mouse support is only enabled on MSX2 or higher. On MSX1 computers, you can
  only use a trackball connected to the joystick port-2. There wasn't
  enough space in the ROM to add mouse support for the MSX1.
- The best way to run this software is via ExecROM on MSX-DOS2/Nextor. This
  way you'll have multiple drive support and mass storage support. This is
  why a .XPC patch file is also included.

Todo (in the future):
- Add HIDlib support. This will allow:
  - Autodetection and hotplug
  - Mouse support on MSX1
  - Touch pad support on MSX1 & MSX>=2 
  - Light pen support on MSX>=2 (no space to support on MSX1)

==============================
How to apply the patch

The ROM image must be an original dump. You can check if it has the following
SHA1 checksum:

SHA1(MUEHAL.ROM)= 20a2e3d7966916f46eb26cc1aa226ec2d11646f9


- You can use the following tools to verify the SHA1 checksum:
  - Windows:
    -MD5 & SHA-1 Checksum Utility 1.1
    - HashTab
  - Mac OS-X:
    - DropHash
    - HashTab
    - (or use the Linux solution below)
  - Linux:
    - Just type on a shell: openssl dgst -sha1 MYGAME.DSK


If you use ExecROM to load the ROM file, you don't need to apply the patch
to the ROM beforehand. Just save the MUEHAL.XPC in the same directory
as your MUEHAL.ROM file, and ExecROM will apply it automatically every time
it loads the ROM. This way you can preserve your original ROM file untouched.

OTOH, if you prefer to apply the patch to load the ROM on a flash cartridge,
then use the IPS file as explained below:

- To apply the patch, get an IPS patcher like IPSWin, LunarIPS or UIPS, and
  follow the instructions contained in the manual of that tool.


==============================
Special Thanks

- OpenMSX team, for their excellent emulator and debugger
- MRC crew, for the place where MSX hobbyists can meet and exchange ideas
- Sjoerd Mastijn and Aprisobal, for the SjASMPlus assembler
- FiXato, for compiling many development tools I use on Mac OS-X
- Werner Kai, for one of the the disks full of songs that were included with
  this release

==============================
FAQ
---

Q: Will the patched software run on non-turbo machines?
A: Yes, just as usual

Q: I applied the patch and the resulting ROM doesn't work! What is wrong?
A: You're probably trying to apply the patch on DSKs with the incorrect
   checksum. Also, check if you're using the recommended patch tools


===========================================================================
	                     License
                           Terms of use
---------------------------------------------------------------------------

1) This patch is gratis for non-commercial purposes, and the author retains
   its copyright. You only can run and make backup copies of the patch
   while observing the non-commercial restriction.

2) You are only allowed redistribute the patch files (online or on a removable
   media) under the following conditions:
   2.1) No commercial transaction of any kind is involved
   2.2) All the included files are distributed together inside the same
   compressed file.
   2.3) This README must be included unmodified inside the same compressed file.

3) If you want to use this patch for commercial purposes you MUST contact me
   first to negotiate the terms and conditions. Send an e-mail to
   sdsnatcheralpha@gmail.com to contact me.

4) You cannot distribute games with this patch pre-applied.

5) This patch is provided ‘as-is’, without any express or implied warranty.
   In no event will the author be held liable for any damages resulting from the
   use of this patch or the software patched with it.

6) USE THIS SOFTWARE SOLELY AT YOUR OWN RISK.


===========================================================================
                          Donations
---------------------------------------------------------------------------
 If you like the enhancements and fixes here presented and want to show your
 appreciation by donating any amount, or MSX software/hardware, it will be very
 welcome and will help future developments.
 Donations can be done via PayPal to sdsnatcheralpha@gmail.com, and for MSX
 hardware, try contacting me on this e-mail address too.

 Have a look at my wishlist in the following link:
 http://frs.badcoffee.info/wishlist.html

