CitraVR/README.md
2024-01-20 20:39:45 -06:00

3 KiB


CitraVR
CitraVR (Beta)

Play 3DS homebrew and personal game backups in 3D on the go with your Quest.
CitraVR is a GPL-licensed, engineless OpenXR application with all source code publicly available.

Compatibility | Releases | Known Issues | How to Install and Run | Building | Need Help? | Support | License

Introduction

I originally created this project to a be a proof-of-concept of some techniques XR developers were curious about. Specifically:

  • Building a 2D/3D hybrid app
  • Rendering a 2D interactive window of non-VR content in VR
  • Using VR layers to get sharp, crisp text and visuals.

A Quest-native (i.e. OpenXR, without a third-party game engine) port of the Citra 3DS emultor Seemed like a great and fun way to demonstrate all these things at once.

The project is still small, but I'm looking forward to improving it as time goes on.

Features

  • Stereoscopic rendering
  • Broad controller support
  • Large, moveable/resizeable screen
  • Playable in mixed reality
  • low-overhead port
  • Fully-GPL-licesed, 100% independent of the Meta SDK

Compatibility

HMDs

CitraVR supports the following devices:

  • Meta Quest 2
  • Meta Quest Pro
  • Meta Quest 3

Games

For a full list of games that work well on CitraVR, please visit [need link to compat sheet]

Controllers/Input

CitraVR maps the Quest controllers in a way that makes most games on the platform playable with the default mapping.

For games that need access to more inputs, or if a player needs to access more inputs faster, CitraVR also supports a multitude of 3rd party wired USB and wireless bluetooth controllers.

Releases

Grab the latest release here

Known Issues

See the CitraVR Known Issues

How to Install and Run

How to install and run CitraVR on Quest

Building

Building for Quest

Need Help?

Submit an issue, or join the cvr-support channel on Discord

Support

Buy me a beer

You can also buy the original non-VR Citra project a beer

License

CitraVR is licensed under the GPLv3 (or any later version). Refer to the LICENSE.txt file.