Created IIDX Camera Hook (markdown)

IIDX-Camera-Hook.md

@@ -0,0 +1,62 @@
+## IIDX Camera Hook
+
+### Requirements
+Requires compatible DLL; spice2x should work with most DLLs, with notable exceptions:
+
+* For IIDX 27, only the final datecode is supported out of the box.
+* IIDX 30 003 does not support camera at all.
+
+For cameras:
+* Most modern USB webcams should work, as long as it supports `YUY2` or `NV12` format.
+* Some software camera emulators will work, while others will not. Devices must show up in Windows Media Foundation in order for Spice to access them.
+    * If you want to use your smartphone, try something like [Camo Studio](https://reincubate.com/camo/).
+    * Notably, *OBS Virtual Cam* doesn't work as it can only output to DirectShow.
+      * Look into [2dxcamhook](https://github.com/aixxe/2dxcamhook) instead which uses another protocol (Spout).
+
+### Camera options overlay
+To adjust camera parameters (brightness, exposure, focus, etc), go to the Overlay tab in spicecfg, and bind a key to `Toggle Camera Control`. Bring this up in-game and adjust your camera.
+
+### FAQ
+
+#### Camera is not detected in game or test menu
+Check the log for messages from `tdjcam`. Most likely, your DLL is not supported.
+
+#### My DLL is not supported?
+If you know the offsets for your DLL, you can override them using `IIDX TDJ Cam Hook Offset Override (-iidxtdjcamhookoffset)` option. Take a look at [this repo](https://github.com/aixxe/2dxcamhook/tree/master/versions) for examples. 
+
+#### My camera is cut off / squished / wrong aspect ratio
+Bring up the camera control overlay and change the draw settings.
+
+#### I want to flip / rotate / mirror my camera image
+As of version `24-09-14` this is possible to do in the Camera Control overlay.
+
+Note: `IIDX Camera Order Flip (-iidxflipcams)` does not "flip" your camera image, it's for changing which of your cameras is used for FRONT vs. TOP camera.
+
+#### Image is low resolution / low FPS
+Bring up the camera control overlay and change the resolution/framerate settings.
+
+#### I'm trying to display only my controller but the top camera view is cut off
+One of the camera layout option in game is to only display the control deck. This needs a manual "focus". Go to test menu, `I/O Check`, `Camera Check` and change the `TRIMMING` value until the red box is located where you desire.
+
+#### What I see in Test Menu and in-game are completely different
+It's to be expected, the game just does that - namely, the displayed aspect ratio is different. Adjust aspect ratio and cropping options during the song in the camera overlay menu.
+
+#### Camera options in test menu do not work
+This is by design. Use the camera control overlay instead.
+
+#### I have two cameras and they are in the wrong order (front and top cameras)
+Use `IIDX Camera Order Flip (-iidxflipcams)` option.
+
+#### I have three or more cameras and spice is picking up the wrong ones
+Update to `spice2x-24-11-20` and use `-iidxtdjcamhooktop` and `-iidxtdjcamhookfront` options.
+
+#### Can I combine TDJ camera hook with play record feature?
+Yes! It'll work as you expect, **but**:
+
+Make sure your webcam is bound to the `top` camera and not the `front` camera. The game will intentionally blank out the front face camera in recordings, so you **must** use the top camera for play record feature. Check or uncheck `IIDX Camera Order Flip` option to switch the ordering.
+
+Also, be mindful of your privacy as the recorded video with your camera feed will be uploaded to your EA server. spice2x has no control over where your videos are uploaded or how it's shared.
+
+#### Turning on camera hook causes unstable monitor check / high CPU usage
+
+Cameras are always on while the game is running. Lower the resolution and refresh rate for your camera using the camera overlay. You really don't need anything higher than 720p.