From f22680629d871e4245799c529c017905390ed52a Mon Sep 17 00:00:00 2001 From: Margen67 Date: Thu, 26 Apr 2018 13:44:51 -0700 Subject: [PATCH] (Attempt to) fix broken English --- HLE-v2-Database-Method.md | 40 ++++++++++++++++++++++++--------------- 1 file changed, 25 insertions(+), 15 deletions(-) diff --git a/HLE-v2-Database-Method.md b/HLE-v2-Database-Method.md index 66fb73c..fa5bcfb 100644 --- a/HLE-v2-Database-Method.md +++ b/HLE-v2-Database-Method.md @@ -1,30 +1,40 @@ -### Create OOVPA -Please review [TLDR section](/Cxbx-Reloaded/Cxbx-Reloaded/wiki/Maintaining-OOVPA's-for-HLE-function-detection#too-long-didnt-read) to understand how to create simple OOVPA. The changes to OOVPA method itself has not change. +### Creating an OOVPA +See [here](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/wiki/Maintaining-OOVPAs-for-HLE-function-detection#too-long-didnt-read). + +The OOVPA method itself has not changed. ### Maintenance -Any time a single OOVPA has been add, replaced, or removed; HLE v2 database need to be update. This is a requirement in order to compile properly. -- Any time OOVPA has been lowered, OOVPA itself must be move in specific revision database file. -- If a new OOVPA is replaced with better OOVPA, please do comment the whole obsolete OOVPA section for preservation purpose with the comment stating "replaced with \_version\_". -- Whenever you find out specific OOVPA is making false detection 100%, please comment it out. Then create a correct OOVPA signature for it. -- There are high chances of ability to make generic OOVPAs. When you do discover existing OOVPA or OOVPA you made is indeed generic and does match correctly with highest XDK version (which is 5849). Please do add a comment stating "Generic OOVPA as of \_XDK_version\_ and newer". **Also check with lower XDK titles to be sure if it is possible to add at starting point of the XDK version.** +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. +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.** ### Method for HLE Database v2 ```c REGISTER_OOVPAS(/*Name of OOVPA*/, /*documentation flag*/, /*XDK versions*/, ...), ``` -`Documentation flag` should be only used 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. -- `PATCH` define as using with a patch. (It is okay if a patch has a xref included.) -- `UNPATCHED` should be only used whenever a patch is no longer become necessary. (Usually result of Hybrid LLE or certain low level APIs are patched and is able to emulate properly.) +- `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 -Once you have done with creating OOVPA. Manually add or update existing register in respective v2 database. For example: +Once you are done with creating an OOVPA, manually add or update it's existing register in respective v2 database. + +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 "code" tab for understanding how it works. +If you do not understand how `REGISTER_OOVPAS` work, please use the search bar then choose the "code" tab to understand how it works. ### Recommendation -- We strongly advise to keep notes what's not been verified in 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 +- 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