Cool_Tools/two-torial-sp2xpatcher
1
0
Fork 0
mirror of https://github.com/two-torial/sp2xpatcher.git synced 2024-11-30 14:54:27 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add CONTRIBUTING.md

Browse Source
This commit is contained in:
Akitake 2024-06-23 14:04:44 +02:00
parent c1e6d0c444
commit 40e35578ba
2 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,21 @@
# Contributing
You may help the community by contributing patches.
## How?
**Fork** the project, **add/modify** files, propose a **Pull Request** and we'll get to it asap.
**Important Note:** When adding a new game version, add it to the [List of supported games](SUPPORTED.md) using the existing format, we won't merge your PR until you do.
Once a pull request is merged, patches will be available within minutes at `https://sp2x.two-torial.xyz/`
## 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.
## JSON Naming
**Spice2x patches have one .json file per game version**, which needs to be **[named in a very specific way](https://github.com/spice2x/spice2x.github.io/wiki/patches.json-specification#pe-identifier)** to be recognized by the [Spice2x 'Import from URL'](https://github.com/spice2x/spice2x.github.io/wiki/Patching-DLLs-(hex-edits)#importing-patches-from-a-url) feature.
A python script called [peinfo.py](https://github.com/akitakedits/peinfo) is available to help you figure that name out for your provided game's dll file.
Check out [peinfo's README](https://github.com/akitakedits/peinfo/blob/main/README.md) for more information.

4
README.md
View File

@ -6,8 +6,10 @@
## About
This repo contains patches to use with [Spice2x 'Import from URL'](https://github.com/spice2x/spice2x.github.io/wiki/Patching-DLLs-(hex-edits)#importing-patches-from-a-url) feature.
We'll be keeping the **repo public** and **url alive** for as long as possible, **feel free to contibute patches** for the community through pull requests!
We'll be keeping the **repo public** and **url alive** for as long as possible, **feel free to [contibute patches](CONTRIBUTING.md)** for the community through pull requests!
## Usage
See our guide on [spice2x patching](https://two-torial.xyz/extras/patchsp2x/) and use the url provided above.
## [Contributing](CONTRIBUTING.md)