From e2e563dcf87111a6547d619eb3fc8e50d35a490b Mon Sep 17 00:00:00 2001 From: Margen67 Date: Fri, 11 Jun 2021 12:48:40 -1000 Subject: [PATCH] Shorten links, formatting --- HLE-v2-Database-Method.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/HLE-v2-Database-Method.md b/HLE-v2-Database-Method.md index fa5bcfb..eb55a08 100644 --- a/HLE-v2-Database-Method.md +++ b/HLE-v2-Database-Method.md @@ -1,5 +1,5 @@ ### 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. @@ -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. 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. -- 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. -- There are high chances of ability to make generic OOVPAs. +* 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\_". +* 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. 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.** @@ -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*/, ...), ``` `Documentation flag` should only be used for either XREF, PATCH, or UNPATCHED. -- `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.) -- `UNPATCHED` should only be used when a patch is no longer 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.) +* `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.) ### Register new OOVPA @@ -31,10 +31,10 @@ For example: ```c 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 -- 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. +* 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. (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. \ No newline at end of file +* 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. \ No newline at end of file