ShuriZma
/
Cxbx-Reloaded
mirror of https://github.com/Cxbx-Reloaded/Cxbx-Reloaded.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Shorten links, formatting

Margen67 2021-06-11 12:48:40 -10:00
parent 797e066a6a
commit e2e563dcf8
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
HLE-v2-Database-Method.md

@ -1,5 +1,5 @@
### Creating an OOVPA ### Creating an OOVPA
See [here](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/wiki/Maintaining-OOVPAs-for-HLE-function-detection#too-long-didnt-read). See [here](Maintaining-OOVPAs-for-HLE-function-detection#too-long-didnt-read).
The OOVPA method itself has not changed. The OOVPA method itself has not changed.
@ -7,10 +7,10 @@ The OOVPA method itself has not changed.
Once an OOVPA has been added, replaced, or removed, the HLE v2 database needs to be updated. Once an OOVPA has been added, replaced, or removed, the HLE v2 database needs to be updated.
This is a requirement in order to compile properly. This is a requirement in order to compile properly.
- Any time an OOVPA has been lowered, the OOVPA itself must be moved into a specific revision database file. * Any time an OOVPA has been lowered, the OOVPA itself must be moved into a specific revision database file.
- If a new OOVPA is replaced with a better OOVPA, please comment the whole obsolete OOVPA section for preservation purposes with a comment stating "replaced with \_version\_". * If a new OOVPA is replaced with a better OOVPA, please comment the whole obsolete OOVPA section for preservation purposes with a comment stating "replaced with \_version\_".
- Whenever you find a specific OOVPA is causing 100% false detection please comment it out, and create a correct OOVPA signature for it. * Whenever you find a specific OOVPA is causing 100% false detection please comment it out, and create a correct OOVPA signature for it.
- There are high chances of ability to make generic OOVPAs. * There are high chances of ability to make generic OOVPAs.
When you discover a preexisting OOVPA or OOVPA you made is indeed generic and does match correctly the highest XDK version which is 5849, please add a comment stating "Generic OOVPA as of \_XDK_version\_ and newer". When you discover a preexisting OOVPA or OOVPA you made is indeed generic and does match correctly the highest XDK version which is 5849, please add a comment stating "Generic OOVPA as of \_XDK_version\_ and newer".
**Also check with lower XDK titles to be sure if it's possible to add at starting point of the XDK version.** **Also check with lower XDK titles to be sure if it's possible to add at starting point of the XDK version.**
@ -19,9 +19,9 @@ When you discover a preexisting OOVPA or OOVPA you made is indeed generic and do
REGISTER_OOVPAS(/*Name of OOVPA*/, /*documentation flag*/, /*XDK versions*/, ...), REGISTER_OOVPAS(/*Name of OOVPA*/, /*documentation flag*/, /*XDK versions*/, ...),
``` ```
`Documentation flag` should only be used for either XREF, PATCH, or UNPATCHED. `Documentation flag` should only be used for either XREF, PATCH, or UNPATCHED.
- `XREF` defined as XREF purpose with no patch necessary. * `XREF` defined as XREF purpose with no patch necessary.
- `PATCH` define as using with a patch. (It's okay if a patch has an xref included.) * `PATCH` define as using with a patch. (It's okay if a patch has an xref included.)
- `UNPATCHED` should only be used when a patch is no longer necessary. * `UNPATCHED` should only be used when a patch is no longer necessary.
(Usually a result of Hybrid LLE, or certain low level APIs are patched and is able to be emulated properly.) (Usually a result of Hybrid LLE, or certain low level APIs are patched and is able to be emulated properly.)
### Register new OOVPA ### Register new OOVPA
@ -31,10 +31,10 @@ For example:
```c ```c
REGISTER_OOVPAS(XAudioCalculatePitch, XREF, 3911, 4039), REGISTER_OOVPAS(XAudioCalculatePitch, XREF, 3911, 4039),
``` ```
If you do not understand how `REGISTER_OOVPAS` work, please use the search bar then choose the "code" tab to understand how it works. If you don't understand how `REGISTER_OOVPAS` work, please use the search bar then choose the "code" tab to understand how it works.
### Recommendation ### Recommendation
- Keep notes on what hasn't been verified in the HLE v2 database file. * Keep notes on what hasn't been verified in the HLE v2 database file.
- Use specific version title if you are able to discover almost to full compiled library. * Use specific version title if you are able to discover almost to full compiled library.
(Doing this way does speed up add all missing OOVPAs detection.) (Doing this way does speed up add all missing OOVPAs detection.)
- Please do add library version and title's name to the note to keep track of known title might or does contain almost to full library compiled. * Please do add library version and title's name to the note to keep track of known title might or does contain almost to full library compiled.