#libSFX A Super Nintendo assembler development framework featuring:
- Basic system runtime for initialization and interrupt handling.
- 65816 register size tracking macros to minimize rep/sep instructions (and mental overhead).
- Full set of memcpy/memset routines for efficiently transferring data to different parts of the system.
- Some useful data structures with allocation and accessor macros (FIFO and FILO are currently implemented).
- S-SMP communication and SPC playing routines.
- LZ4 decompression.
- ROM image validation via SuperFamicheck.
- Sublime Text syntax definitions.
Look in the the include files (*.i) in the libSFX directory for full documentation of the library features.
libSFX is developed by David Lindecrantz and distributed under the terms of the MIT license.
##dependencies GNU Make and a decent command line interface.
##building
First you need to build ca65, which is included as a git submodule. Run git submodule init and git submodule update to fetch the submodules, then run make to build.
Now that the toolchain is in place you can run make in any of the example directories to assemble the source files and link a Super Nintendo ROM image (*.sfc).
##setting up a project For the most basic setup, copy "examples/Template" to a location of your liking. Then edit "Makefile" and make sure that libsfx_dir points to the libSFX subdirectory in the project root.
For project customization (for example extending the ROM size from the default 1 megabit configuration or changing the default stack and scratchpad sizes) the build script looks for two files inside the project directory; "libSFX.cfg" and "Map.cfg". If these aren't found (like in the Template project), the defaults inside "libSFX/Configurations" are used.
To override the defaults, simply copy these two files into your project directory and edit them to your liking. In libSFX/Configurations there's a couple more Map.cfg examples, and you can also check out the SixteenMegaPower example project (which uses a whopping 64 x 32kB ROM banks and a healthy amount of save RAM).
##work in progress
- More fleshed out examples.
- Macros for handling common CPU/PPU register flags.
- Asset conversion tools.
##acknowledgments libSFX includes the following code and snippets: