aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJuan J. Martínez <jjm@usebox.net>2022-09-16 11:08:35 +0000
committerJuan J. Martínez <jjm@usebox.net>2022-09-16 11:08:35 +0000
commitde06bed752f82eb5fad659f9945261fbff185241 (patch)
tree23d7fdb24453a3a1378f81d021567616492bbdbd /README.md
parent290c74b70661bcde314f73fde2be888e5aed47e0 (diff)
parent1ef0d697a62eff28115d6642c850ba4d01ef6a89 (diff)
downloadubox-msx-lib-de06bed752f82eb5fad659f9945261fbff185241.tar.gz
ubox-msx-lib-de06bed752f82eb5fad659f9945261fbff185241.zip
Merge branch 'cas-support' into 'main'
Added CAS support to the example game See merge request reidrac/ubox-msx-lib!32
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index dfbd8f3..301e856 100644
--- a/README.md
+++ b/README.md
@@ -80,6 +80,28 @@ An example game is included with the libraries and it can be built with:
After a successful build, the game ROM should be in `./bin`.
+#### CAS support
+
+Although the focus is cartridge ROMs, CAS files (and audio) is still one of the
+cheapest ways of loading homebrew games on a real MSX.
+
+Optionally, is possible to generate a CAS file of the example game running:
+
+ make game-cas
+
+After a successful build, the game CAS should be in `./bin`.
+
+The CAS support has some limitations:
+
+ - It requires 32K of extra RAM.
+ - The compressed ROM must be less than 24576 bytes.
+ - The loader uses the BIOS, so it won't be fast.
+ - Machines with disk must have it disabled (by pressing shift on boot), to
+ have more memory available.
+
+Despite these limitations, it is worth considering releasing your game in CAS
+format as well as cartridge ROM.
+
### Building the docs
The documentation is available at