Home

Awesome

gbforth Build Status

A Forth-based Game Boy development kit

It features a Forth-based assembler, a cross-compiler with support for lazy code generation and a library of useful words.

Read the documentation.

Contributing

The best way to contribute would be try to write a game! Then we can, at the same time, improve gbforth to make it more useful.

For more detailed guidelines read the contribution guide.

Also have a look to the issues in GitHub:

Install

Dependencies

brew install gforth

Build

To build the examples, run

make examples

Tests

To run the tests, you need to have nodejs and yarn installed. Make sure to install the dependencies in the test/ directory first:

( cd test/; yarn )

After that you can run the tests:

make check

Running with Docker

You can run gbforth in Docker using the amshackers/gbforth image:

docker run amshackers/gbforth

To compile your project, mount your project directory as a volume and pass the input and output file as CLI arguments:

docker run --rm -v "$PWD":/data amshackers/gbforth game.fs game.gb