Skip to main content

QTTeleporter

Teleportation system prefab for VRChat Avatar 3.0.

GitHub GitHub

  • Simple asset, easy to install with only 2 boolean parameters and 2 animation layers.
  • Modular Avatar compatible.
  • Works on any avatar built with VRCAvatarSDK 3.0.
  • Only PCVR and Desktop compatible.
  • Not Quest compatible.

Installation

Notes​

If you are updating from a version older than v2.0.0, I recommend you remove the asset from your project and do a clean install of this asset.

Requirements​

  • Unity 2022.3.22f1 (recommended)
  • Latest VRCAvatarSDK3.0
  • An avatar already setup and ready to be uploaded to VRChat

Modular Avatar Setup (easiest)​

  1. Ensure you have Modular Avatar setup in your project.
  2. Download the latest release from GitHub Releases
  3. Import into your Unity project
  4. Drag the prefab "QTTeleporter-ModularAvatar" into the root of your avatar.
  5. Optionally customize where the menu is installed.
  6. That's it.

Manual installation​

Youtube manual installation guide

  1. Download the latest release from GitHub Releases
  2. Import the unitypackage into your project.
  3. From the folder QTTeleporter, drag the prefab QTTeleporter into the scene.
  4. Right-click on the prefab and unpack completely.
  5. Place the QTTeleporter object at the root of the avatar.
  6. Under QTTeleporter/WorldAnchor/Container/ConstraintA assign the root of your avatar's armature to the sources, then click 'Zero'.
  7. Under QTTeleporter/WorldAnchor/Container/ConstraintB assign the root of your avatar's armature to the sources, then click 'Zero'.

Add as new FX layer​

  1. On the VRCAvatarDescriptor, under Playable Layers, assign to the FX layer the animator controller QTTeleporterFX.
  2. On the VRCAvatarDescriptor, under Expressions, assign the QTTeleporterMenu to the Menu and QTTeleporterParameters to the Parameters.

Add to existing FX layer​

  1. Download and install the latest version of VRLabs's Avatars 3.0 Manager to get the tool to merge animators.
  2. From the VRLabs menu, open the Avatars 3.0 Manager.
  3. Drag your VRC avatar descriptor into the panel.
  4. Open the FX section and click on add animator to merge.
  5. Add the animator QTTeleporter FX to merge as new.
  6. On the avatar's VRCAvatarDescriptor, open your existing Expression Menu and add QTTeleporterSubMenu as a sub menu item to your existing menu. Or if you don't have one, you can use the QTTeleporterMenu directly.
  7. On the avatar's VRCAvatarDescriptor, open your existing Expression Parameters and copy all the parameters from QTTeleporterParameters over exactly the same way.

Customization​

  • If you want to customize the appearance of the portals, you can edit the materials PortalMatA and PortalMatB:
    • Emission color
    • Opacity (how much you can see through)
    • Whether it uses the billboard effect (the portal always faces you)
    • Rotation speed
    • If you decide to change the textures, the top left 8x8 corner is the color used for the base of the teleporter, make sure to also update the mask if needed.
  • If you want to change the portals themselves, you can replace the models that are under QTTeleporter/WorldAnchor/Container/ContraintA/StationsA/ModelA (or B) with your own 3D model.

Usage

From the expression menu, you can drop either Portal A or Portal B.

Any other user than yourself can "sit" on either portals, they will be at the location of the other portal.

If only one portal is placed, the other user will be teleporter to you.

License

Feel free to modify as you see fit, this is under MIT license.

Help

If you have any questions, join the Discord.