Skip to content
This repository has been archived by the owner on Apr 27, 2024. It is now read-only.

Avatar Keyboard that takes advantage of the SDK3 parameter sync

Notifications You must be signed in to change notification settings

killfrenzy96/KillFrenzyVRCAvatarKeyboard

Repository files navigation

A replacement for this Keyboard is in development

Please check out the new project here that supports OSC and also features an in-game keyboard using VRChat's avatar dynamics!

https://github.com/killfrenzy96/KillFrenzyAvatarText

This keyboard currently no longer works since the 2021.1.1 update

This is a result of the AV3 2021.1.1 Update: https://docs.vrchat.com/docs/latest-release

This change removes the ability for sub-animators to change a parameter. This unfortunately means the end of this keyboard project until there is a new way to perform movement based parameter drivers.

Please vote on this canny here so that we can get a replacement of this feature implemented: https://feedback.vrchat.com/avatar-30/p/feature-request-touch-triggers

This project is now on hold until a solution can be found.

This issue for the keyboard project is open here: #6

KillFrenzy's Avatar Keyboard

A custom avatar keyboard that takes advantage of parameter sync. Also includes a custom marker and works in Desktop mode.

KeyboardPreview

Installation Instructions are a work in progress.

YouTube installation tutorial: https://youtu.be/KKwooIiTcLs

If you just wanted a simple version of the marker from this keyboard, I have packaged it up here: https://github.com/killfrenzy96/KillFrenzyVRCMarker

If you wanted to try the Keyboard for yourself, you can check out the public avatar located in this world: https://www.vrchat.com/home/launch?worldId=wrld_49fc692a-6d11-49c4-9039-267abbfc6ec6

Here's the download link: https://github.com/killfrenzy96/KillFrenzyVRCAvatarKeyboard/releases

Prerequisites

  • Unity 2018.4.20f1
  • VRCSDK3
  • An existing working avatar (if installing to your own custom avatar)

Uploading the Example Avatar

  1. Import the "KillFrenzyKeyboard.unitypackage" into your project.
  2. Open the scene located in "Assets/KillFrenzy/Animations/Keyboard/Examples/ExampleAvatar_FX.unity".
  3. Open the VRCSDK Control Panel and login to your account.
  4. Build & Publish the "Vrchat_Tutorial_Avatar" model.

Installation to Custom Avatar

Alternatively, see the YouTube Tutorial: https://youtu.be/KKwooIiTcLs

  1. Import the "KillFrenzyKeyboard.unitypackage" into your project.
  2. Insert the prefab into your scene. The prefab is located in "Assets/KillFrenzy/Animations/Keyboard/Examples/AvatarKeyboardParts.unity".
  3. Unpack the prefab by right clicking "AvatarKeyboardParts" and pressing "Unpack Prefab".
  4. Move the game object "KillFrenzyKeyboardEffects" into the root of your own avatar.
  5. Move the game object from "ArmatureAndThat/Chest/Joint_KeyboardHeight" into your own avatar's chest. Reset its transform (position/rotation) to 0,0,0.
  6. Move the game object from "ArmatureAndThat/Left wrist/Joint_Marker_L" into your own avatar's left wrist. Position this object over the tip of your avatar's left index finger.
  7. Move the game object from "ArmatureAndThat/Right wrist/Joint_Marker_R" into your own avatar's right wrist. Position this object over the tip of your avatar's right index finger.
  8. Move the game object from "ArmatureAndThat/Left wrist/IndexFinger3_L_end/Joint_KeyboardCollider_L" into the end of your own avatar's left index finger. Position this object over the tip of your avatar's left index finger.
  9. Move the game object from "ArmatureAndThat/Right wrist/IndexFinger3_R_end/Joint_KeyboardCollider_R" into the end of your own avatar's right index finger. Position this object over the tip of your avatar's right index finger.
  10. Position the game object inside "ArmatureAndThat/Head2/Joint_DesktopAim" over the avatar's eye position. You should use the same position as the avatar's view position.
  11. Browse to the neck bone of your own avatar. Make a duplicate of the neck bone.
  12. Add a rotation constraint to the duplicated neck bone. Add the original neck bone into the Sources. Activate the constraint.
  13. Add a rotation constraint to the duplicated head bone (inside of of the duplicated neck bone). Add the original head bone into the Sources. Activate the constraint.
  14. Delete all game objects that may be inside the duplicated head bone.
  15. Move the game object from "ArmatureAndThat/Head2/Joint_DesktopAim" into the duplicated head bone.
  16. Browse to your VRC Avatar Descriptor.
  17. Customize your PlayableLayers.
  18. Insert the animator controller from "Assets/KillFrenzy/Animations/Keyboard/VRCAC_KeyboardController_FX" into the FX layer.
  19. Customize your Expressions.
  20. Insert the VRC Expression Menu from "Assets/KillFrenzy/Animations/Keyboard/VRCEM_KeyboardMenu_FX" into the the Menu.
  21. Insert the VRC Expression Paramaters from "Assets/KillFrenzy/Animations/Keyboard/VRCEP_KeyboardParams" into the the Parameters.
  22. Open the VRCSDK Control Panel and login to your account.
  23. Build & Publish your custom model.

Useful Tools

  • VRCAvatars3Tools: This tool can be used to merge multiple animators together. Useful if you wanted to merge the keyboard into an existing animator for the FX layer. https://booth.pm/ja/items/2207020

Credits

  • marzipanic - Artwork for menu icons

About

Avatar Keyboard that takes advantage of the SDK3 parameter sync

Resources

Stars

Watchers

Forks

Packages

No packages published