Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eyetrackvr/eyetrackvr

Open Source and Affordable, Virtual Reality Eye Tracking Platform.
https://github.com/eyetrackvr/eyetrackvr

chilloutvr eye-tracking eyetracker eyetracking neosvr virtual-reality vr vrchat

Last synced: 6 days ago
JSON representation

Open Source and Affordable, Virtual Reality Eye Tracking Platform.

Host: GitHub
URL: https://github.com/eyetrackvr/eyetrackvr
Owner: EyeTrackVR
License: gpl-3.0
Created: 2021-12-27T22:18:04.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2025-01-08T22:04:52.000Z (29 days ago)
Last Synced: 2025-01-31T16:04:39.952Z (6 days ago)
Topics: chilloutvr, eye-tracking, eyetracker, eyetracking, neosvr, virtual-reality, vr, vrchat
Language: Python
Homepage: https://docs.eyetrackvr.dev
Size: 114 MB
Stars: 838
Watchers: 22
Forks: 69
Open Issues: 6
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        ![GitHub Logo](https://i.imgur.com/DNW11Yt.png)

Picture courtesy of Wackalope#6737

[![GitHub issues](https://img.shields.io/github/issues/RedHawk989/EyeTrackVR?style=plastic)](https://github.com/RedHawk989/EyeTrackVR/issues) [![GitHub forks](https://img.shields.io/github/forks/RedHawk989/EyeTrackVR?style=plastic)](https://github.com/RedHawk989/EyeTrackVR/network) [![GitHub stars](https://img.shields.io/github/stars/RedHawk989/EyeTrackVR?style=plastic)](https://github.com/RedHawk989/EyeTrackVR/stargazers)

- [EyeTrackVR](#eyetrackvr)

      - [This project is in development and is not fully finished](#this-project-is-in-development-and-is-not-fully-finished)

  - [Hardware](#hardware)

  - [About IR Emitter Safety](#about-ir-emitter-safety)

        - [Make sure you are using NON-focused emitters and at around 5ma total power](#make-sure-you-are-using-non-focused-emmiters-and-at-around-5ma-total-power)

  - [Firmware](#firmware)

  - [Headset support](#headset-support)

      - [Contact](#contact)

- [Licenses](#licenses)

Active Development: [V2 App Branch](https://github.com/EyeTrackVR/EyeTrackVR/tree/v2.0-beta-feature-branch)

### [Documentation](https://docs.eyetrackvr.dev/)

# EyeTrackVR

Open source and *affordable* VR eye tracker platform for [VRChat](https://hello.vrchat.com/) via `OSC` and `UDP` protocol.

> **Note**: This project is in development and is not fully finished

## Documentation

Please check out our [documentation site.](https://docs.eyetrackvr.dev/)

## Hardware

3d files for mounting brackets can be found [here](https://github.com/RedHawk989/EyeTrackVR-Hardware)

IR emitter PCB files are also located there, along with pre-soldered PCBs on the [official store](https://store.eyetrackvr.dev/). For more info, please reference our [documentation site](https://docs.eyetrackvr.dev/how_to_build/parts_list)

## ESP32 Cam Firmware

Current work has been with our official firmware by `lorow` and `ZanzyTHEbar`, found [here](https://github.com/EyeTrackVR/OpenIris).

## Headset support

Pretty much any headset that can fit the camera and LEDs can be supported. However, mounts may not have been made for it. Please reference our [parts list](https://docs.eyetrackvr.dev/how_to_build/parts_list#_3d-printed-mounts) for linked mounts and [create your own mount page](https://docs.eyetrackvr.dev/how_to_build/creating_your_own_mount) for details.

## About IR Emitter Safety

Please *exercise extreme caution* when messing around with IR emitters.

Once safety testing has been completed links and files will be provided for the emitters. Please make sure you know what you are doing when assembling the IR emitters.

 **DO NOT BYPASS (OR NOT DO) ANY SAFETY FEATURES PUT IN PLACE**. This can result in irreversible bodily harm.

The safety measures were put in place to REDUCE the potential failure risk. All further safety responsibilities are on the user.

This includes visually checking with an IR camera that the brightness is correct and making sure you do not feel warmth.

> **Warning**: Make sure you are using **NON-focused** emitters and at power less than ***5mW cm^2 total per eye***.

Please read our LED safety page for a breakdown of math for our V3 and V4 LED kits [here](https://docs.eyetrackvr.dev/getting_started/led_safety)

[Effect of infrared radiation on the lens](https://docs.eyetrackvr.dev/safety/effect_of_ir_on_the_lens.pdf)

[Training-library Nir Stds](https://docs.eyetrackvr.dev/safety/training-library_nir_stds_20021011.pdf)

[AN002_Details on photobiological safety of LED light sources](https://docs.eyetrackvr.dev/safety/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf)

## Contact

Please join our Discord for updates and any questions.

[![Discord](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/kkXYbVykZX)

## Licenses

[![GitHub license](https://img.shields.io/github/license/RedHawk989/EyeTrackVR?style=plastic)](https://github.com/RedHawk989/EyeTrackVR/blob/master/LICENSE)

***All software is under the [GPLv3 License](https://opensource.org/license/gpl-3-0).

All documentation, including the [Wiki](https://github.com/RedHawk989/EyeTrackVR/wiki), is under the Creative Commons CC-BY-SA-4.0 license***.

[Top](#eyetrackvr)