diff --git a/vitepress/docs/src/pages/getting_started/intro.md b/vitepress/docs/src/pages/getting_started/intro.md index c0d8660..85cb3bf 100644 --- a/vitepress/docs/src/pages/getting_started/intro.md +++ b/vitepress/docs/src/pages/getting_started/intro.md @@ -7,75 +7,88 @@ import { image_settings } from '../../static/image_settings' # EyeTrackVR {.text-3xl .font-bold .underline .text-[#ab5ac7]} -Open source and *affordable* VR eye tracker platform for Social VR Games via `OSC` and `UDP` protocol. +EyeTrackVR is a Source First, affordable eye-tracking platform designed specifically for Virtual Reality—especially for Social VR experiences like VRChat. It works by sending real-time eye tracking data over `OSC` or `UDP`, making it compatible with many existing VR applications. -### Welcome to the EyetrackVR documentation website. Here you will find all available documentation regarding building, development, and other resources related to this project. +Whether you're here to build your own tracker, contribute to development, or explore how it works, you're in the right place. -Want to get started? Check out the [getting started page](https://docs.eyetrackvr.dev/getting_started/things_to_know) and then the [full build guide.](https://docs.eyetrackvr.dev/how_to_build/full_build) +--- + +## Get Started + +This documentation covers everything from assembly and firmware setup to headset mounting and safety. If you're new to the project, we recommend starting with the following pages: + +- [Things to Know](https://docs.eyetrackvr.dev/getting_started/things_to_know) – Important background before diving in +- [Full Build Guide](https://docs.eyetrackvr.dev/how_to_build/full_build) – Step-by-step assembly instructions - + -## About IR Emitter Safety +--- -Please *exercise caution* when messing around with IR emitters. +## Eye Safety Notice -IR can be dangerous to your eyes once at a certain power level. It is not recommended to use different emitters unless you know exactly what you are doing as it could result in harm to your eyes. -If you doubt yourself, just do exactly what we do. Don't use different emitters, don't use different means of power, etc. +Eye safety is a top priority. Infrared (IR) light is invisible but not harmless—especially at close distances and high intensities. EyeTrackVR has built-in safety measures, but users must also follow proper precautions. + +**Always use the recommended LEDs, wiring, and firmware settings.** ::: danger -It is important that you **DO NOT BYPASS (OR NOT DO) ANY SAFETY FEATURES PUT IN PLACE**. This can result in irreversible bodily harm. +Never bypass safety features or swap out IR components without understanding the risks. Doing so could result in permanent eye damage. ::: -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 that you do not feel warmth or experience short-term effects after being exposed to the IR light (symptoms such as dark spots or dry/warm feeling eyes while actively using). While we strive to make EyeTrackVR as safe as possible, we do not hold any responsibility for damage done. +Our default configuration stays well below international safety thresholds (see [ICNIRP guidelines](../safety/ICNIRP_optical_radiation.pdf)), but it's your responsibility to: + +- Use non-focused emitters +- Keep total radiant intensity below **5 mW/sr** +- Verify LED brightness with an IR camera +- Stop using the device if you feel warmth or discomfort in your eyes - + -::: details Want to see the safety data sheets? -[Effect of infrared radiation on the lens](../safety/effect_of_ir_on_the_lens.pdf) - -[AN002_Details on photobiological safety of LED light sources](../safety/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf) - -[Training-library Nir Stds](../safety/training-library_nir_stds_20021011.pdf) - -[ICNIRP: Guidelines of limits of exposure to broad-band incoherent optical radiation (0.38 to 3 µm)](../safety/ICNIRP_optical_radiation.pdf) +::: details Safety References +[Effect of infrared radiation on the lens](../safety/effect_of_ir_on_the_lens.pdf) +[Photobiological safety of LED light sources](../safety/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf) +[ICNIRP Guidelines (0.38 to 3 µm)](../safety/ICNIRP_optical_radiation.pdf) +[Training Library – NIR Standards](../safety/training-library_nir_stds_20021011.pdf) ::: -## Hardware +--- -Please check out our [parts list](https://docs.eyetrackvr.dev/how_to_build/parts_list) and [hardware repo.](https://github.com/EyeTrackVR/EyeTrackVR-Hardware) for information regarding hardware. +## Hardware Overview + +See our [Parts List](https://docs.eyetrackvr.dev/how_to_build/part_list) and [Hardware Repository](https://github.com/EyeTrackVR/EyeTrackVR-Hardware) to source components, print mounts, and prepare your setup. ## Firmware -Our firmware called OpenIris is made by `lorow` found [here](https://github.com/lorow/OpenIris). +The firmware powering EyeTrackVR's ESP32 cameras is called **OpenIris**, developed by `lorow`. +You can find it [here on GitHub](https://github.com/EyeTrackVR/OpenIris). -## Headset support +--- -In theory, we are compatible with every VR headset. However, mounts may not have been made yet. -Please take a look at our list of [3d printable mounts](https://docs.eyetrackvr.dev/how_to_build/parts_list#_3d-printed-mounts) and see if your headset is on the list. -If it is not listed, It is recommended that you try to make a mount, or wait for a skilled community member to create one. +## Headset Compatibility -#### Contact +EyeTrackVR can work with any VR headset—but not every model has a 3D-printed mount available yet. -Please join our discord for updates and any questions. We hope to see you there! +Check our [mount list](https://docs.eyetrackvr.dev/how_to_build/parts_list#_3d-printed-mounts) to see if your headset is supported. +If not, you’re welcome to design your own or wait for a community-sourced version. - +--- + +## Community & Support + +Join our Discord server for updates, and community projects. We’re excited to have you on board! + + -# Licenses -[![GitHub license](https://img.shields.io/github/license/EyeTrackVR/EyeTrackVR?style=plastic)](https://github.com/EyeTrackVR/EyeTrackVR/blob/main/LICENSE) -***All software is under the [MIT License](http://opensource.org/licenses/MIT). -All documentation, including the [Wiki](https://github.com/EyeTrackVR/EyeTrackVR/wiki), is under the Creative Commons CC-BY-SA-4.0 license***. diff --git a/vitepress/docs/src/pages/index.md b/vitepress/docs/src/pages/index.md index 661feb4..5933e9a 100644 --- a/vitepress/docs/src/pages/index.md +++ b/vitepress/docs/src/pages/index.md @@ -6,7 +6,7 @@ head: content: EyeTrackVR (ETVR) VR Virtual Reality Eye Tracking VRChat Social VR Games VR Game VR Games VRChat Avatar VRChat Avatars VRChat Eye Tracking VRChat Eye Tracking Avatar VRChat Eye Tracking Avatars hero: name: EyeTrackVR Docs - text: Open-source and affordable VR eye tracking. + text: Source First and affordable VR eye tracking. image: src: /logo_light.png alt: ETVR logo @@ -20,8 +20,8 @@ hero: link: https://github.com/EyeTrackVR/EyeTrackVR features: - icon: ⚡️ - title: Open Source - details: fully open source and free to use. + title: Source First + details: open and free to use. - icon: 🎉 title: Community Driven details: built by you for you.