Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/ClusterM/coolboy-multirom-builder.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexey 'Cluster' Avdyukhin <clusterrr@clusterrr.com>2022-12-07 22:28:14 +0300
committerAlexey 'Cluster' Avdyukhin <clusterrr@clusterrr.com>2022-12-07 22:28:14 +0300
commit9f199ae0e02196273dcd608ac0dc262f546cf3a7 (patch)
treea20889c9d2d0d13e085e9660a251fa3709fcbc17
parent4360c3b84fa6942527476c24b97829e839ff3f30 (diff)
parent5d499c8005384c48b87bf6e949c0b12080d2550d (diff)
Merge branch 'master' of github.com:ClusterM/coolboy-multirom-builder
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index a898e59..a1e68bb 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ It can:
## How to build a ROM
This package contains multiple tools which need to run sequentially. There is Makefile, so you can use [Make](https://www.gnu.org/software/make/) tool to automatize the whole process. This is the most simple way. Windows users can use [msys2](https://www.msys2.org/) to install and run Make or just run build.bat (not customizable, not recommended).
-But you need to create game list first.
+But you need to create game list and save it in the "configs" directory first.
### Game list format
It's just a text file. Lines started with semicolon are comments. Other lines has format:
@@ -86,7 +86,7 @@ Possible options:
* **BADSECTORS** - use as `BADSECTORS=0,5,10` - specify list of bad sectors if you need to write cartridge with bad flash memory, default is none
* **REPORT** - use as `REPORT=report.txt` - specify file for human-readable build report, default is none
* **ENABLE_SOUND** - use as `ENABLE_SOUND=1` - enable or disable sound in the loader menu, default is `ENABLE_SOUND=1`
-* **STARS** - use as `STARS=30` - amount of background stars in the loader menu, default is `STARS=30`, maximum is `STARS=62`
+* **STARS** - use as `STARS=30` - amount of background stars in the loader menu, maximum is `STARS=62`, default is `STARS=30`
* **STARS_DIRECTION** - use as `STARS_DIRECTION=1` - direction of background stars in the loader menu, `STARS_DIRECTION=0` - down to up, `STARS_DIRECTION=1` - up to down, default is up to down
* **STAR_SPAWN_INTERVAL** - use as `STAR_SPAWN_INTERVAL=90` - spawn interval of background stars in the loader menu, default is `STAR_SPAWN_INTERVAL=90`
* **ENABLE_RIGHT_CURSOR** - use as `ENABLE_RIGHT_CURSOR=1` - show or hide right cursor in the loader menu, default is `ENABLE_RIGHT_CURSOR=1`
@@ -112,7 +112,7 @@ Save output ROM as UNIF file:
`make unif GAMES=games.list OUTPUT_UNIF=output.unf`
-## Which games are supported
+## Games compatibility
COOLBOY supports games with **NROM** (mapper #0) and **MMC3** (mapper #4) mappers only. NROM is used by simple games without any mapper and MMC3 is the most popular mapper, so games support is good but not perfect. Also, most non-MMC3 games can be patched to run on a MMC3 mapper without any problem. Make sure that PRG RAM and CHR size requirements are met (see ["supported cartridges" section below](README.md#which-cartridges-are-supported-how-to-select-which-cartridge-to-buy)).
And one more thing about some weird buggy games. COOLBOY always uses writable CHR RAM even original game uses CHR ROM and it has not 'read-only' mode. So if game with CHR ROM writes to a ROM for some weird reason, CHR data will be corrupted. It can be fixed using ROM patches. Example game: Cowboy Kid.