suppertails66 / mkrggtools Goto Github PK

********************************************************************************
*                      Magic Knight Rayearth (Game Gear)                       *
*                     English Translation Patch Materials                      *
********************************************************************************

This package contains the source materials (code/art/script) for the English
translation project for the Game Gear game Magic Knight Rayearth.

                    ****************************************
                    *          Build Instructions          *
                    ****************************************
                    
The build system is only set up for Unix-like systems, though none of the code
is fundamentally dependent on this and could be ported with a bit of effort.
You'll need GCC.

Get a ROM image of the original game, which should have an MD5 sum of
846d48d0f4024c8094117599d0e1eef1. Rename it "mkr.gg" and place it in the mkrgg
folder. Then:

$ cd mkrgg
$ ./build.sh

build.sh should then build all the necessary tools and output the translated
ROM as mkr_en.gg.

If you want to modify the project, check build.sh to see where the resources
that get inserted into the game are coming from.

                    ****************************************
                    *              Licensing               *
                    ****************************************

See COPYING. Basically, everything by me (Supper) is GPLv3, and everything else
is under the terms of whoever wrote it.

                    ****************************************
                    *               Credits                *
                    ****************************************

                               Filler -- Translation
                               Supper -- Hacking