VRCQuestTools

repository·master·Indexed 43 days ago

https://github.com/kurotu/vrcquesttools

A Unity utility suite for converting PC-based VRChat avatars into Android-compatible versions for Meta Quest and PICO headsets. Key features include non-destructive conversion via NDMF, automatic texture generation, PhysBone optimization, and material conversion (including lilToon to Toon Standard for VRCSDK 3.8.1+). It provides tools for component cleanup, vertex color removal, and platform-specific GameObject management.

Tokens
14.3K
Snippets
14
Records
111
Agent score
54%

What's inside VRCQuestTools

  1. What is VRCQuestTools

    master

    VRCQuestTools is a Unity editor extension designed to automate the conversion of PC VRChat avatars for use on Mobile platforms (Android/Quest, PICO, and iOS).

    It automates complex manual tasks required for Mobile compatibility, such as:

    • Material conversion: Automatically generates materials and textures for Mobile-supported shaders based on PC shader settings.
    • Component removal: Removes components unsupported by Mobile at build time.
    • PhysBone reduction: Helps reduce PhysBones to meet stricter Mobile performance limits.
    • Non-destructive conversion: Integrates with the Non-Destructive Modular Framework (NDMF) to convert avatars automatically during upload without modifying the scene assets.
    • Utilities: Includes tools for copying blendshapes and applying recommended Unity settings.
  2. Overview of VRCQuestTools features

    master

    VRCQuestTools is an avatar converter and utility suite designed to make PC avatars compatible with Android-based VR platforms like Meta Quest and PICO.

    Key capabilities include:

    • Non-destructive conversion: Duplicates avatars and materials so the original assets remain untouched.
    • Texture Generation: Automatically generates Android-compatible textures based on existing material settings.
    • Component Cleanup: Removes unsupported components (e.g., Constraints).
    • PhysBone Optimization: Provides tools to easily reduce PhysBone counts.
    • Visual Fixes: Removes vertex colors to ensure textures display correctly on Android.
    • Project Configuration: Updates Unity settings to recommended values for Quest compatibility.
  3. What to check when verifying a converted avatar

    master

    Because material conversion and component removal are not perfect reproductions of PC shaders, you should verify the following aspects of your converted avatar:

    • Color and brightness: Mobile shaders react differently to lighting; check how the brightness looks in different world environments.
    • Transparency: Mobile shaders do not reproduce texture transparency. This heavily affects expressions like blushing or glasses lenses. (See troubleshooting for workarounds).
    • Removed components: Ensure that any gimmicks or features still function correctly after unsupported components have been removed.
    • PhysBone behavior: Verify that the swaying and movement of the reduced PhysBones are still acceptable.
  4. How build target detection works in VRCQuestTools

    master

    Many VRCQuestTools components use settings such as Keep on PC or Enable on Mobile to toggle behavior based on the target platform during the build process.

    Default Behavior: By default, the components use Unity's current target platform (e.g., Windows for PC, Android/iOS for Mobile).

    Forcing Platform Detection: If you need to override the default behavior or force specific platform detection at build time, add the VQT Platform Target Settings component to your avatar.

  5. Manage platform-specific components and GameObjects

    master

    VRCQuestTools provides components to remove specific elements based on the build platform (requires NDMF):

    • VQT Platform Component Remover: Removes specific components depending on the build target.
    • VQT Platform GameObject Remover: Removes specific GameObjects depending on the build target.

    Important Change (v2.3.0): The logic for these components has changed. The checkboxes are now inverted: check the box to keep the item rather than to remove it.

  6. Alternative: Use Material Replacement in Avatar Converter Settings

    master
    If your goal is simply to change the conversion behavior on a per-material basis rather than mapping specific materials to specific replacements, you should use the Material Replacement option found in the Additional Material Conversion Settings of the VQT Avatar Converter Settings instead of using the standalone Material Swap component.
  7. Understand VRCQuestTools conversion warnings

    master

    During the setup process, warnings may appear in the converter settings. These are not errors, but notifications about upcoming changes or required manual actions:

    • Removal of unsupported components: Components incompatible with Mobile (e.g., Audio Source) will be removed. Verify avatar functionality after conversion.
    • Dynamic Bone: VRCQuestTools does not convert Dynamic Bone to PhysBone. You must manually convert these using the VRChat SDK feature before proceeding.
    • Avatar Dynamics performance: If there are excessive PhysBones or Contacts, they may be removed to maintain performance. You may need to reduce PhysBones manually.
  8. Vertex Color Removal behavior in v3.0.0

    master

    In v3.0.0, vertex color removal during conversion no longer modifies the original mesh. Instead, it generates a dedicated mesh asset (.vqtmesh) for the converted avatar. This prevents side effects (like changing outline appearances) on the pre-conversion avatar.

    Note: The Vertex Color Remover component is still available and functions as before for manual attachments.

  9. How NDMF enables automatic conversion

    master

    VRCQuestTools typically duplicates an avatar and its assets to perform conversions, ensuring the original remains untouched.

    However, if the Non-Destructive Modular Framework (NDMF) package is present in your project, VRCQuestTools can perform automatic conversion during the upload process without creating duplicate copies. This works seamlessly with other non-destructive tools like Modular Avatar.

    To use this feature, ensure NDMF is installed (it is included automatically if you use Modular Avatar).