// =============================================================================
// Workspace Setup Guide - PPMCK
// 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 PPMCK. This compiler is used to create Nintendo Sound Format
(NSF) files, or music for the NES/Famicom. If you don't want to write music in a
text editor, download DN-Famitracker, instead.

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

- PPMCK
    - Bin: https://github.com/AoiMoe/ppmck-dist
    - Src: https://github.com/AoiMoe/ppmck

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

01. Download the PPMCK binaries. Extract all files in the archive to a folder of
    your choice.
02. Download the PPMCK source. Extract the ./songs/ directory to the folder you
    extract the other PPMCK files to.

// -----------------------------------------------------------------------------
// Pre-compilation Initialization
// -----------------------------------------------------------------------------

Open a command prompt in the ./songs/ directory. Before you compile anything,
run:
    > set_envs.bat

This will set up environmental variables so compiling will work properly. You
may need to modify this file depending on your workspace setup.

// -----------------------------------------------------------------------------
// Compiling MML to Single-song NSF/NES Files
// -----------------------------------------------------------------------------

To compile your MML to a single-song Nintendo Sound Format file, run:
    > mknsf.bat input

To compile your MML to a single-song NES rom, run:
    > mknes.bat input

// -----------------------------------------------------------------------------
// Compiling MML to Multiple-song NSF/NES Files
// -----------------------------------------------------------------------------

If you want to have a single NSF/NES file with multiple songs in it, use the
./mkmulti*.bat scripts.

To compile your MML to a multiple-song Nintendo Sound Format file, run:
    > mkmultinsf.bat {input} {input} {...}

To compile your MML to a multiple-song NES rom, run:
    > mkmultines.bat {input} {input} {...}

Take note these multi-song scripts name the final file multisong.nsf/nes. Be
careful not to override a different multi-song file you created earlier.

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

https://www.studioaquacube.com