https://github.com/jakzo/vr-input-viewer
Visualization of VR controller and headset inputs and positions. Useful for streams and recordings.
https://github.com/jakzo/vr-input-viewer
Last synced: 3 months ago
JSON representation
Visualization of VR controller and headset inputs and positions. Useful for streams and recordings.
- Host: GitHub
- URL: https://github.com/jakzo/vr-input-viewer
- Owner: jakzo
- Created: 2023-08-15T04:09:40.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-23T10:02:51.000Z (over 1 year ago)
- Last Synced: 2025-01-13T20:14:32.299Z (5 months ago)
- Language: TypeScript
- Size: 5.93 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> **🚧 Still in BETA. Expect bugs. 🚧**
Visualization of VR controller and headset inputs and positions. Useful for streams and recordings.
Currently works with SteamVR.
## ➡️ Quick links
- [Download VR Input Viewer](https://github.com/jakzo/vr-input-viewer/releases/latest)
- [VR Input Viewer web version](#TODO) (for viewing inputs from another machine/device)
- [How to add new headsets and controller layouts](#🎮-how-to-add-new-headsets-and-controller-layouts)
## 🎮 How to add new headsets and controller layouts
- Clone this repository then follow [development setup instructions](#🛠️-development-setup) below
- Follow [instructions to add a new controller layout](./packages/vr-input-viewer/src/Controller/Layouts/README.md)
- Follow [instructions to add a new headset model](./packages/vr-input-viewer/assets/headsets/README.md)
- Follow [instructions to add a new controller model](#TODO)
- Open a pull request with your changes so that everyone can use your new layout/headset 🙂
## 🛠️ Development setup
- Clone with submodules
- When first cloning: `git clone --recursive THIS_REPO_URL`
- Or if already cloned: `git submodule update --init --recursive`
- Install [Node.js](https://nodejs.org/en/download)
- Recommended: Install [nvm](https://github.com/nvm-sh/nvm) instead of Node.js and run `nvm install`/`nvm use` in this repository
- Install native module build tools
- Node.js Windows installer will prompt if you want to install these
- (optional) Install [Flatbuffers](https://flatbuffers.dev/)
- Installing Flatbuffers is not required if you will not be modifying the input data format
- Mac: `brew install flatbuffers`
- (optional) Set up C++ node-addon-api development
- If using VSCode, add a `.vscode/c_cpp_properties.json` file in this project with contents:
```json
{
"version": 4,
"configurations": [
{
"name": "default",
"defines": ["NAPI_DISABLE_CPP_EXCEPTIONS"],
"includePath": [
"${workspaceFolder}/node_modules/node-addon-api",
"${workspaceFolder}/packages/vr-ffi/src/**",
"${workspaceFolder}/packages/vr-ffi/deps/openvr/headers",
"~/.nvm/versions/node/v20.2.0/include/node" // <- replace with your directory
]
}
]
}
```
- Install dependencies
- `npm install`
- Run the input viewer locally
- Desktop app: `npm -w @jakzo/vr-input-viewer-desktop run start`
- Web app: `npm -w @jakzo/vr-input-viewer-web run dev`