// =============================================================================
// Workspace Setup Guide - XPMCK
// Authors: Kevin Alexander
// Last updated: 2023-11-16
// =============================================================================

This guide describes how to set up an environment in Windows for creating music
written in MML via the Cross Platform Music Compiler Kit (XPMCK). This compiler
supports the following sound chips (ripped from official manual):

- Gameboy
- YM2151 (CPS-1)
- SN79489 (SMS/GG/CLV)
- YM2413 (SMS)
- YM2612 (Genesis)
- AY-3-8910 (CPC/KSS)
- Konami SCC (KSS)
- Pokey (Atari 8-bit)
- HuC6280 (PCE)

Please contact me if any download links are dead and I'll create a mirror.

// -----------------------------------------------------------------------------
// Software Download Links
// -----------------------------------------------------------------------------

- XPMCK
    - http://jiggawatt.org/muzak/xpmck/
- WLA DX
    - Bin: https://www.smspower.org/forums/10779-WLADXBinaries [Win32]
        - I used wladx-9.5-20080814-win32-bin.zip for this
    - Src: http://www.villehelin.com/wla.html

// -----------------------------------------------------------------------------
// Setup
// -----------------------------------------------------------------------------

01. Download wladx-9.5-20080814-win32-bin.zip. Extract all files in the archive
    to a folder of your choice.
02. Edit your user account's environment variables and add the directory with
    the WLA DX executables to your path.
03. Download XPMCK. Extract all files in the archive to a folder of your choice.

// -----------------------------------------------------------------------------
// Compiling Songs
// -----------------------------------------------------------------------------

The easiest way to compile songs is via the batch scripts in the ./demo/
directory (ex: ./demo/gbc/mkgbs.bat). You'll probably want to modify the files a
bit to suit your workspace setup, as they're set up to reference the XPMCK
executable and MML files relative to that directory.

Example usage so you know you've set everything up correctly:
    > mkgbs.bat scotland

// =============================================================================

https://www.studioaquacube.com