docs: update intro, parts list,

This commit is contained in:
Prohurtz 2023-02-09 19:38:33 -06:00
parent 29d9bd4be2
commit a2f76487d9
5 changed files with 44 additions and 21 deletions

View File

@ -20,6 +20,6 @@ export default defineConfig({
},
lastUpdated: true,
title: 'EyeTrackVR Docs',
description: 'The official documentation for EyeTrackVR',
description: 'The official documentation for EyeTrackVR. Opensource and affordable VR eye tracking.',
themeConfig: theme,
})

View File

@ -9,6 +9,17 @@ import { image_settings } from '../../static/image_settings'
Open source and *affordable* VR eye tracker platform for Social VR Games via `OSC` and `UDP` protocol.
### Welcome to the EyetrackVR documentation website. Here you will find all avalable documentation regauding building, development, and other resources related to this project.
Want to get started? Check out the [getting started page](../getting_started/things_to_know) and then the [full build guide.](../how_to_build/full_build)
<Alerts :options="alerts.user_warning">
<template v-slot:content>
<p>
@ -18,20 +29,16 @@ Open source and *affordable* VR eye tracker platform for Social VR Games via `OS
</template>
</Alerts>
## Hardware
Please check out our [Parts list](../how_to_build/parts_list/) and our [full build guide](../how_to_build/full_build/) along with our [hardware repo.](https://github.com/RedHawk989/EyeTrackVR-Hardware)
## About IR Emitter Safety
Please *exercise extreme caution* when messing around with IR emitters.
Please *exercise caution* when messing around with IR emitters.
Once safety testing has been completed links and files will be provided for the emitters. {.italic .underline}
Please do not try to make, or use any emitters unless you know exactly what you are doing as it could be very harmful to your eyes if not done correctly.
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, dont use differnt means of power, etc.
::: danger
When files and resources are released <ins>**DO NOT BYPASS (OR NOT DO) ANY SAFETY FEATURES PUT IN PLACE**</ins>. This can result in irreversible bodily harm.
It is important that you <ins>**DO NOT BYPASS (OR NOT DO) ANY SAFETY FEATURES PUT IN PLACE**</ins>. 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 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.
@ -52,18 +59,23 @@ The safety measures were put in place to REDUCE the potential failure risk. All
[Training-library Nir Stds](../saftey/training-library_nir_stds_20021011.pdf)
:::
## Hardware
Please check out our [parts list](../how_to_build/parts_list) and [hardware repo.](https://github.com/RedHawk989/EyeTrackVR-Hardware) for information regauring hardware.
## Firmware
Our firmware called OpenIris is made by `lorow` found [here](https://github.com/lorow/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](../how_to_build/parts_list#other-parts) 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.
#### Contact
Please join our discord for updates and any questions.
Please join our discord for updates and any questions. We hope to see you there!
<ImageCard :options="image_settings.discord_content"/>

View File

@ -105,8 +105,13 @@ If you are a Patreon please check out discount codes available to you, and also
- 1x Soldering iron and solder (lead-free solder highly recommended) Generic soldering iron from [AliExpress here](https://www.aliexpress.com/item/3256801448141079.html) or [Amazon here](https://www.amazon.com/Liouhoum-Auto-Sleep-Adjustable-Temperature-Thermostatic/dp/B08PZBPXLZ/ref=sr_1_9)
## 3D Printed Mounts
Mounts with a `★` next to them are the reccomended mounts for the respected hmd. This is based user feedback on what works best for the most people.
<PartsList />
### Other Headsets
If you own another headset not listed above, that means there are no mounts designed for them yet. If you have basic skills in modeling or think up a solution to mount cams and emitters, please try to make a mount and then let us in the discord know so it can be added here. Any headset that can fit the camera is potentially compatible. If you are willing, give it a shot to design a mount for the rest of the community.

View File

@ -12,11 +12,11 @@ const printed_parts = {
},
{
url: "https://github.com/RedHawk989/EyeTrackVR-Hardware/blob/main/3d_Printed_Mounts/Quest_2/Prohurtz/EyeTrack_Arkfall_Quest_2_Mount_Edit_By_Prourtz.stl",
desc: "Camera and IR emitter mount by Prohurtz"
desc: "Camera and IR emitter mount by Prohurtz"
},
{
url: "https://github.com/RedHawk989/EyeTrackVR-Hardware/blob/main/3d_Printed_Mounts/Quest_2/Arkfall/Quest_2_ESP_Mount_v2_By_Arkfall.stl",
desc: "ESP mount by Arkfall"
desc: "ESP mount by Arkfall"
},
{
url: "https://github.com/RedHawk989/EyeTrackVR-Hardware/blob/main/3d_Printed_Mounts/Quest_2/Prohurtz/Quest_2_ESP_Mounts_By_Prohurtz.stl",
@ -28,12 +28,12 @@ const printed_parts = {
{
hmd: "Valve Index",
parts: [
"ESP mount : N/A"
""
],
hyper_links: [
{
url: "https://github.com/RedHawk989/EyeTrackVR-Hardware/tree/main/3d_Printed_Mounts/Valve_Index/Seaweed",
desc: "High IPD compatible Camera and IR emitter mount by Seaweed"
desc: "★ High IPD compatible 160 and 120 degree camera and IR emitter mounts by Seaweed"
},
{
url: "https://github.com/RedHawk989/EyeTrackVR-Hardware/tree/main/3d_Printed_Mounts/Valve_Index/qdot",
@ -45,7 +45,7 @@ const printed_parts = {
},
{
url: "https://github.com/MUTEtheCyberwolf/VALVE-INDEX-DEV-Frunk-1.0/tree/main/3D%20Print%20Files%20STL(Ascii)",
desc: "ESP frunk mod by MUTE the Cyberwolf"
desc: "ESP frunk mod by MUTE the Cyberwolf"
},
],
link_id: 2
@ -58,7 +58,7 @@ const printed_parts = {
hyper_links: [
{
url: "https://github.com/RedHawk989/EyeTrackVR-Hardware/blob/main/3d_Printed_Mounts/Samsung_Odyssey%2B/Breakdown/Samsung%20Odyssey%2B%20Left%20by%20Breakdown.stl",
desc: "Camera and IR emitter mount by Breakdown"
desc: "Camera and IR emitter mount by Breakdown"
}
],
link_id: 3
@ -71,7 +71,7 @@ const printed_parts = {
hyper_links: [
{
url: "https://github.com/RedHawk989/EyeTrackVR-Hardware/blob/main/3d_Printed_Mounts/Quest_1/G0LDJAY/Quest_1_Cam_mount_v5_By_G0LDJAY.stl",
desc: "Camera and IR emitter mount by G0LDJAY"
desc: "Camera and IR emitter mount by G0LDJAY"
}
],
link_id: 4
@ -84,7 +84,7 @@ const printed_parts = {
hyper_links: [
{
url: "https://github.com/RedHawk989/EyeTrackVR-Hardware/tree/main/3d_Printed_Mounts/Vive_Pro_2/StormFox",
desc: "Camera and IR emitter mount by StormFox"
desc: "Camera and IR emitter mount by StormFox"
}
],
link_id: 5
@ -97,7 +97,7 @@ const printed_parts = {
hyper_links: [
{
url: "https://github.com/RedHawk989/EyeTrackVR-Hardware/blob/main/3d_Printed_Mounts/General_ESP32-CAM_Mounts/ESPCAMshellv7_by_G0LDJAY.stl",
desc: "ESP mount by G0LDJAY for general HMD use (use if there are no specific HMD mounts available)"
desc: "ESP mount by G0LDJAY for general HMD use (use if there are no specific HMD mounts available)"
}
],
link_id: 6

View File

@ -4,7 +4,7 @@ const members: IMembers[] = [
{
name: 'Prohurtz',
avatar: 'https://avatars.githubusercontent.com/u/48768484?v=4',
title: 'Initiator / Moderator / Documentor / Lead Software Developer',
title: 'Creator / Lead Software Developer / Documentor / Hardware Developer',
links: [
{
icon: 'github',
@ -53,7 +53,6 @@ const contributors: IMembers[] = [
avatar: 'https://avatars.githubusercontent.com/u/34539?v=4',
links: [
{ icon: 'github', link: 'https://github.com/qdot' },
{ icon: 'twitter', link: 'https://twitter.com/qdot' },
]
},
{
@ -63,6 +62,13 @@ const contributors: IMembers[] = [
{ icon: 'github', link: 'https://github.com/dfgHiatus' },
]
},
{
name: 'PallasNeko',
avatar: 'https://avatars.githubusercontent.com/u/124042774?v=4',
links: [
{ icon: 'github', link: 'https://github.com/PallasNeko' },
]
}
]
export { members, contributors, IMembers }