This project has moved to GitLab: https://gitlab.com/reidrac/ubox-msx-lib
⚠️ Important: This project has moved to GitLab. For the latest code, see: https://gitlab.com/reidrac/ubox-msx-lib
This is a set of libraries and tools to make MSX games using the C programming language.
There are three main components:
The aim is making MSX games in C, without writing Z80 assembler or having a deep knowledge of the system.
If you want to build the example you will also need:
On Windows 10, there are reports of successful builds using:
If you want to build the docs you will also need:
To build the libraries run:
make
After a successful build, the libraries should be in ./lib
.
The include files are ready to use in ./include
.
Add those directories in SDCC
's search path and you are ready to go.
Note: make
is expected to be run from the root of the repo. The PATH env
variable will be set automatically.
An example game is included with the libraries and it can be built with:
make game
After a successful build, the game ROM should be in ./bin
.
The documentation is available at usebox.net, so this is optional.
To build the docs run:
make docs
The reference in HTML
format will be generated in ./docs
.
All contributions are welcome.
If you think you have found a bug, please submit a bug report providing some information:
Some advice if you want to make a successful contribution:
This was mostly written by Juan J. Martinez during the development of Night Knight and Uchūsen Gamma.
Other contributors:
This software is distributed under MIT license, unless stated otherwise.
See COPYING file.
TL;DR: the only condition is that you are required to preserve the copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code; this includes any game made with the help of this software.
Credit is appreciated, but is not a legal requirement. For example: you can add to the game's documentation a note like "This game uses ubox MSX lib".
There are some third party tools included here for convenience and are covered by their own license or are public domain.