Contributing

You may help the community by contributing patches.

How?

Fork the project if you don't already have it
Add/Modify/Stage/Commit files as necessary BUT don't Push/Sync them yet
Run the checks.py script with python checks.py
If the script did anything: Commit its changes
Push/Sync the changes to your repo
Propose a Pull Request and we'll get to it asap

Once a pull request is merged, patches will be available within minutes at https://sp2x.two-torial.xyz/

/!\ Important Note

When adding a new game version, add it to the List of supported games using the existing format, we won't merge your PR until you do.

JSON Naming

Spice2x patches have one json file per game version.
It needs to be named in a very specific way to be recognized by the Spice2x 'Import from URL' feature.

A python peinfo.py script is available to help you figure that name out for your provided game's dll file.
Check out peinfo's README for more information.

Converting web to json (spice2x) patches

Right now this has to be done manually, however we plan on having tooling available to make this easier.
Look at the files respective structures (html and json) and try to figure it out yourself.

Porting spice2x patches

It is possible to port patches from one version of a game to another.
A python port_sp2x_patches.py script is available to help you through some of that work.
However it will not be able to port all patches and it will not always be 100% accurate, false positives can occur.
Porting patches the script cannot, or fixing false positives will have to be done manually.

2.0 KiB Raw Permalink Blame History