diff --git a/README.md b/README.md index 45b0de6..e7289dd 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,45 @@ # MaiDXR -VR Arcade Simulator +This is a VR Arcade Simulator + +# About this fork +- This project is a update of https://github.com/xiaopeng12138/MaiMai-VR. + +## Inspired by +https://github.com/derole1/MaiMai-VR +https://github.com/HelloKS/MaiMai-VR + +## Used repository +https://github.com/HelloKS/MaiMai-VR +https://github.com/hecomi/uWindowCapture +https://github.com/Sucareto/Mai2Touch + +## Supported plattform +- SteamVR +- Oculus +Tested on Quest 2 through Oculus link (Native and via SteamVR) +The Hand Balls position is currently only adjusted for the Quest 2 controller. Other controllers may have a bad experience. This will be fixed in the future + +## Declaimer +This project is non-profit and some resources came from Internet! +Do not use this in commercial/profitable scenarios! +Please support your local arcade if you can! + +# Changelog +Please see Changes.md + +# How to use +- Download [latest version of MaiDXR](https://github.com/xiaopeng12138/MaiDXR/releases) +- Download and install [com0com](https://storage.googleapis.com/google-code-archive-downloads/v2/code.google.com/powersdr-iq/setup_com0com_W7_x64_signed.exe) +- Configure com0com to bind COM3 and COM5 (it must be these two ports) +- Disable DummyTouchPanel +- Run game in window mode and make sure there is no black bar +- Start MaiDXR +- Enable somehow Test mod then exit Test mode. + +# ToDo +- Add user-adjustable settings (controller position etc.) +- Add non-VR window and camera smooth +- Add button light +- Add button vibration + +Huge thanks to HelloKS and derole1