From fc9f8856003345e60202e18cdb4a03f09fd29977 Mon Sep 17 00:00:00 2001 From: Marcel Wiessler Date: Thu, 12 Sep 2024 11:38:26 +0200 Subject: [PATCH] Update README.md --- package/Runtime/Facefilter/README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/package/Runtime/Facefilter/README.md b/package/Runtime/Facefilter/README.md index 467ba7b7b..38b3697b1 100644 --- a/package/Runtime/Facefilter/README.md +++ b/package/Runtime/Facefilter/README.md @@ -1,12 +1,17 @@ -Use Needle to create your own, completely custom and unique Facefilters that run natively in the browser. +Use Needle to create your own, completely custom and unique filters that run natively in the browser. Use the button in the menu `Next Filter` (or arrow keys) to try out all the filters in the browser. -You can record videos directly on the website and share it on your social media - or send the link to friends or family. +You can record videos directly on the website and share it on your social media - or send the link to friends or family. You can even drop your own artwork on the website to use as a filter. -The sample comes with 6 fun and cute filters to show off a few features like blendshapes, animations and rendering effects. Use the button in the menu (at the bottom) to change which filter is shown. +The sample comes with 14 fun and cute filters to show off a few features like blendshapes, animations and rendering effects. Use the button in the menu (at the bottom) to change which filter is shown. -Filters can be created in Unity - You don't need to write any code. Add the "Needle Filter Tracking Manager" to your scene and click the "Create New Filter" button to get started. Your filter can be edited visually in the Scene View. +Filters can be created in Unity or in Procreate - You don't need to write any code. Add the "Needle Filter Tracking Manager" to your scene and click the "Create New Filter" button to get started. Your filter can be edited visually in the Scene View. + + +### Face Mesh + +To use face mesh filters just add the `FaceMesh Texture` or `FaceMesh Video` component to a object in the scene and assign it to the filters in your filter manager component. Make sure to select the correct layout for your texture or video (wether you used procreate or the mediapipe/google face layout when you created your texture). ### Animations -To make your animation react to faces simply create `Float` parameters and use [ARKit blendshape names](https://developer.apple.com/documentation/arkit/arfaceanchor/blendshapelocation). For example `jawOpen` has a value between 0 (closed) and 1 (open), `eyeBlinkLeft` and `eyeBlinkRight` for blinking. You can use the `Face Filter Animator` component to see all options. Example: "Facefilter/Examples/Open Mouth.prefab" \ No newline at end of file +To make your animation react to faces simply create `Float` parameters and use [ARKit blendshape names](https://developer.apple.com/documentation/arkit/arfaceanchor/blendshapelocation). For example `jawOpen` has a value between 0 (closed) and 1 (open), `eyeBlinkLeft` and `eyeBlinkRight` for blinking. You can use the `Face Filter Animator` component to see all options. Example: "Facefilter/Examples/Open Mouth.prefab"