diff --git a/docs/facetracking101/_category_.json b/docs/facetracking101/_category_.json deleted file mode 100644 index 32a629ac..00000000 --- a/docs/facetracking101/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "FaceTracking 101", - "position": 5, - "link": { - "type": "generated-index", - "description": "Learn the basics of how all this works" - } -} diff --git a/docs/facetracking101/breakdown.mdx b/docs/facetracking101/breakdown.mdx deleted file mode 100644 index c12b7010..00000000 --- a/docs/facetracking101/breakdown.mdx +++ /dev/null @@ -1,30 +0,0 @@ -# VRC Face Tracking Explanation - -:::info -Under Construction -::: - - diff --git a/docs/facetracking101/faq.mdx b/docs/facetracking101/faq.mdx deleted file mode 100644 index 89040634..00000000 --- a/docs/facetracking101/faq.mdx +++ /dev/null @@ -1,5 +0,0 @@ -# FAQ - -:::info -Under Construction -::: \ No newline at end of file diff --git a/docs/facetracking101/glossary.mdx b/docs/facetracking101/glossary.mdx deleted file mode 100644 index 064fb26e..00000000 --- a/docs/facetracking101/glossary.mdx +++ /dev/null @@ -1,5 +0,0 @@ -# Glossary - -:::info -Under Construction -::: \ No newline at end of file diff --git a/docs/intro/getting-started.mdx b/docs/intro/getting-started.mdx index 76feb0f2..6728868c 100644 --- a/docs/intro/getting-started.mdx +++ b/docs/intro/getting-started.mdx @@ -58,7 +58,7 @@ If your headset or hardware device isn't listed in the [Supported Hardware List] ### 1️ Download and Install VRCFaceTracking -Download VRCFaceTracking from Steam®, or go to the [VRCFaceTracking program page](../vrcft-software/vrcft.mdx) to find alternative methods of installation. +Download VRCFaceTracking from Steam®. diff --git a/docs/tutorial-avatars/avatar-setup/basic_avatar_setup.mdx b/docs/tutorial-avatars/avatar-setup/basic_avatar_setup.mdx index 4c219ffc..1663ece1 100644 --- a/docs/tutorial-avatars/avatar-setup/basic_avatar_setup.mdx +++ b/docs/tutorial-avatars/avatar-setup/basic_avatar_setup.mdx @@ -1,12 +1,38 @@ ---- -sidebar_position: 1 ---- +import ReactPlayer from 'react-player' + # Basic Avatar Setup -## *Setup* Setup +## Prerequisites The first step to setting up your avatar with face tracking is to make sure that your face tracking works! Make sure that you have followed [Getting Started](../../intro/getting-started.mdx) and have a working hardware and software setup before getting down to working on your own avatars. By doing this, you make your life when debugging your avatar *much* easier + + +## Model Implementation +:::info End Users +If you're an end user, you should continue on with the recommended setup process of adding a pre-made template using VRCFury, like [Adjerry's template*](https://github.com/Adjerry91/VRCFaceTracking-Templates/wiki/Face-Tracking-Template-Setup). +*This is not software created by VRCFaceTracking and, therefore, we do not provide support or assistance using it. +::: +Before doing anything else, you'll need to create blendshapes for your avatar that map to [Unified Expressions](../tutorial-avatars-extras/unified-blendshapes). These allow for a consistent look across headsets, as well as implementing most features headsets support. +If you're editing a model, or this is your first time, [Hantnor](https://hantnor.com/) has made a video walking through her process: + +
+ +
+ + + +## Unity Implementation +Generally, using a template is the fastest way to make your blendshapes functional with VRCFaceTracking, but you're always welcome to implement it yourself in whatever way you want. + +If you decide to implement it yourself a full list of parameters used by VRCFaceTracking is [here.](../tutorial-avatars-extras/parameters) + +The most popular[^1] template available is one by Adjerry91. You can look through the wiki for it [here.](https://github.com/Adjerry91/VRCFaceTracking-Templates/wiki/Face-Tracking-Template-Setup) + +[^1]: As declared by me. + +## Done! +This is a very oversimplified guide, but it does lay out the general steps to follow, and should give you the stepping stones to follow for more information. \ No newline at end of file diff --git a/docs/vrcft-software/modules/_category_.json b/docs/vrcft-software/modules/_category_.json deleted file mode 100644 index 5b248680..00000000 --- a/docs/vrcft-software/modules/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Tracking Modules", - "position": 2, - "link": { - "type": "doc", - "id": "vrcft-software/modules/modules" - } -} diff --git a/docs/vrcft-software/modules/modules.mdx b/docs/vrcft-software/modules/modules.mdx deleted file mode 100644 index 6ba0f8cc..00000000 --- a/docs/vrcft-software/modules/modules.mdx +++ /dev/null @@ -1,18 +0,0 @@ -import DocCardList from '@theme/DocCardList'; - -# VRCFaceTracking Modules - -Modules are a way to connect any face tracking hardware API to VRCFaceTracking. - -:::info -Current modules pages in these docs are under construction! -Please refer to the [Module Registry](../vrcft.mdx#module-registry) view in the VRCFaceTracking program to view avaliable modules and install them. -::: - -## List of Modules - - - -## Writing A New Module - -To learn how to make your own module for whatever input source you might want to use, check out the [Tracking Module SDK](../vrcft-sdk/tracking-module.mdx) \ No newline at end of file diff --git a/docs/vrcft-software/modules/sranipal_module.mdx b/docs/vrcft-software/modules/sranipal_module.mdx deleted file mode 100644 index 34a6df5b..00000000 --- a/docs/vrcft-software/modules/sranipal_module.mdx +++ /dev/null @@ -1,10 +0,0 @@ -# SRanipal Module - -:::danger Still under construction! - -This reference document is still actively being worked on. -Changes are subject to happen discretionally. - -Please consider contributing by editing this page! - -::: \ No newline at end of file diff --git a/docs/vrcft-software/vrcft.mdx b/docs/vrcft-software/vrcft.mdx index a014f68f..877869cf 100644 --- a/docs/vrcft-software/vrcft.mdx +++ b/docs/vrcft-software/vrcft.mdx @@ -20,7 +20,7 @@ VRCFaceTracking supports many different, community-made input "modules", which a ## Install VRCFaceTracking Click the banner card below to be directed to VRCFaceTracking's Steam® store page, from which you can add or install the program to your Steam library. -Alternatively, download the no-installer .zip of the program from the [latest release on Github](https://github.com/benaclejames/VRCFaceTracking/releases/latest/). +