Unity Sparse Peripheral Display

Welcome to the Unity Sparse Peripheral Display repository! This Unity project aims to expand the field of view (FoV) in virtual reality using strategically placed LEDs within a VR headset. The Arudino code for receiving the colour values and controlling the LEDs is provided in the Arduino Sparse Peripheral Display repository.

Table of Contents

• Introduction
• Features
• Installation
• Usage
• Contributing
• License
• Contact

Introduction

The Unity Sparse Peripheral Display project explores a novel approach to enhance the virtual reality experience by utilizing LEDs to extend the field of view (FoV). By intelligently integrating these LEDs and controlling them, the project aims to create a more immersive and engaging VR environment.

Features

• LED Integration: Use LED technology to create a sparse peripheral display and offer a wider FoV.
• Demo Scene: Included demo scene showcases the concept of sparse peripheral display.
• Easy Integration: Designed for seamless integration into existing Unity VR projects.
• Customizability: Adapt LED configurations, colors, and placement to your specific needs.

Installation

Clone the entire Unity Project

1. Clone this repository to your local machine using:

git clone https://github.com/marius7600/unity-sparse-peripheral-display.git

1. Open the project in Unity (version 2021.3.14f1 or later).

Custom Unity Package

For your convenience, I have prepared a custom Unity package containing all the necessary assets for the Unity Sparse Peripheral Display project.

You can download the package from the Releases section. To import the package into your Unity project, follow these steps:

1. Download the latest release package (unity-sparse-peripheral-display.unitypackage).
2. In your Unity project, open the Assets menu.
3. Select Import Package > Custom Package.
4. Choose the downloaded unity-sparse-peripheral-display.unitypackage file.
5. Follow the import wizard to add the assets to your project.

Please note that the Unity package includes all the necessary assets, scripts, and prefabs required for seamless integration of the sparse peripheral display concept into your VR project.

Usage

Using the Unity Project

To integrate the sparse peripheral display concept into your Unity VR project, follow these steps:

1. Import the necessary assets from the Unity Sparse Peripheral Display project.
2. In your existing project click on Edit > Project Settings... > Player > Other Settings
3. Change Api Compatibility Level to .NET Framework
4. Study the demo scene to understand LED positioning and control.
5. Attach the LightProbeKnot to the head of your player
6. Customize LED configurations to match your VR headset and desired FoV expansion.

Using the Custom Unity Package

To make the integration of the Unity Sparse Peripheral Display assets in your existing Unity VR project, we have provided a custom Unity package that bundles all the required assets.

To use this package, follow these steps:

1. Download the latest release package (unity-sparse-peripheral-display.unitypackage-v.x.x.x) from the Releases section.
2. In your Unity project, navigate to the Assets menu.
3. Choose Import Package > Custom Package.
4. Select the downloaded unity-sparse-peripheral-display.unitypackage file.
5. Follow the prompts to complete the import process.
6. Click on Edit > Project Settings... > Player > Other Settings
7. Change Api Compatibility Level to .NET Framework
8. Attach the LightProbeKnot to the head of your player

The Unity package encompasses everything needed for a smooth integration of the sparse peripheral display concept into your VR project.

Contributing

Contributions are welcome! To contribute, follow these steps:

1. Fork the repository.
2. Create a new branch for your feature: git checkout -b feature-name.
3. Make your changes and commit them.
4. Push to the branch: git push origin feature-name.
5. Open a Pull Request detailing your changes.

License

This project is licensed under the MIT License.

Contact

If you have questions, suggestions, or feedback, contact me at marius@roehm.dev.