mirror of
https://github.com/two-torial/webpatcher.git
synced 2025-02-20 20:21:39 +01:00
README: add notes about patch submission
This commit is contained in:
parent
c909e2e298
commit
a5e9b9c299
31
README.md
31
README.md
@ -3,4 +3,33 @@ A tool to easily apply known hex edits to any binary, with examples for Bemani g
|
||||
|
||||
Should work on most modern browsers.
|
||||
|
||||
Live version hosted [on my website](https://mon.im/bemanipatcher/).
|
||||
Live version hosted [on my website](https://mon.im/bemanipatcher/).
|
||||
|
||||
## Asking about new patches
|
||||
These days, I do not create the patches. Everything is community submitted.
|
||||
If you would like new hex edits, make them yourself and make a pull request!
|
||||
|
||||
## Submitting a new game
|
||||
Here is your checklist:
|
||||
- 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. I 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.
|
||||
|
||||
If your pull request is a single commit, I will rebase and merge. If it is
|
||||
multiple commits, I will squash and merge.
|
||||
|
||||
Please do not worry about submitting "bad" PRs. If there is something wrong, I
|
||||
will tell you how to fix it or I will fix it myself before merging.
|
||||
|
||||
Submitting a PR for an n-0 game is frowned upon in the general community and
|
||||
might make you disliked. The BemaniPatcher repository does not judge, and **I
|
||||
will merge n-0 patches**, but please be mindful that your submission may have
|
||||
unintended consequences for you.
|
||||
|
Loading…
x
Reference in New Issue
Block a user