Cardboard XR Kit

Cardboard XR Kit is an open-source Unity starter project maintained by SpatialLab, the XR Lab at Universidad CENFOTEC. It provides a lean baseline for building mobile VR experiences with the Google Cardboard XR Plugin, including a ready-to-run sample scene and curated XR settings to speed up prototyping.

Overview

• Unity LTS ready: Configured for Unity 2021.3.44f1 with Android build support.
• Cardboard-first: Uses the official Google Cardboard XR Plugin for lightweight mobile VR.
• Starter scene: Includes a sample scene to validate rendering, input, and project setup out of the box.
• Extensible: Organize your own assets under Assets/ while keeping XR configuration assets in Assets/XR.

Getting started

Prerequisites

• Unity Hub with Unity 2021.3.44f1 installed.
• Android Build Support (SDK, NDK, and OpenJDK components) added to the Unity Editor.
• An Android device with the Google Cardboard viewer for on-device testing.

Clone the repository

git clone https://github.com/Universidad-CENFOTEC/cardboard-xr-kit.git
cd cardboard-xr-kit

Open in Unity

1. In Unity Hub, click Add project and select the cardboard-xr-kit folder.
2. Open the project with Unity 2021.3.44f1.
3. When prompted, let Unity import dependencies (including the Google Cardboard XR Plugin).

Run the sample scene

1. In the Project window, open Assets/Scenes/SampleScene.unity.
2. Press Play in the Editor to verify that rendering and input work.

Build for Android

1. Go to File → Build Settings….
2. Select Android and click Switch Platform.
3. Ensure XR Plug-in Management lists Cardboard XR Plugin for Android.
4. Click Build and Run with a connected Android device to deploy the sample scene.

Project structure

• Assets/Scenes — sample scene you can extend or replace.
• Assets/XR — XR settings (general settings, loaders, and provider configuration).
• Packages/manifest.json — package dependencies, including the Google Cardboard XR Plugin.
• ProjectSettings/ProjectVersion.txt — Unity Editor version used by the project.

Contributing

This project is proudly maintained by SpatialLab (XR Lab) at Universidad CENFOTEC and the community. Contributions are welcome!

1. Fork the repository and create a feature branch from work.
2. Make your changes and include relevant tests or repro steps.
3. Open a pull request describing your updates and testing.

Support

For questions or collaboration proposals, reach out to SpatialLab via the university channels or open an issue on GitHub.

License

This is an open-source project. If no license file is present, please contact SpatialLab to clarify usage terms before shipping production builds.