Skip to main content

SPS (Super Plug Shader)

SPS, or Super Plug Shader, is VRCFury's deformation system for VRChat haptics.

SPS3 is included in the latest stable VRCFury. It replaces SPS2, SPS1, DPS, and TPS, while retaining optional compatibility with those systems.

Deformation, contacts, and OGB haptics are for desktop avatars; non-desktop uploads retain the menu items and parameters.

SPS3 Benefits​

  • Free
  • Works on both rigged and un-rigged meshes
  • No grabpasses
  • No lights needed between SPS3 plugs and sockets, or when SPS3 plugs target SPS1/2 sockets
  • Fewer contacts with smaller ranges than previous SPS versions
  • Fixes the screen-effect "ghost plugs" issue when SPS3 plugs target SPS3/SPS2/SPS1 sockets
  • Guided paths with up to 4 nodes after the entrance
  • Radius offset that follows the plug's radius profile
  • Depth animations and plug entry radius animations
  • Channels for filtering which plugs can target which sockets
  • Supports animating blendshapes while deforming
  • Supports avatar scaling
  • Compatible with many shaders, including Poiyomi, liltoon, UTS, Mochie, XSToon, Silent, Standard, and supported Shader Graph shaders

Already have SPS1/2, DPS, or TPS? Start with Upgrade to SPS3.

How to Set Up a Plug​

  • Ensure VRCFury is up to date
  • Click Tools > VRCFury > SPS > Create Plug
  • If your mesh is rigged, parent the new SPS Plug object to the bone nearest the base of the deforming area
  • If your mesh is un-rigged, parent the new SPS Plug object to the renderer that should deform
  • The plug mesh must be straight / fully extended in the editor
    • SPS uses this pose to measure the plug
    • To use a different resting pose in game, add Post-Bake Actions to the plug component
  • Position the SPS Plug object at the base of the deforming area
  • Rotate it so the curved end points toward the tip

Existing DPS/TPS materials are supported: SPS imports their settings and disables their original deformation when applying SPS deformation. A normal, non-deforming shader is still preferred. See upgrading legacy content.

Plug Options Worth Knowing​

  • Enable Deformation
    • Makes the mesh deform toward sockets.
  • Auto-Rig
    • Adds bones and a physbone to a static mesh so it can sway.
  • Animated Toggle
  • Animated blendshapes to keep while deforming
    • Lists blendshapes that should continue animating during deformation.

How to Set Up a Socket​

  • Click Tools > VRCFury > SPS > Create Socket
  • Parent the new object to the bone you want it attached to
  • Position it where you want plugs to target
  • Rotate it so the arrow points inward
  • Use Enable Menu Toggle to create an in-game toggle for this socket

Socket Modes​

  • Auto: chooses a type based on placement, usually Hole on hips/head and Ring elsewhere.
  • Hole: a one-sided target that collapses the plug.
  • Ring: can be entered from either side by SPS plugs. DPS/TPS support is more limited.
  • One-Way Ring: can only be entered from one side.

Unchecking Enable Deformation prevents this socket from attracting plugs, while allowing it to be used for animations or haptics.

Radius Offset and Guided Paths​

Radius Offset moves the target in the socket's up direction by the plug's radius. This is useful for hand-style sockets. You can enable it separately at the entrance and at each guided node. The offset follows the SPS3 plug's radius profile. Use Limit Radius Offset to cap how far a target can move.

Click Add Guided Path Node to guide the plug through up to 4 nodes after the entrance. Select the socket and use Unity's move, rotate, or scale tool to adjust the nodes. Each node needs a transform that contains no other SPS socket. Custom tangent overrides are no longer supported.

  • Enable Collapse until next node where the plug should disappear. Consecutive collapsed sections act as one span. The plug tapers within the first quarter of that span and gradually reappears at the reopening node before continuing. If it joins partway along the path, the span starts at the join.
  • Enable Collapse plug at exit on the last node to end the plug there. Its tip tapers in place at the node. Leave this unchecked to let the plug continue out of the path.

Avatar sockets can be placed under non-uniformly scaled bones. World sockets still require a hierarchy with uniform, positive scale.

Depth Animations​

Both plugs and sockets can animate blendshapes, objects, clips, or other VRCFury actions based on insertion depth. Enable Depth Animations on the component and add an action.

  • Set the range over which the animation blends in or out. Depth is 0 at the plug tip, negative when inserted, and positive when away from the entrance.
  • New animations default to Local units, so their ranges scale with the avatar. The editor also shows the corresponding distances in meters.
  • Use Meters only when you intentionally want a fixed world-space range. Changing between Local and Meters converts the range using the component's current scale.
  • Plugs units express distance in plug lengths.
  • Type directly into the range fields to use values beyond the slider's displayed range.
  • Set Allow Self and Allow Others for each animation. Plug animations can also filter Allow Hole and Allow Ring.
  • Use Smoothing Seconds to soften changes.

Socket depth animations also offer Weight by local plug radius. Set the local radius that should produce full animation weight; smaller plugs produce less weight. This uses the plug's overall radius, independently of entry radius animations.

Plug Entry Radius Animations​

Sockets can animate based on the radius of the plug at the socket entrance. Use this to make an opening widen as a plug enters without building a custom animator.

  • On the socket, enable Plug Entry Radius Animations and add actions.
  • Set the radius range and actions, as with depth animations. New ranges use Local units and cannot be negative.
  • SPS3 plugs provide a changing radius profile as they move through the entrance.
  • The value fades in over the last 5% of a plug length before an SPS3 plug's tip reaches the entrance.
  • Legacy plugs fade from zero at tip contact to their estimated radius at 5% insertion. Older setups that do not supply radius information stay at zero.

These values are radius, not diameter. Entry radius animations do not support Reverse Clip or the Plugs units option in the editor.

Inject Parameters​

Custom controllers can read SPS measurements through Full Controller's Inject Parameters. Choose the source plug or socket, the measurement, and units where applicable to drive a parameter in your controller.

MeasurementMeaning
DepthInsertion depth: zero at the tip, negative inside, positive outside
VelocityMovement along the plug's length
Plug LengthThe interacting plug's length, or this plug's own length when the source is a plug
Plug RadiusThe plug's overall radius
Plug Entry RadiusRadius at the socket entrance; available when the source is a socket
Plug Is Legacy / Socket Is Legacy1 when the interacting plug/socket is present and uses a pre-SPS3 system; otherwise 0
Plug is Other Player / Socket is Other Player1 when the selected interaction is with another player; otherwise 0
Socket Is HoleWhether the socket is a Hole; reads this socket's type for a socket source, or the interacting socket's type for a plug source

Names change to describe the counterpart of the selected plug/socket. The true/false measurements have no units.

For measurements with units, Local is usually preferred because it scales with the avatar. Meters stays in world-space units; Plug Lengths normalizes the measurement to the plug's length. Legacy size and entry-radius values depend on the data supplied by the older setup and may be approximate or unavailable.

See depth animations and compatibility for related settings.

Channels​

A plug and socket must share a channel to interact. Both components have the same channel editor:

  • Include Public SPS Channel allows ordinary public interactions and is enabled by default.
  • Add up to 2 custom channels. Each has Allow Self and Allow Others choices.
  • The Final channel list shows the effective channels, including automatic channels.

Custom channel names are trimmed and case-insensitive. If you disable the public channel, add at least one custom channel; an empty effective channel list causes a build error.

For a private pairing, disable the public channel on both components and give them a matching custom channel. To target either of two groups, add both channels: a match on either is enough. SPS3 no longer supports plug exclude tags.

Automatic Socket Channels​

Sockets with the public channel enabled also receive channels based on placement:

PlacementChannels
Hipships
Head / Jawhead
Chest / Upper Chestchest
Left Handhand, handleft
Right Handhand, handright
Left Foot / Toesfoot, footleft
Right Foot / Toesfoot, footright

When suitable front/back hip sockets are present, VRCFury also assigns hipsfront and hipsback. Non-hip sockets receive nothips.

On plugs, Exclude sockets on own Hips prevents a hip-mounted plug's public channel from matching your own hip sockets. It does not exclude other players' sockets, and custom channels can still explicitly match your own hip sockets.

Changing Channels with Actions​

Use Change SPS Channels in a Toggle or another action-capable component. Choose the plug/socket and configure its replacement channel list. The action applies that list while active and restores the normal channels when inactive.

Each channel change adds several contacts. Use this sparingly. The old Legacy Change SPS Tags action no longer does anything.

SPS Options and Legacy Compatibility​

Add one SPS Options component to the avatar root to configure the SPS menu, Auto Mode, and compatibility with older systems. Compatibility is configured here rather than individually on plugs and sockets.

Legacy Compatibility Options​

OptionPurposeAdditional cost
DPS/TPS/SPS1/SPS2 PlugsLets older plugs deform toward your sockets2 lights per socket; requires Legacy Mode On
DPS/TPS/SPS1/SPS2 SocketsLets your plugs target older sockets2 contact senders per plug
TPS Plug Animations (Not Recommended, Rare)Supports legacy TPS plug animations triggered by your sockets1 contact sender per socket; requires legacy plug compatibility and Legacy Mode On
DPS Socket Animations (Not Recommended, Rare)Supports legacy DPS socket animations triggered by your plugs1 light per plug; requires legacy socket compatibility and Legacy Mode On

The first two options are enabled by default. The last two are off by default. To remove all legacy lights and the extra legacy senders, disable all four options.

The Legacy Compatibility menu toggle controls the legacy features that require it. While it is on, only one socket can be active at a time. With it off, multiple sockets can stay active. In Legacy Mode Menu, choose whether it starts on and whether its state is saved between worlds. Legacy Mode defaults to on.

Disabling Legacy Mode in the menu does not remove the cost of including compatibility in the avatar. Use the checkboxes in SPS Options to remove features entirely. Individual sockets can still override their legacy Hole/Ring type or light offset when compatibility is included.

Cross-Version Limitations​

  • SPS2 plugs must have their Legacy Mode on to target SPS3 legacy-compatible sockets.
  • Guided paths do not work across SPS2 and SPS3.
  • Custom/private channels do not match across SPS2 and SPS3. Only the common public channel is shared.
  • SPS3 plugs targeting SPS2 sockets use the non-offset position rather than respecting SPS2 radius offset.
  • Legacy deformation compatibility does not guarantee legacy depth animations or haptics. Older DPS content may need upgrading to supply those features.

Auto Mode​

Auto Mode enables a socket when it touches a nearby plug and turns it off after the plug moves away. It accepts your own plugs as well as other players' plugs.

  • It will not switch sockets while an automatically selected socket remains active. Move that socket away from the plug before selecting another.
  • It only turns off sockets that it turned on. A socket you enabled manually is not taken over by Auto Mode.
  • Legacy Mode's one-socket-at-a-time restriction still applies when Legacy Mode is on.
  • Only sockets with menu toggles are eligible. Uncheck Include in Auto selection? on an individual socket to exclude it.

Use Include Auto Mode in Avatar in SPS Options to include or remove Auto Mode, and choose its default and saved state.

Under SPS Menu, set Path Override to move or rename the generated menu, such as Props/SPS. The default is SPS. You can also override its icon and save active sockets between worlds.

When included, Auto appears before the socket toggles and Legacy Compatibility after them. There is no separate Options submenu or Stealth Mode.

OGB Haptics​

Enable OGB Haptics on the plug or socket and use an up-to-date OscGoesBrrr.

  • Plug touch covers the plug's length; frotting detects other plugs.
  • Socket touch is centered around the socket opening. Automatic socket touch support is for hip-mounted sockets.
  • Touch and frotting use VRChat's sender velocity when available, regardless of OGB's motion-based setting.
  • ID sent to OGB identifies the plug or socket. Slashes in IDs are replaced with underscores.

Testing in the Editor​

  • Install Gesture Manager or Av3Emulator
  • Add a test socket or plug to the scene if needed
  • Enter play mode
  • Turn on the avatar socket in the SPS menu
  • Move the plug and socket around to test

Depth and radius animations can be tested in both emulators. Enable Scene lighting when testing legacy light-based interactions; SPS3-to-SPS3 interactions do not need it.

Disabling SPS Plug Deformation with a Toggle or Animation​

  • Add a VRCFury | Toggle
  • Add an Enable SPS action
  • Drag in the SPS Plug

Like an Object Toggle set to Turn On, this makes deformation off by default and enables it while the toggle is on. You can also animate the plug's Animated Toggle field directly.

Scaling SPS Plugs​

These are allowed while deformation is enabled:

  1. Uniformly scaling a parent of the SPS Plug
  2. Animating blendshapes listed in Animated blendshapes to keep while deforming, as long as they do not change plug length
  3. Positioning, rotating, scaling, or shaping the plug in the editor's default pose

Avoid animating plug bones that are not parents of the SPS Plug object, or blendshapes that change plug length, while deforming. Animate the plug's Animated Toggle off for those changes.

Performance​

SPS3 uses contacts instead of grabpasses. Without depth/radius animations, legacy compatibility, haptics, or guided paths, a basic setup uses:

ComponentSendersReceiversLights
Plug250
Socket100

Animations, haptics, guided paths, compatibility options, and channel-changing actions can add contacts or lights. Disable compatibility options you do not need in SPS Options. Test your avatar in real worlds when evaluating performance.

Troubleshooting​

Plug works in the editor, but not in game​

Ensure Avatar Self Interact is enabled in VRChat to use your own plugs and sockets.

For other players, check that interactions are allowed between you. You should see a yellow hand on their name card when your menu is open.

Plug does not target a socket​

Check that the socket is enabled, deformation is enabled, and the two components share a channel. For older systems, check both the relevant compatibility checkbox in SPS Options and Legacy Mode where required. Review the cross-version limitations.

Deformation works, but an animation or haptic effect does not​

Check the animation range, units, Self/Others and Hole/Ring filters, and whether the effect requires one of the optional legacy animation compatibility settings. Legacy plug size estimates are less accurate, and very old plugs may not provide a usable radius.

For older DPS/TPS content, ask its owner to upgrade it to SPS3. Keep OGB up to date when testing haptics.

Legacy compatibility stops working near many other sockets​

Unity can discard legacy lights when too many are nearby. This limitation affects light-based compatibility; SPS3-to-SPS3 deformation does not depend on lights.

Other question?​

Ask on the Discord.