mirror of
https://github.com/EyeTrackVR/EyeTrackVR-Docs.git
synced 2025-11-04 14:49:44 +08:00
Update README.md
This commit is contained in:
parent
52f514fad7
commit
b7c70fce5b
@ -1,26 +1,20 @@
|
||||
---
|
||||
layout: default
|
||||
title: EyeTrackVR
|
||||
nav_exclude: true
|
||||
has_children: false
|
||||
permalink: index.html
|
||||
---
|
||||
[](https://github.com/RedHawk989/EyeTrackVR/issues) [](https://github.com/RedHawk989/EyeTrackVR/network) [](https://github.com/RedHawk989/EyeTrackVR/stargazers) [](https://github.com/redhawk989/EyeTrackVR/actions/workflows/build-jekyll.yml) [](https://github.com/redhawk989/EyeTrackVR/actions/workflows/pages/pages-build-deployment) 
|
||||
|
||||
[](https://github.com/RedHawk989/EyeTrackVR/issues) [](https://github.com/RedHawk989/EyeTrackVR/network) [](https://github.com/RedHawk989/EyeTrackVR/stargazers)
|
||||
|
||||
## Table of contents
|
||||
{: .no_toc .text-delta }
|
||||
|
||||
* TOC
|
||||
{:toc}
|
||||
- [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-emitters-and-at-around-5ma-total-power)
|
||||
- [Firmware](#firmware)
|
||||
- [Headset support](#headset-support)
|
||||
- [Contact](#contact)
|
||||
- [Licenses](#licenses)
|
||||
|
||||
# EyeTrackVR
|
||||
{: .no_toc }
|
||||
|
||||
Open source and *affordable* VR eye tracker platform for [VRChat](https://hello.vrchat.com/) via `OSC` and `UDP` protocol.
|
||||
|
||||
This project is in development and is not fully finished
|
||||
{: .fs-5 .fw-300 }
|
||||
#### This project is in development and is not fully finished
|
||||
|
||||
## Hardware
|
||||
|
||||
@ -37,31 +31,39 @@ When files and resources are released <ins>**DO NOT BYPASS (OR NOT DO) ANY SAFET
|
||||
The safety measures were put in place to REDUCE the potential failure risk. All further safety responsibilities is on the user.
|
||||
This includes visually checking with an IR camera that the brightness is correct.
|
||||
|
||||
{% include custom/alerts/Warning.html content="Make sure you are using <b>NON-focused</b> emitters and at around <i><b>5ma total power</b></i>." %}
|
||||
##### Make sure you are using **NON-focused** emitters and at around ***5ma total power***
|
||||
|
||||
[Effect of infrared radiation on the lens](/EyeTrackVR/Reference_Docs/saftey/effect_of_ir_on_the_lens.pdf)
|
||||
[Effect of infrared radiation on the lens](./docs/Reference_Docs/saftey/effect_of_ir_on_the_lens.pdf)
|
||||
|
||||
[Training-library Nir Stds](/EyeTrackVR/Reference_Docs/saftey/training-library_nir_stds_20021011.pdf)
|
||||
[Training-library Nir Stds](./docs/Reference_Docs/saftey/training-library_nir_stds_20021011.pdf)
|
||||
|
||||
[AN002_Details on photobiological safety of LED light sources](/EyeTrackVR/Reference_Docs/saftey/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf)
|
||||
[AN002_Details on photobiological safety of LED light sources](./docs/Reference_Docs/saftey/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf)
|
||||
|
||||
## Firmware
|
||||
|
||||
Current testing has been with `lorow's` firmware found [here](https://github.com/lorow/OpenIris).
|
||||
|
||||
Current testing has been with `loucass003's` firmware found [here](https://github.com/Futurabeast/futura-face-cam).
|
||||
There has been work for a different firmware by a community member but that ***has not been tested by me*** [here](https://github.com/lorow/OpenIris).
|
||||
|
||||
## Headset support
|
||||
|
||||
Initial support will be Quest 2 (pcvr).
|
||||
Initial support will be Quest 2 (pcvr)
|
||||
Support for other headsets from the community.
|
||||
|
||||
Support for other headsets, comes from the community.
|
||||
#### Contact
|
||||
|
||||
### Licenses
|
||||
Please join our discord for updates and any questions.
|
||||
|
||||
[](https://discord.gg/kkXYbVykZX)
|
||||
|
||||
# Licenses
|
||||
|
||||
[](https://github.com/RedHawk989/EyeTrackVR/blob/main/LICENSE)
|
||||
|
||||
***All software is under the MIT license. All hardware materials and designs provided here are licensed under the [CERN-OHL-P](https://opensource.org/CERN-OHL-P){:target="_blank"} hardware license. All software is under the [MIT License](https://opensource.org/licenses/MIT). All documentation, including the Wiki, is under the Creative Commons [CC-BY-SA-4.0 license](https://creativecommons.org/licenses/by-sa/4.0/).***
|
||||
***All software is under the [MIT License](http://opensource.org/licenses/MIT).
|
||||
All documentation, including the [Wiki](https://github.com/RedHawk989/EyeTrackVR/wiki), is under the Creative Commons CC-BY-SA-4.0 license***.
|
||||
|
||||
<div align="center">
|
||||
<img src="./assets/images/licenses/licenses.svg" width="300" alt="Open Licenses" />
|
||||
</div>
|
||||
<!-- <div align="center">
|
||||
<img src="./docs/assets/images/licenses/licenses.svg" width="300" alt="Open Licenses" />
|
||||
</div> -->
|
||||
|
||||
[Top](#eyetrackvr)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user