archive/CitraVR
1
0
Fork 0
mirror of https://github.com/amwatson/CitraVR.git synced 2024-09-19 10:51:35 +02:00
Code Issues Projects Releases Packages Wiki Activity
No description
10359 commits 1 branch 12 tags 63 MiB
cpp 64.5%
C++ 31%
Kotlin 3.6%
CMake 0.6%
GLSL 0.2%
Find a file
amwatson fca3a62b1a fix compile issues on debug
2024-05-14 15:07:21 -05:00
.ci build: Fix non-PCH build on Linux and add non-PCH verification to CI. (#7351) 2024-01-13 19:58:09 -08:00
.github ci: Update action versions. (#7449) 2024-02-18 08:23:15 -08:00
assets [logo] added white background 2024-02-01 11:13:11 -06:00
CMakeModules build: Improve support for Windows cross-compilation. (#7389) 2024-02-07 21:06:41 -06:00
dist .tx/config: Use language mappings for android "tx pull" (#7422) 2024-02-07 21:06:41 -06:00
externals Restore [fixed] Khronos OpenXR loader path. Remove uses-native-library as it's no longer needed 2024-03-05 18:52:26 -06:00
hooks hook: remove clang-format check 2017-02-17 13:52:23 +02:00
src fix compile issues on debug 2024-05-14 15:07:21 -05:00
.gitattributes Meta: Add gitattributes file 2018-09-22 14:59:15 -06:00
.gitignore Add Kdevelop files to .gitignore (#6951) 2023-09-07 11:52:40 -07:00
.gitmodules fix broken dependencies 2024-05-04 15:10:47 +00:00
CMakeLists.txt build: Improve support for Windows cross-compilation. (#7389) 2024-02-07 21:06:41 -06:00
CONTRIBUTING.md CONTRIBUTING.md: migrate to the wiki 2018-11-08 00:15:55 -05:00
Doxyfile Remove every trailing whitespace from the project (but externals). 2015-05-29 21:59:29 +01:00
license.txt Updating project license to GPLv3 2024-01-17 16:19:33 -06:00
README.md Update README.md 2024-02-01 11:14:59 -06:00

README.md


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.

Compatibillty | Releases | Known Issues | How to Install and Run | Building | Discord | 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
  • Creating a VR app to render 2D interactive windows without an engine
  • 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 emulator Seemed like a great and fun way to demonstrate all these things at once.

The project is still small, but I'm looking for ways to improve it as time goes on.

Features

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

Compatibillty

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 the CitraVR Game Compatability List

Controllers/Input

Touch Controller Input Bindings Diagram

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

Building

Building for Quest

Discord

Join the Flat2VR discord and from there join cvr-join to get access to the CitraVR community and support forums

Need Help?

Please check our Troubleshooting and Known Issues pages to see if your issue is listed. To file a bug report or a feature request, please submit an issue. Otherwise, follow the instructions for Discord and post in cvr-support

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.