Contribution

Please check out the Project Structure section of the wiki to help orient yourself.

If you have any questions, feel free to submit an issue here or @ me in the Slippi discord. Please do not ping anyone other than me regarding support for this repo. The other devs in the Slippi discord are not affiliated with this project and cannot offer support or guidance for it.  

Build

• MSRV is typically stable, no external dependencies are required for the Rust crates.
• py_slp_parse requires Maturin to build and test.

Style & Naming

Rustfmt with no special options set

I tried to strike a balance between "literally correct" and "as close to the slippi wiki as possible". Most names will be familiar for anyone that's worked on a slippi-adjacent project before, but some unclear/conflicting names have been changed (e.g. shield size -> shield health). If you don't know what to call something and it comes from the game, defer to any existing resources (Slippi wiki, SSBM Decomp, SSBM datasheet, etc.) before inventing a name.

Melee-constant names and enums (item names, action states, etc.) should be all caps as that is what is most common in the in-game debug views.