NESFab is a new programming language for creating NES games.
src/
) is licensed under GPL 3.0 (see COPYING
).lib/
), examples (examples/
), and documentation (doc/
) are licensed under the Boost Software License 1.0 (See lib/LICENSE_1_0.txt
).TL;DR: If you make a game using NESFab, your code can remain private, and you do not need to include attribution in your binary release.
Requirements:
libboost-program-options-dev
package)NESFab can be built in either debug mode, or release mode.
To build in debug mode, run:
make debug
To build in release mode, run:
make release
By default, the compiler builds executables for the x86-64 architecture.
To target others, specify a blank ARCH
flag:
make ARCH=release
By default, the NESFab compiler builds binaries that use unofficial ("illegal") instructions. To force the compiler to only use official ones, compile the compiler with the following flag:
make ISA=legal
Post bug reports on the Github issues page and include a minimal reproducible example if possible.
When testing bugs, use the debug-mode compiler. It gives far better diagnostics.
Small fixes are welcome and can be submitted as Github pull requests. For anything larger, open a Github issue prefixed with "Contrib Request:" and what you'd like to do, and await approval before starting.
If you made a project using NESFab, please get in touch! It would be great to hear about.