sdvxio-kfca: add some docs and address some comments

2019-12-01 13:32:09 -05:00
parent a5d3c32bed
commit 5b09ab4aea
3 changed files with 23 additions and 2 deletions
@@ -0,0 +1,14 @@
+This library talks to a KFCA node through ACIO and implements the sdvxio API of BT5.
+Thus, it allows you to use a KFCA device board with *any* version of SDVX that is supported by BT5.
+
+# Setup
+* Rename sdvxio-kfca.dll to sdvxio.dll.
+* Ensure that your gamestart.bat actually injects the appropriate sdvxhook dll,
+for example:
+```
+launcher -K iidxhook2.dll soundvoltex.dll ...*
+```
+* sdvxio-kfca expects a KFCA device on COM3 by default
+* You can change the port by settings the SDVXIO_KFCA_PORT envvar
+* If there is also an ICCA device on the same ACIO bus, it cannot be used with eamio-icca at this time
+* Please connect any additional acio devices to their own port (ex: SDVX5 expects an ICCA by itself on COM2)