diff --git a/docs/README.md b/docs/README.md index 3269c5b..e703d33 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,26 +1,20 @@ ---- -layout: default -title: EyeTrackVR -nav_exclude: true -has_children: false -permalink: index.html ---- +[![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) [![Build Github Pages Source Code](https://github.com/redhawk989/EyeTrackVR/actions/workflows/build-jekyll.yml/badge.svg?branch=docs)](https://github.com/redhawk989/EyeTrackVR/actions/workflows/build-jekyll.yml) [![Deploy to Github Pages](https://github.com/redhawk989/EyeTrackVR/actions/workflows/pages/pages-build-deployment/badge.svg?branch=docs)](https://github.com/redhawk989/EyeTrackVR/actions/workflows/pages/pages-build-deployment) ![Website](https://img.shields.io/website?down_color=red&down_message=Git%20Pages%20is%20Down%21&style=plastic&up_color=blue&up_message=Git%20Pages%20is%20Up%21&url=https%3A%2F%2Fredhawk989.github.io%2FEyeTrackVR%2F) -[![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) - -## 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 **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 NON-focused emitters and at around 5ma total power." %} +##### 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. + +[![Discord](https://discord.com/api/guilds/946212245187199026/widget.png?style=banner3)](https://discord.gg/kkXYbVykZX) + +# Licenses [![GitHub license](https://img.shields.io/github/license/RedHawk989/EyeTrackVR?style=plastic)](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***. -
- Open Licenses -
+ + +[Top](#eyetrackvr)