{"id":20200416,"url":"https://github.com/jakzo/vr-input-viewer","last_synced_at":"2025-03-03T08:43:04.052Z","repository":{"id":188962756,"uuid":"678660743","full_name":"jakzo/vr-input-viewer","owner":"jakzo","description":"Visualization of VR controller and headset inputs and positions. Useful for streams and recordings.","archived":false,"fork":false,"pushed_at":"2023-11-23T10:02:51.000Z","size":6221,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-13T20:14:32.299Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jakzo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-15T04:09:40.000Z","updated_at":"2023-12-15T00:40:06.000Z","dependencies_parsed_at":"2024-11-14T04:43:47.620Z","dependency_job_id":"bcc55ef9-d121-4e0b-877c-a3f7e59549fd","html_url":"https://github.com/jakzo/vr-input-viewer","commit_stats":null,"previous_names":["jakzo/vr-input-viewer"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jakzo%2Fvr-input-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jakzo%2Fvr-input-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jakzo%2Fvr-input-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jakzo%2Fvr-input-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jakzo","download_url":"https://codeload.github.com/jakzo/vr-input-viewer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241637153,"owners_count":19994925,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T04:43:36.591Z","updated_at":"2025-03-03T08:43:04.024Z","avatar_url":"https://github.com/jakzo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e **🚧 Still in BETA. Expect bugs. 🚧**\n\nVisualization of VR controller and headset inputs and positions. Useful for streams and recordings.\n\nCurrently works with SteamVR.\n\n## ➡️ Quick links\n\n- [Download VR Input Viewer](https://github.com/jakzo/vr-input-viewer/releases/latest)\n- [VR Input Viewer web version](#TODO) (for viewing inputs from another machine/device)\n- [How to add new headsets and controller layouts](#🎮-how-to-add-new-headsets-and-controller-layouts)\n\n## 🎮 How to add new headsets and controller layouts\n\n- Clone this repository then follow [development setup instructions](#🛠️-development-setup) below\n- Follow [instructions to add a new controller layout](./packages/vr-input-viewer/src/Controller/Layouts/README.md)\n- Follow [instructions to add a new headset model](./packages/vr-input-viewer/assets/headsets/README.md)\n- Follow [instructions to add a new controller model](#TODO)\n- Open a pull request with your changes so that everyone can use your new layout/headset 🙂\n\n## 🛠️ Development setup\n\n- Clone with submodules\n  - When first cloning: `git clone --recursive THIS_REPO_URL`\n  - Or if already cloned: `git submodule update --init --recursive`\n- Install [Node.js](https://nodejs.org/en/download)\n  - Recommended: Install [nvm](https://github.com/nvm-sh/nvm) instead of Node.js and run `nvm install`/`nvm use` in this repository\n- Install native module build tools\n  - Node.js Windows installer will prompt if you want to install these\n- (optional) Install [Flatbuffers](https://flatbuffers.dev/)\n  - Installing Flatbuffers is not required if you will not be modifying the input data format\n  - Mac: `brew install flatbuffers`\n- (optional) Set up C++ node-addon-api development\n\n  - If using VSCode, add a `.vscode/c_cpp_properties.json` file in this project with contents:\n\n    ```json\n    {\n      \"version\": 4,\n      \"configurations\": [\n        {\n          \"name\": \"default\",\n          \"defines\": [\"NAPI_DISABLE_CPP_EXCEPTIONS\"],\n          \"includePath\": [\n            \"${workspaceFolder}/node_modules/node-addon-api\",\n            \"${workspaceFolder}/packages/vr-ffi/src/**\",\n            \"${workspaceFolder}/packages/vr-ffi/deps/openvr/headers\",\n            \"~/.nvm/versions/node/v20.2.0/include/node\" // \u003c- replace with your directory\n          ]\n        }\n      ]\n    }\n    ```\n\n- Install dependencies\n  - `npm install`\n- Run the input viewer locally\n  - Desktop app: `npm -w @jakzo/vr-input-viewer-desktop run start`\n  - Web app: `npm -w @jakzo/vr-input-viewer-web run dev`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjakzo%2Fvr-input-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjakzo%2Fvr-input-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjakzo%2Fvr-input-viewer/lists"}