Check out the Project Wiki for the development log
A custom game resource creation software suite is being developed for the inaugural JCAP release!
JCAP is a project with the goal of developing a JAMMA arcade standard compatible game board using the Parallax Propeller 1 (P8X32A) microcontroller upon which a user can implement their own custom arcade game, either from scratch or by using the library of graphics, sound, input, and other drivers developed under the project. Ultimately, the project will provide all of the following in such a way that a user has everything they need to implement their own arcade game and have a PCB printed to build it on:
- VGA video driver
- Sprite/tile based graphics driver
- PWM sound driver
- Serialized input driver
- Game engine
- Board schematic
- PCB .gerber files
- PCB BOM
Contribution Guidelines
On the off chance anyone is interested in contributing to JCAP, there are some basic standards which should be ahered to:
- Document everything! For code documentation, use existing code (e.g. Dev/Input/Software/input.spin) as an example. PASM should be documented somewhat anal-retentively, line-by-line, with block comments for routines and subroutines. Header comments should follow the same standard established by existing code as well.
- Any discovered problems/concerns/features that you won't be addressing with your current commit need to have an issue created and assigned to the appropriate person(s), tag, milestone, and project. This eliminates the risk of development amnesia. Additionally, when a commit has satisfied an issue, the commit hash should be referenced in the closing comment of the issue.
- Commit messages need to at a minimum broadly describe each change made to the repository. Whether it's fixing a bug, adding a feature, adding a new datasheet, or updating some indentation, one should be able to read the commit message and understand immediately what's been done to the repo.
- Any documents (manuals, datasheets, tutorials) which are critical to your contributions should be placed in their appropriate subdirectories in /Docs. For similarly important generic links, place them in "Useful Links.txt" in /Docs.
Pull requests that don't follow these guidelines will be rejected until corrections have been made. While this all may seem like an over-processed waste of time, an auxiliary goal for JCAP is to create a project which maintains the highest possible standards to prevent headache down the road and belay confusion to anyone on the outside looking in.
Current Contributors
The following individuals have contributed to JCAP:
- Connor Spangler (cspang1)
- Marko Lukat (konimaru)