Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ams-hackers/gbforth
👾 A Forth-based Game Boy development kit
https://github.com/ams-hackers/gbforth
dmg forth game-development gameboy retro z80
Last synced: 2 months ago
JSON representation
👾 A Forth-based Game Boy development kit
- Host: GitHub
- URL: https://github.com/ams-hackers/gbforth
- Owner: ams-hackers
- License: mit
- Created: 2018-04-26T16:52:53.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2023-10-11T01:14:32.000Z (8 months ago)
- Last Synced: 2024-01-24T12:33:57.621Z (5 months ago)
- Topics: dmg, forth, game-development, gameboy, retro, z80
- Language: Forth
- Homepage: https://gbforth.org
- Size: 770 KB
- Stars: 116
- Watchers: 9
- Forks: 8
- Open Issues: 74
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-gbdev - gbforth - A Forth-based Game Boy development kit. (Software Development / Compilers)
- awesome-gb-dev-zh - gbforth
README
# gbforth [](https://github.com/ams-hackers/gbforth/actions/workflows/ci.yml?query=branch%3Amain)
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](https://ams-hackers.github.io/gbforth/).
## 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](https://ams-hackers.github.io/gbforth/contribute)**.
Also have a look to the issues in GitHub:
- [General issues](https://github.com/ams-hackers/gbforth/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+-label%3Aconformance+)
- [ANS Conformance issues](https://github.com/ams-hackers/gbforth/milestones)
## 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](https://hub.docker.com/r/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
```