Merge branch 'master' into pr328

doc/iidxhook/README.md

@@ -48,6 +48,8 @@ Available implementations that can be swapped out depending on which kind of IO
 use:
 
 - `iidxio`: Default implementation supporting keyboard, mouse and USB game controllers
+- [iidxio-async](iidxhook/iidxio-async.md): Shim implementation that runs another iidxio implementation in a dedicated
+  thread
 - [iidxio-bio2](iidxhook/iidxio-bio2.md): Support BIO2 hardware
 - [iidxio-ezusb](iidxhook/iidxio-ezusb.md): Support C02 ezusb FX hardware
 - [iidxio-ezusb2](iidxhook/iidxio-ezusb2.md): Support IO2 ezusb FX2 hardware

doc/iidxhook/iidxhook9.md

@@ -6,6 +6,7 @@ The following games are compatible with this version of iidxhook:
 - BISTROVER
 - CASTHOUR
 - RESIDENT
+- EPOLIS
 
 The games must be bootstrapped using [launcher](../launcher.md).
 
@@ -57,7 +58,7 @@ unpacked data looks like this:
   - Unpack the package containing iidxhook9 into the root folder so iidxhook9.dll and all other
     files are located in the same folder as *data*, *prop*, *bm2dx.dll*, etc.
 
-- For version 30
+- For version 30-31
 
   - Unpack the package containing iidxhook9 into the `modules` folder so iidxhook9.dll and all other
     files are located in the same folder as the game's DLLs, e.g. *bm2dx.dll*, etc.
@@ -93,6 +94,12 @@ The syntax for the "key=value" is the same as in the config file. Make sure to h
 However, if a parameter is specifed in the configuration file and as a command line argument, the
 command line argument overrides the config file's value.
 
+# Note on camhook
+
+The cammera hook (camhook) is used to allow other class compliant cameras to be used. Depending on the variant of the game, you will need to select the correct camera port layout.
+
+For original LDJ, this is always 0, for conversion kit LDJ and original TDJ-JA, this is 1, and for TDJ-JB this will be 2 (this case is rare / you will know if this is needed on your setup).
+
 # Eamuse network setup
 
 If you want to run the games online, you need a valid PCBID and the service URL. Open

doc/iidxhook/iidxio-async.md

@@ -0,0 +1,22 @@
+# IIDXIO async API implementation
+
+This implementation of the iidxio API is a shim library that takes another iidxio library and
+runs the functions `iidx_io_ep1_send`, `iidx_io_ep2_recv` and `iidx_io_ep3_write_16seg` in a
+dedicated thread. State synchronization to the getter and setter functions is also handled
+transparently.
+
+Usage of this **may** improve performance of certain iidxio implementations or when using them
+in certain integrations, e.g. the send and receive functions of a iidxio implementation for some
+target IO hardware calls are synchronous and expensive. 
+
+This is not a fix/solution to a badly implemented iidxio library with poor performance as it cannot
+make it go faster and address potential latency issues, for example.
+
+Use with caution and know why and when you need to use it.
+
+## Setup
+
+* Add `iidxio-async.dll` in the same folder as your `iidxhookX.dll`
+* Rename your `iidxio.dll` to `iidxio-async-child.dll`
+* Rename `iidxio-async.dll` to `iidxio.dll`
+* Run the game

doc/tools/d3d9-monitor-check.md

@@ -0,0 +1,27 @@
+# D3D9 Monitor Check
+
+A separate application to run the infamous IIDX “monitor check” without having to run the actual
+game. The tool can be used to test measure the current avg. monitor refresh rate or debug/check if
+that value is fluctuating for some reason.
+
+The final avg. value that is provided at the end of the test can be used as input for other tooling
+or settings (e.g. patching charts to a different refresh rate on older games with bemanitools).
+
+Simply run the tool without any arguments to get a full synopsis with usage instructions.
+
+## "Accuracy" remarks
+
+The tool has been tested on an actual cabinet with `nvgpu` setting different custom timings. The
+accuracy seems to be even higher than what IIDX’s monitor check is actually showing. For example,
+with a custom timing of 59.900 hz, this tool yields fairly accurate and stable avg. 59.902 hz.
+
+The monitor check of IIDX 29 shows results of 59.8981 hz to 59.8997 hz on screen. As these are the
+only visible values to the user, determining a specific (avg.) value that can be used as input for
+other tooling or settings (e.g. patching charts to a different refresh rate on older games with
+bemanitools) is difficult. This doesn't mean that the game's monitor checks are actually
+inaccurate or wrong. Modern games with a built-in monitor check (starting IIDX 20) are syncing up
+fine and don't need any further patching or modifications.
+
+For older games, picking a value that is not as close as possible to an accurate avg. value can
+easily lead to issues with sync. So it's recommended to use the d3d9-monitor-check tool to get the
+most accurate value.