Want to support me? The sponsor links are on the right, and show on tapping the sponsor button on the repository! I barely scrape by, so dedicating time to Kanna Protecc without support is not viable. It's currently only free time if any.
Fuck Rippers! This project was previously owned by rygo6. It has been passed on for me to own and work on. This is the official repository for this project. I plan to maintain this for the long-term foreseeable future.
This is free. Actually read all of this.
NOTE: Rather pathetically, some are spreading the false rumor this has been bypassed. It has not been bypassed. This is from the malicious scene to try to stop this becoming too common.
This is a rather invasive anti-avatar-ripping system to be used for VRChat. It will protect against your avatar being ripped, extracted and edited. It will also protect against your avatar being ripped and re-uploaded without edits.
This system will randomize all the vertices of your avatar's mesh, then write that to disk. Then rely on a custom shader with a 32 bit key to un-randomize the vertex positions in game. This is not done through blend shapes. Rather this will copy, and destructively edit, the 'Basis' layer of your mesh. It will also obfuscate pretty much everything else on your avatar to confusing as a extra middle finger for the ripper.
-
For a user to see your avatar properly in VRChat, they must have your avatar fully shown. Shaders, animations and all. You are invisible otherwise.
-
This synchronizes the key with Avatar 3.0 parameters and does take up 32 bits. So this system can only work with avatars that use the VRChat Avatar 3.0 SDK.
-
Only a shader from Supported Shaders will work with this. To request another shader to be supported, feel free to ask in the discussions tab here, or in the discord, seen in the Support section.
-
Proper integration with VRCFury is currently in development.
| Supported Shader Name | Download |
|---|---|
| Poiyomi | https://github.com/poiyomi/PoiyomiToonShader |
| Unity-Chan Toon Shader (UTS) | https://unity-chan.com/download/releaseNote.php?id=UTS2_0&lang=en |
| Sunao Shader | https://booth.pm/ja/items/1723985 |
| XSToon | https://github.com/Xiexe/Xiexes-Unity-Shaders |
| GTAvaToon | https://github.com/rygo6/GTAvaToon |
Click me!
Backup your project before running these operations in case it doesn't work properly and causes difficult to fix, or impossible to fix, changes in your project.
Really do it. Close Unity, and make a full clean copy of your entire Unity Project folder. A small percentage of avatars did have odd things in their mesh that just wouldn't work, or could cause errors, and the script could leave some assets in the project in a rather messed up state.
- Ensure you are using latest VRChat Avatars SDK.
- Download the supported shader of your choice from Supported Shaders, and import it into your Unity project.
- Click (Download). Once downloaded, extract it. Once you have the folder, put that into your assets folder of your unity project.
Be sure all of this is set correctly on your FBX's. (Legacy blend shape normals and read/write on too!)
- Add the
KannaProteccRootcomponent onto the root GameObject of your avatar, next to theVRCAvatarDescriptorcomponent.
Additional Materials is intended for materials used in animations. DO NOT PUT NORMAL NON-ADDITIONAL MATERIALS IN HERE.
The Auto Detect button tries to find material references in all animations! If you have material swaps setup on your avatar it should be a one click solution!
Ignored Materials allows you to use a material with a supported shader on a part of your avatar you don't want encrypted. Materials in this list will not be encrypted. Do not add materials to this list that are on parts of your avatar you want to protect.
You can change the 'BitKeys Length' under 'Debug' settings. This allows users with fewer parameters to spare to still use Kanna Protecc. However know that using a shorter bit key reduces the security of the encryption. Its recommended that you use as large of a 'BitKeys Length' as possible.
By default Kanna Protecc Obfuscates all objects, parameter names, and animator layers on a user's avatar. Features of VRChat that users may want to take advantage of. Such as contact senders, OSC integrations, etc, often require specific names to be unaltered to maintain functionality.
Kanna Protecc allows for exceptions to be added for renaming. For maximum security only add exceptions for parameters that are required to be unaltered. Note that contact parameter names not intended to interact with other avatars will function perfectly fine obfuscated. Physbone parameters also function perfectly obfuscated. Neither need to be added to exceptions.
The Auto Detect buttons try and detect common setups like face tracking or gogoloco that require exclusions! Its a good idea to click them!
Examples for Face tracking and GoGoLoco.
- Ensure your
VRCAvatarDescriptorhas an AnimatorController specified in the 'FX Playable Layer' slot. Ensure there is also anAnimatorcomponent on this root GameObject, and that its 'Controller' slot points to the same AnimatorController in the 'FX Playable Layer' slot on theVRCAvatarDescriptor.
The AnimatorController you specify should not be shared between multiple avatars, Kanna Protecc is going to write states into the controller which will need to be different for different avatars.
- In the 'Parameters' slot of your
VRCAvatarDescriptorensure you have an 'Expression Parameters' object.
VRC API stores old uploads of your avatar! So if you start uploading an encrypted avatar with an ID that you previously uploaded non-encrypted, it may entirely negate any benefit this provides as rippers can just download an older version that was not encrypted.
- Go into the VRChat SDK Inspector in the Unity Editor, then under 'Content Manager' find the avatar you wish to protect and delete it entirely from the VRC backend.
- Go to your current avatar's
Pipeline Managercomponent and click theDetach (Optional)button so it will generate a new avatar id on upload.
- Ensure any meshes you wish to have encrypted are using a compatible shader, such as Poiyomi.
- On the
KannaProteccRootcomponent click the 'Protecc Avatar' button. This will produce a garbled version of your avatar with '_KannaProteccted' appended to the name.
The mesh appearing scrambled is intended behavior. - Go to the VRChat SDK Menu then 'Build and Publish' your avatar which has '_KannaProteccted' appended to the name.
I found some Poi 8/8.1 materials get into a weird state with Lock/Unlock and Kanna Protecc can't lock them. If you get errors that say something like 'Trying to Inject not-locked shader?!' go to the Poi 8/8.1 material it is complaining about and manually click the Lock/Unlock button to get it out of its weird state.
Ensure VRChat is closed! Otherwise when you write keys VRChat may prevent writing!
- This is important. After upload completes, go to the GameObject of your encrypted avatar. Find the
Pipeline Managercomponent and copy it's blueprint ID. Then paste the blueprint ID into thePipeline Manageron the un-encrypted avatar and click 'Attach'. - Now on the KannaProteccRoot component click the 'Write Keys' button. This will actually read in and alter the saved 3.0 parameters from your VRChat folder to include the new key so you don't have to enter them in-game.
- Ensure no errors came up!. It should popup a success dialogue if it did it correctly. If there were issues make sure the 'Vrc Saved Params Path' actually points to your LocalAvatarData folder.
You only need to run 'Write Keys' once on first setup, or when you change keys.
If you "Reset Avatar" in game through the 3.0 menu, it will reset your keys and you will need to re-export them with the 'Write Keys' button!
If you wish to see your avatar again as normal and not encrypted, or make changes to your avatar:
- Click on your original un-encrypted avatar, where "Encrypted" is not in the name; then select Un-Protecc Avatar.
You should now be able to edit your avatar as normal.
Do not upload the avatar without encrypting it!
- Click 'Protecc Avatar' again. Follow the steps in Encrypting and uploading
- Writing keys should not be necessary unless you genereated new keys.
Entering play mode will not decrypt the protected avatar on its own. Click here for how to test your avatar in play mode.
I will keep transparent here without guiding rippers on how to attack your works. This is not foolproof, but the best you can get at this time. Rip wise, this cannot be currently ripped without a insane amount of work, as ripping compiled shadercode, reversing it back to unity compatible code and also getting hold of the keys would be hell. Hotswap wise, a dedicated enough ripper with experience with mods could hotswap your avatar. This is not immune to that. (Soon to be countered with traps making even that extremely harder to do) You can however put a watermark on your avatar to drive hotswappers into being banned which they wont be able to remove, as the meshes will be encrypted, regardless of hotswap. A hotswap done with the high amount of work i have mentioned here would only get the avatar working normally in game; not in unity.
A typical hotswap will not bypass this. It would take a specialized one.
If you have any more questions, or suggestions, feel free to join the Kanna Protecc discord: https://discord.gg/SyZcuTPXZA
This will let you keep up to date with major features that will take time to implement. This does not act as a changelog, nor will it have every upcoming feature listed. Only time-consuming ones. https://trello.com/b/k88bNBvd/kanna-protecc