two-torial-sp2xpatcher/README.md

93 lines
4.3 KiB
Markdown
Raw Normal View History

2024-06-21 21:11:16 +02:00
# [TWO-TORIAL](https://two-torial.xyz)'s Spice2x Patcher
2024-06-21 21:11:16 +02:00
### URL: `https://sp2x.two-torial.xyz/`
2024-06-21 21:11:16 +02:00
## About
2024-06-21 21:11:16 +02:00
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.
2024-06-23 14:04:44 +02:00
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!
2024-06-21 21:11:16 +02:00
## Usage
See our guide on [spice2x patching](https://two-torial.xyz/extras/patchsp2x/) and use the url provided above.
2024-06-23 14:04:44 +02:00
<details><summary><h2>Contributing</h2></summary>
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/`
## JSON Naming
**Spice2x patches have one json file per game version**.
It 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 [peinfo.py](https://github.com/akitakedits/peinfo) script 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.
## 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](https://github.com/akitakedits/port_sp2x_patches) 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.
</details>
<details><summary><h2>Supported Games</h2></summary>
*Click on a game's name to reveal supported versions.*
<details><summary><b>beatmania IIDX 30 RESIDENT</b></summary>
### [LDJ-003] `bm2dx.dll`
- 2023-09-05 - [LDJ-64ef0ff5_1037754](LDJ-64ef0ff5_1037754.json)
### [LDJ-010] `bm2dx.dll`
- 2023-09-05 - [LDJ-64ef0ec9_844b10](LDJ-64ef0ec9_844b10.json)
### [LDJ-012] `bm2dx.dll`
- 2023-09-05 - [LDJ-64ef1153_777dc0](LDJ-64ef1153_777dc0.json)
</details>
<details><summary><b>beatmania IIDX 31 EPOLIS</b></summary>
### [LDJ-012] `bm2dx.dll`
- 2023-10-18 - [LDJ-65290d78_9254f0](LDJ-65290d78_9254f0.json)
- 2024-03-05 - [LDJ-65de809d_94e9bc](LDJ-65de809d_94e9bc.json)
- 2024-04-15 - [LDJ-661758fa_95ceec](LDJ-661758fa_95ceec.json)
- 2024-05-07 - [LDJ-662a0a1f_98f11c](LDJ-662a0a1f_98f11c.json)
- 2024-06-05 - [LDJ-665e9f8f_9a384c](LDJ-665e9f8f_9a384c.json)
### [LDJ-010] `bm2dx.dll`
- 2023-12-06 - [LDJ-656d3226_a145e0](LDJ-656d3226_a145e0.json)
- 2024-03-25 - [LDJ-65fbdb9b_a29c4c](LDJ-65fbdb9b_a29c4c.json)
- 2024-05-07 - [LDJ-662a05c7_a5bf9c](LDJ-662a05c7_a5bf9c.json)
</details>
<details><summary><b>Sound Voltex Exceed Gear</b></summary>
### [KFC] `soundvoltex.dll`
- 2021-12-14 - [KFC-61b19602_57ac68](KFC-61b19602_57ac68.json)
- 2024-01-16 - [KFC-659f91b3_696318](KFC-659f91b3_696318.json)
- 2024-01-30 - [KFC-65b1fc65_69c278](KFC-65b1fc65_69c278.json)
- 2024-02-06 - [KFC-65bb66cb_69cfb8](KFC-65bb66cb_69cfb8.json)
- 2024-02-20 - [KFC-65cda95b_6a5748](KFC-65cda95b_6a5748.json)
- 2024-03-18 - [KFC-65f174e7_6ae218](KFC-65f174e7_6ae218.json)
- 2024-04-02 - [KFC-66039c56_6be478](KFC-66039c56_6be478.json)
- 2024-04-30 - [KFC-6629f133_6bcea8](KFC-6629f133_6bcea8.json)
- 2024-05-21 - [KFC-6643ed55_663968](KFC-6643ed55_663968.json)
- 2024-06-04 - [KFC-6656ee0c_664a78](KFC-6656ee0c_664a78.json)
2024-06-26 12:01:29 +02:00
- 2024-06-25 - [KFC-667290d9_665948](KFC-667290d9_665948.json) (**INCOMPLETE**)
</details>
</details>