Cool_Tools/two-torial-webpatcher
1
0
Fork 0
mirror of https://github.com/two-torial/webpatcher.git synced 2024-11-23 23:20:58 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Akitake 2024-07-01 10:45:02 +02:00
parent 1b191eb62a
commit a4c6606334
No known key found for this signature in database
GPG Key ID: BBB11D6E26F3162D
1 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -5,22 +5,28 @@
## About
This repo contains web patches to use with various games unsupported by [spice2x](https://spice2x.github.io/). We have a [spice2x patcher](https://github.com/two-torial/sp2xpatcher/) for those.
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!
We'll be keeping the **repo public** and **url alive** for as long as possible, **feel free to [contibute](#Contributing)** for the community through pull requests!
## Usage
See our guide on [web patching](https://two-torial.xyz/extras/patchweb/) and use the url provided above.
## Submitting a new game
## Contributing
### A new game
- Add the new game html, it is easiest to copy an existing game and modify it.
The html should be named `[game][release].html` except IIDX because they just
happen to be `[release].html` only...
- Modify the `<title>` tag and the `<h1>` tag to the name of the new game.
- Modify the patcher for the new DLL names/patches.
- Keep consistent indentation for the new patches. We will have to fix your PR if
it contains poor formatting, which will delay the merging process.
- Modify `index.html` to add the new game. Sorting: alphabetical by game series,
then in release order per game.
- Add a game image. 128x128px PNG files, please. Any blank space should be
either white or transparent.
- Keep indentation consistent. We will have to fix your PR if it contains poor formatting, which will delay the merging process.
- Modify `index.html` to add the new game. Sorting: alphabetical by game series, then in release order per game.
- Add a game image. 128x128px PNG files, please. Any blank space should be either white or transparent.
- Create a pull request.
### Patches for an existing game
- Open the game's html.
- If necessary: add a new PatchContainer.
- If necessary: add a new Patcher.
- Add your patches following the existing format.
- Create a pull request.