-------------------------------------------------------------------------
-- README for MSXplug written by Mitsutaka Okazaki 2001
-------------------------------------------------------------------------
What's MSXplug?:

  MSXplug is a input plugin for Winamp version 2.xx. It can play old
  music format for MSX.  This plugin supports MGSDRV, MuSICA, MPK and
  OPLLDriver and also supports KSS format files.  The normal file
  extension is MGS, BGM, BGR, MPK, OPX and KSS.

File format and Driver software:

  KSS format file has driver software in itself.  So no additional 
  driver is required to play .KSS files.

  MGSDRV version 3.18 is already embedded in MSXplug.  No additional
  file is required to play .MGS files.  But if there is something
  wrong to play .MGS file with embedded MGSDRV, you can reload an
  another version of MSGDRV from the setting dialog.

  To play the other format, i.e. MuSICA, MPK and OPX, additional
  driver files are needed. See the figure 1.

       +-------------+------------+------------------------+
       | File Format | Extension  | Driver file            |
       +-------------+------------+------------------------+
       | MuSICA      | .BGM, .BGR | KINROU5.BIN            |
       | MPK         | .MPK       | MPK.BIN, MPK103.BIN    |
       | OPLLDriver  | .OPX       | OPX4KSS.BIN, FMPAC.ROM |
       +-------------+------------+------------------------+
                    figure 1: Required driver files

  See 'Reference' section at the bottom of this text to find where
  these drivers can be downloaded.

  If you want to emulate OPLLDriver perfectly, FMPAC.ROM is also required.
  OPLLDriver uses 62 MSX-MUSIC special tones in FMPAC.ROM.

  FMPAC.ROM is a rom image file from FMPAC.  Note that It's completely
  copyrighted material.  You shouldn't ask me where is or how to get
  FMPAC.ROM.

  If FMPAC.ROM is not found, MSXplug try to replace the lacked
  MSX-MUSIC tone with PSG tone. So some .opx files can be performed
  fine without FMPAC.ROM.

How to install MSXplug:

  0. If you had used an older version of in_msx.dll, remove in_msx.ill
     from the Winamp plugins folder.

  1. Copy in_msx.dll to the Winamp plugins folder.

  2. Start Winamp. MSXplug property dialog will be shown.

  4. Click 'Driver' tab, and press 'KINROU5' button.

  5. Select your KINROU5.BIN, and press 'OK'.

  6. In the same way, set paths for MPK.BIN, MPK103.BIN and etc...

  7. Press 'OK' button to close the property dialog.

  If step 4-7 are skipped, in_msx.dll can only play MGS and KSS files.


Keys:

  Setup Dialog      ...F12
  2413 Dialog       ...F11
  Playlist Dialog   ...F10
  InfoBox           ...ALT+3

  Sorry that no document for these dialogs.

Keys for KSS play:

  Ctrl + Winamp's NEXT button ... go to +16 songs next.
  Ctrl + Winamp's BACK button ... go to -16 songs back.


Notice:

  MSXplug is free software and provided 'as-is', without any express
  or implied warranty.


License:

  MSXplug is built on following software.
  MSXplug's license depends on these software's license.

  KMZ80
    Copyright (C) Mamiya 2001.
    http://nezplug.sourceforge.net

  ZLIB
    Copyright (C) 1995-1998 Jean-loup Gailly and Mark Adler
    http://zlib.org

  MGSDRV
    Copyright (C) GIGAMIX/Ain.
    http://www.gigamixonline.com/mgsdrv/

References and Acknowledgement:

  NEZplug by Mamiya
  http://nezplug.sourceforge.net/

  MGSDRV  by GIGAMIX/Ain
  http://www.gigamixonline.com/mgsdrv/

  KINROU5 by Keiichi Kuroda
  http://www.interq.or.jp/white/white/fsw99/music.html

  MPK     by K-KAZ
  http://mu.ice.uec.ac.jp/~kokubun/xray/mpk.html

  OPX4KSS by Mikasen
  http://mika1000.tripod.co.jp/

  MPK2KSS by Naruto
  http://http://suzuka.cool.ne.jp/hellokss/

  The Best Game Music!!! 5th
  http://nesmusic.zophar.net/top.html

  fmpac.ill    by Naruto
  vrc7.ill     by Fukui
  fmopl.c      by Tatsuyuki Satoh
  fmgen.cpp    by cisc


Contact:

  okazaki@angel.ne.jp
  http://www.angel.ne.jp/~okazaki/ym2413/