From 90fbc11b7a311a8f13fc8abdf74ddedfabc66b07 Mon Sep 17 00:00:00 2001 From: Nebuleon Fumika Date: Thu, 20 Dec 2012 18:57:32 -0500 Subject: Fix the Engrish in the readme. Make it a Markdown file for Github. --- README.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..33b4af4 --- /dev/null +++ b/README.md @@ -0,0 +1,80 @@ +CATSFC version 1.08, 2012-12-20 + +A Super Nintendo emulator for the Supercard DSTWO. + +Based on: +* Snes9x 1.43, by the Snes9x team (with research by the ZSNES folks, anomie, + zsKnight, etc.) +* NDSSFC 1.06, by the Supercard team (porting to the MIPS processor) +* BAGSFC, by BassAceGold (improving over NDSSFC) +* CATSFC, by ShadauxCat (improving over BAGSFC) + +== Compiling == + +Compiling CATSFC is best done on Linux. Make sure you have access to a Linux +system to perform these steps. + +=== The DS2 SDK === +To compile CATSFC, you need to have the Supercard team's DS2 SDK. +The Makefile expects it at `/opt/ds2sdk`, but you can move it anywhere, +provided that you update the Makefile's `DS2SDKPATH` variable to point to it. + +For best results, download version 0.13 of the DS2 SDK, which will have the +MIPS compiler (`gcc`), extract it to `/opt/ds2sdk`, follow the instructions, +then download version 1.2 of the DS2 SDK and extract its files into +`opt/ds2sdk`, overwriting version 0.13. + +=== The MIPS compiler (`gcc`) === +You also need the MIPS compiler from the DS2 SDK. +The Makefile expects it at `/opt/mipsel-4.1.2-nopic`, but you can move it +anywhere, provided that you update the Makefile's `CROSS` variable to point to +it. + +=== Making the plugin === +To make the plugin, `catsfc.plg`, use the `cd` command to change to the +directory containing your copy of the CATSFC source, then type +`make clean; make`. `catsfc.plg` should appear in the same directory. + +== Installing == + +To install the plugin to your storage card after compiling it, copy +`catsfc.plg`, `catsfc.ini` and `catsfc.bmp` to the card's `_dstwoplug` +directory. Then, copy the source directory's CATSFC subdirectory to the +root of the card. + +== The font == + +The font used by CATSFC is now similar to the Pictochat font. To modify it, +see `source/font/README.txt`. + +== Translations == + +Translations for CATSFC may be submitted to the author(s) under many forms, +one of which is the Github pull request. To complete a translation, you will +need to do the following: + +* Open `CATSFC/system/language.msg`. +* Copy what's between `STARTENGLISH` and `ENDENGLISH` and paste it at the end + of the file. +* Change the tags. For example, if you want to translate to German, the tags + will become `STARTGERMAN` and `ENDGERMAN`. +* Translate each of the messages, using the lines starting with `#MSG_` as a + guide to the context in which the messages will be used. +* Edit `source/nds/message.h`. Find `enum LANGUAGE` and add the name of your + language there. For the example of German, you would add this at the end of + the list: + `, GERMAN` +* Still in `source/nds/message.h`, just below `enum LANGUAGE`, you will find + `extern char* lang[` /some number/ `]`. Add 1 to that number. +* Edit `source/nds/gui.c`. Find `char *lang[` /some number/ `] =`. + Add the name of your language, in the language itself. For the example of + German, you would add this at the end of the list: + `, "Deutsch"` +* Still in `source/nds/gui.c`, find `case CHINESE_SIMPLIFIED`. Copy the lines + starting at the `case` and ending with `break`, inclusively. Paste them + before the `}`. Change the language name and tags, and update the `cmplen` + to be the length of the `START` tag. For the example of German, you would + use `cmplen= 11;`, because that's the length of `STARTGERMAN`. + +Compile again, copy the plugin and your new `language.msg` to your card +under `CATSFC/system`, and you can now select your new language in CATSFC! -- cgit v1.2.3 From dfab02b9136aad8070c02aaafa5a045faa47f958 Mon Sep 17 00:00:00 2001 From: Nebuleon Fumika Date: Thu, 20 Dec 2012 19:06:04 -0500 Subject: Use Markdown-style sections. I thought == == worked... --- README.md | 37 +++++++++++++++++++++++++------------ 1 file changed, 25 insertions(+), 12 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 33b4af4..94fb949 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,12 @@ Based on: * BAGSFC, by BassAceGold (improving over NDSSFC) * CATSFC, by ShadauxCat (improving over BAGSFC) -== Compiling == +# Compiling Compiling CATSFC is best done on Linux. Make sure you have access to a Linux system to perform these steps. -=== The DS2 SDK === +## The DS2 SDK To compile CATSFC, you need to have the Supercard team's DS2 SDK. The Makefile expects it at `/opt/ds2sdk`, but you can move it anywhere, provided that you update the Makefile's `DS2SDKPATH` variable to point to it. @@ -24,30 +24,30 @@ MIPS compiler (`gcc`), extract it to `/opt/ds2sdk`, follow the instructions, then download version 1.2 of the DS2 SDK and extract its files into `opt/ds2sdk`, overwriting version 0.13. -=== The MIPS compiler (`gcc`) === +## The MIPS compiler (`gcc`) You also need the MIPS compiler from the DS2 SDK. The Makefile expects it at `/opt/mipsel-4.1.2-nopic`, but you can move it anywhere, provided that you update the Makefile's `CROSS` variable to point to it. -=== Making the plugin === +## Making the plugin To make the plugin, `catsfc.plg`, use the `cd` command to change to the directory containing your copy of the CATSFC source, then type `make clean; make`. `catsfc.plg` should appear in the same directory. -== Installing == +# Installing To install the plugin to your storage card after compiling it, copy `catsfc.plg`, `catsfc.ini` and `catsfc.bmp` to the card's `_dstwoplug` directory. Then, copy the source directory's CATSFC subdirectory to the root of the card. -== The font == +# The font The font used by CATSFC is now similar to the Pictochat font. To modify it, see `source/font/README.txt`. -== Translations == +# Translations Translations for CATSFC may be submitted to the author(s) under many forms, one of which is the Github pull request. To complete a translation, you will @@ -63,18 +63,31 @@ need to do the following: * Edit `source/nds/message.h`. Find `enum LANGUAGE` and add the name of your language there. For the example of German, you would add this at the end of the list: - `, GERMAN` + ``` + , + GERMAN + ``` * Still in `source/nds/message.h`, just below `enum LANGUAGE`, you will find - `extern char* lang[` /some number/ `]`. Add 1 to that number. -* Edit `source/nds/gui.c`. Find `char *lang[` /some number/ `] =`. + `extern char* lang[` *some number* `]`. Add 1 to that number. +* Edit `source/nds/gui.c`. Find `char *lang[` *some number* `] =`. Add the name of your language, in the language itself. For the example of German, you would add this at the end of the list: - `, "Deutsch"` + ``` + , + "Deutsch" + ``` * Still in `source/nds/gui.c`, find `case CHINESE_SIMPLIFIED`. Copy the lines starting at the `case` and ending with `break`, inclusively. Paste them before the `}`. Change the language name and tags, and update the `cmplen` to be the length of the `START` tag. For the example of German, you would - use `cmplen= 11;`, because that's the length of `STARTGERMAN`. + use `cmplen= 11;`, because that's the length of `STARTGERMAN`: + ```C + case GERMAN: + strcpy(start, "STARTGERMAN"); + strcpy(end, "ENDGERMAN"); + cmplen = 11; + break; + ``` Compile again, copy the plugin and your new `language.msg` to your card under `CATSFC/system`, and you can now select your new language in CATSFC! -- cgit v1.2.3 From cba2a156f833037de0f7aca84ae136f9f4522977 Mon Sep 17 00:00:00 2001 From: Nebuleon Fumika Date: Thu, 20 Dec 2012 19:08:18 -0500 Subject: Somehow the C (language specifier) from a code block made it into the readme. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 94fb949..c214582 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ need to do the following: before the `}`. Change the language name and tags, and update the `cmplen` to be the length of the `START` tag. For the example of German, you would use `cmplen= 11;`, because that's the length of `STARTGERMAN`: - ```C + ``` case GERMAN: strcpy(start, "STARTGERMAN"); strcpy(end, "ENDGERMAN"); -- cgit v1.2.3 From 3972512b2a5c25236ea3ba586621dba6e5b56361 Mon Sep 17 00:00:00 2001 From: Nebuleon Fumika Date: Fri, 21 Dec 2012 01:44:57 -0500 Subject: Looks like only having 'lang' crashes the options dialog. Restore the array of pointers. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index c214582..2324d22 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,10 @@ need to do the following: , "Deutsch" ``` +* Still in `source/nds/gui.c`, find `char* language_options[]`, which is below + the language names. Add an entry similar to the others, with the last number + plus 1. For example, if the last entry is `, (char *) &lang[2]`, yours would + be `, (char *) &lang[3]`. * Still in `source/nds/gui.c`, find `case CHINESE_SIMPLIFIED`. Copy the lines starting at the `case` and ending with `break`, inclusively. Paste them before the `}`. Change the language name and tags, and update the `cmplen` -- cgit v1.2.3 From e7ce8dd66c19de431fb347a0f3cd0ea867a802ce Mon Sep 17 00:00:00 2001 From: Nebuleon Fumika Date: Mon, 24 Dec 2012 02:15:42 -0500 Subject: Bump to v. 1.09. Update the readme for cheats. Update the github link in source.txt. --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2324d22..3efa802 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -CATSFC version 1.08, 2012-12-20 +CATSFC version 1.09, 2012-12-24 A Super Nintendo emulator for the Supercard DSTWO. @@ -11,6 +11,9 @@ Based on: # Compiling +(If you downloaded the plugin ready-made, you can safely skip this section. + In this case, go to `# Installing`.) + Compiling CATSFC is best done on Linux. Make sure you have access to a Linux system to perform these steps. @@ -42,6 +45,30 @@ To install the plugin to your storage card after compiling it, copy directory. Then, copy the source directory's CATSFC subdirectory to the root of the card. +# Cheats + +The format accepted by the "Load a cheat file" function is equivalent to the +old format used in Mightymo's BSNES Cheat Code Pack. + +1. Download the BSNES Cheat Code Pack at + . It will be a zip archive. +2. Open the zip file, with WinZip, WinRAR or the built-in zip extension in + the operating system on your computer. +3. In the zip file, open the folder called *BSNES Cheat Code Pack*, then + the one called *BSNES v0.51-0.74 Cheat Code Pack*. +4. Open your microSD card's CATSFC folder, then descend into gamecht. +5. Drag the cheat code files from the zip archive to the card's gamecht + folder. +6. In the card's gamecht directory, create two folders. Name the first one + *a-m* and the second one *n-z*. Drag the cheat files from the games whose + name starts with A to M into *a-m* and the rest into *n-z*. + +This is because the directory display does not handle more than 512 files. + +To add cheats to the menu in a game, first load the game, then use the Cheats +menu's "Load a cheat file" option. The option can be touched using the +Touch Screen, but does not activate the menu. So press A. + # The font The font used by CATSFC is now similar to the Pictochat font. To modify it, -- cgit v1.2.3 From 328b5bd6c17330d5213ed28c6fa29ca9a2fac444 Mon Sep 17 00:00:00 2001 From: Nebuleon Fumika Date: Mon, 24 Dec 2012 15:44:44 -0500 Subject: Readme to version 1.10. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3efa802..b842ac3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -CATSFC version 1.09, 2012-12-24 +CATSFC version 1.10, 2012-12-24 A Super Nintendo emulator for the Supercard DSTWO. -- cgit v1.2.3