==================================================
Icarian/Icaryx/NyxQuest Classic Controller Patcher
==================================================
                                        Vague Rant

This script will apply one IPS patch to any valid WAD for NyxQuest or related
titles. These include:

    EUR:
    - Icarian: Kindred Spirits (v3)
    - Icaryx: Kindred Spirits (v256)
    - NyxQuest: Kindred Spirits (v257)

    USA:
    - NyxQuest - Kindred Spirits (v2)

    JPN:
    - NyxQuest (v0)

The demo versions of these releases are not supported.

The supported patches for these games are:

- add Classic Controller support
    add traditional gamepad controls

- disable copy filter
    disable the copy ("deflicker") filter to improve sharpness

-----
Usage
-----
You must place common-key.bin into the same directory where you unpack this
script. This key is a cryptographic secret, protected in some jurisdictions due
to its potential use in circumvention of DRM. I cannot help you find this file.

When you launch the patch script, it will attempt to verify that the
common-key.bin file is present and correct. If not, an error will appear and
the script will exit.

To begin patching, you can pass an argument to the script in one of two ways:
dragging and dropping the source WAD onto the apply-patch.bat file or directly
from the command prompt, e.g.

    apply-batch.bat "Icarian - Kindred Spirits (Europe) (WiiWare).wad"

If you don't provide a source WAD via argument, you will be prompted to provide
one upon launching the script. This should be either an absolute or relative
path to your source WAD, surrounded in quotation marks (").

Once the script has started, you will answer a series of y/N prompts for which
patches you wish to apply. These prompts are not case-sensitive.

If you provide an incorrect WAD, the patching process will fail and exit
without patching. If you select not to apply the patch, the script will of
course exit without patching.

The original WAD will not be modified. A new WAD will be packed with the
filename "[title]_[region]_patched.wad" and placed into the script directory.

-----------------------
Patching without Script
-----------------------
If you cannot run the included script and tools due to being on a different
operating system or architecture, the process to apply these patches manually
using appropriate tools for your system is:

    1. Unpack your WAD
    2. Decompress the 00000001.app file
    3. Apply the desired IPS patches for your region
    4. Compress the 00000001.app file
    5. Pack a new WAD

-------------------------
Classic Controller Layout
-------------------------
The following control scheme will be added to the game:

    +------------------------------------------------------+
    | Wiimote/Nunchuk |   Classic   |       Function       |
    |-----------------+-------------+----------------------|
    |        A        |   A/B/L/R   | Confirm              |
    |                 |             | Jump                 |
    |-----------------+-------------+----------------------|
    |        B        |      ZR     | Cancel               |
    |                 |             | Use Zeus Powers      |
    |-----------------+-------------+----------------------|
    |        Z        |   X/Y/ZL    | Run/Glide            |
    |-----------------+-------------+----------------------|
    |      Stick      | Left Stick  | Movement             |
    |-----------------+-------------+----------------------|
    |     Pointer     | Right Stick | Aim Zeus Powers      |
    |-----------------+-------------+----------------------|
    |       Plus      |     Plus    | Pause                |
    |-----------------+-------------+----------------------|
    |       Home      |     Home    | Open/Close Home Menu |
    +------------------------------------------------------+

--------------
Included Tools
--------------
- flips by Alcaro
    licensed under GPLv3
    https://github.com/Alcaro/Flips

- lzx by CUE
    licensed under GPLv3
    https://github.com/PeterLemon/Nintendo_DS_Compressors

- wadpacker and wadunpacker by BFGR
    licensed under GPLv2
    https://github.com/AuroraWright/FunKii/tree/master/wadtools

- xxd by Juergen Weigert, Vadim Vygonets et al
    licensed under the following terms:
        Distribute freely and credit me,
        make money and share with me,
        lose money and don't ask me.
    https://github.com/bigbio2002/xxd