Layout and grammatical fixes
This commit is contained in:
Burrito
GitHub
parent
6dcc63ed07
commit
098bcd2ea4
102
README.md
102
README.md
@ -1,90 +1,84 @@
|
||||
<div align="center">
|
||||
<br/>
|
||||
<p>
|
||||
<img src="https://github.com/xiaopeng12138/WACVR/blob/main/PreviewImages/WACVR-LOGO.png?raw=true" width="546" />
|
||||
</p>
|
||||
<br/>
|
||||
<p>
|
||||
<h2><i>
|
||||
an open source vr arcade simulator
|
||||
</i></h2>
|
||||
</p>
|
||||
<p>
|
||||
<a href="https://discord.gg/4aFV5QJWN5"><img src="https://img.shields.io/discord/1028269444780261436?color=5865F2&logo=discord&logoColor=white" alt="Discord server"/></a>
|
||||
<a href="https://github.com/xiaopeng12138/WACVR/actions"><img src="https://github.com/xiaopeng12138/WACVR/actions/workflows/build.yml/badge.svg" alt="Build status"/></a>
|
||||
</div>
|
||||
|
||||
## Preview
|
||||
<img src="https://github.com/xiaopeng12138/WACVR/blob/main/PreviewImages/Preview.png?raw=true" width="350" />
|
||||
|
||||
# WACVR
|
||||
<img src="https://github.com/xiaopeng12138/WACVR/blob/main/PreviewImages/WACVR-LOGO.png?raw=true" width="250" />
|
||||
a open source vr arcade simulator
|
||||
|
||||
**Preview**
|
||||
---
|
||||
<img src="https://github.com/xiaopeng12138/WACVR/blob/main/PreviewImages/Preview.png?raw=true" width="250" />
|
||||
|
||||
**About this project**
|
||||
---
|
||||
|
||||
## About this project
|
||||
- Model is almost 1:1 to physical cabinet
|
||||
- Supports every game version
|
||||
- The model is almost 1:1 to cabinet/framework
|
||||
- Supports native touch input via serial (com0com required)
|
||||
- Supports lights/LEDs (via hook)
|
||||
- Customizable haptic feedback
|
||||
- 3rd person camera and smooth camera
|
||||
- 4 customizable buttons
|
||||
- 3rd person and smoothed 1st person cameras
|
||||
- LIV avatars/mixed reality
|
||||
|
||||
**Supported platform**
|
||||
---
|
||||
|
||||
## Supported platforms
|
||||
- All SteamVR devices (Index，HTC，Oculus, etc.)
|
||||
- All Oculus devices (Oculus Desktop App)
|
||||
- Tested on: Quest 2 through Oculus link (Native and via SteamVR), ALVR and Virtual Desktop (via SteamVR).
|
||||
|
||||
**Used repository**
|
||||
---
|
||||
|
||||
## Repositories used
|
||||
- [uWindowCapture](https://github.com/hecomi/uWindowCapture)
|
||||
- [MaiDXR](https://github.com/xiaopeng12138/MaiDXR)
|
||||
|
||||
**Declaimer**
|
||||
---
|
||||
|
||||
- This project is non-profit and some resources came from Internet!
|
||||
## Disclaimers
|
||||
- This project is not-for-profit and some resources came from the Internet!
|
||||
- Although this is under the GPL-3.0 license, do not use any content of this repo in commercial/profitable scenarios without permission!
|
||||
- Please support your local arcade if you can!
|
||||
|
||||
**How to use**
|
||||
---
|
||||
## How to use
|
||||
- Get the game somehow and make sure it runs properly. (DO NOT ASK ANYTHING THAT IS DIRECTLY RELATED TO THE GAME ITSELF)
|
||||
- Download [the nightly version of WACVR](https://nightly.link/xiaopeng12138/WACVR/workflows/build/main/artifact.zip).
|
||||
- You have 2 ways to connect touch to the game:
|
||||
|
||||
- Get the game somehow and make sure it will run properly. (DO NOT ASK ANYTHING THAT IS DIRECTLY RELATED TO THE GAME ITSELF)
|
||||
- Download [the nightly version of WACVR](https://nightly.link/xiaopeng12138/WACVR/workflows/build/main/artifact.zip)
|
||||
- You have 2 ways to connect the touch to the game:
|
||||
### mercuryio
|
||||
- Download [mercuryio.dll](https://xpengs.com/s/wacvr/mercuryio.dll).
|
||||
- Put ``mercuryio.dll`` into ``bin`` folder.
|
||||
- Add ``[mercuryio] path=mercuryio.dll`` to .ini file.
|
||||
- Start the game and WACVR.
|
||||
|
||||
- **mercuryio:**
|
||||
- Download [mercuryio.dll](https://xpengs.com/s/wacvr/mercuryio.dll)
|
||||
- Put mercuryio.dll into ``bin`` folder
|
||||
- Add ``[mercuryio] path=mercuryio.dll`` to .ini file
|
||||
- Start game and WACVR
|
||||
|
||||
- **Serial (not recommended):**
|
||||
### Serial (not recommended)
|
||||
|
||||
- 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, COM4 and COM6.
|
||||
- You must enable the enable buffer option in com0com on both ports of all pairs. Otherwise, your WACVR will crash after the logo.
|
||||
- Add "[touch] enable=0" to .ini file
|
||||
- Enable the ``enable buffer overrun`` option in com0com on both ports of all pairs. Otherwise, your WACVR will crash after the logo.
|
||||
- Add ``[touch] enable=0`` to .ini file
|
||||
- Start WACVR first then start the game.
|
||||
- If your touch is not working, try to enable somehow Test mod then exit Test mode.
|
||||
- If your touch is not working, try to somehow go to Test mode then exit Test mode.
|
||||
|
||||
- The lighting requires ``mercuryio.dll``. You must setup it up to get the light effect from the game. If you don't have the light effect, pls check if you are using the latest tools and if your LED hook works.
|
||||
- The lighting requires ``mercuryio.dll``. You must set it up to get the lights from the game. If you don't have the lights, please check if you are using the latest tools and if your LED hook works.
|
||||
|
||||
**Configuration**
|
||||
---
|
||||
## Configuration
|
||||
A ``config.json`` file is automatically created in WACVR's root directory on startup.
|
||||
|
||||
A ``config.json`` is automatically created in the WACVR's root dir on startup
|
||||
|
||||
- You can change the ``config`` via the in-game config panel. Just please take a step back. The controller pointer will automatically be disabled when the controller is too close to the cabinet.
|
||||
- Some extra option is only available in ``config.json``. For example:
|
||||
- You can change this file via the in-game config panel. Please take a step back: the controller pointer will automatically be disabled when the controller is too close to the cabinet.
|
||||
- Some extra options are only available in ``config.json``. For example:
|
||||
- ``"CaptureDesktopNumber:"``
|
||||
- ``"SpectatorSmooth:"``
|
||||
- Some configs in ``config.json`` are only the index of the dropdown.
|
||||
- You can use the pointer to point the third-person camera and grab it to the position where you want to be.
|
||||
|
||||
**Building guide**
|
||||
---
|
||||
- Some options in ``config.json`` are only the index of the dropdown in the panel.
|
||||
- You can use the pointer to point the 3rd-person camera and move it to the position you want it to be.
|
||||
|
||||
## Building guide
|
||||
- Current Unity version: 2021.3.11f1
|
||||
- for mercuryio, just replace files in mercuryio folder with files in this repo.
|
||||
|
||||
**Current issue**
|
||||
---
|
||||
|
||||
- display white screen issue
|
||||
## Known issues
|
||||
- Display white screen issue
|
||||
**Solution:** Set game priority in the task manager to real-time may solve this issue. But the best way is just by capturing the entire screen.
|
||||
|
||||
Huge thanks to everyone that helped with this project!
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user