Skip to main content

Persistent Pen

Persistent Idle Game World Preview

This example allows players to use a pen to draw up to 20 colored lines. Lines are synchronized for all players. The eraser can highlight and delete lines drawn by the local player.

Visit the Persistent Pen Example World to try it for yourself!

Using the Example​

Play the scene, pick up the pen, and tap "Use" without moving the pen much to cycle through the available colors. Hold "Use" and move the pen to make lines in 3D space, release "Use" to finish the line.

Drop the pen and pick up the eraser, then stick the eraser directly into any of your lines. Known Issue: In ClientSim, this does not highlight the line - it works in the VRChat Client.

Press "Use" to delete the selected line - this adds it back to your collection of 20 lines.

Stop the scene and then restart it to see your lines restored!

Importing the Example​

Follow the steps below to add this example to your Unity project:

  1. Open the Example Central Window from the window from the Unity Editor Menu under "VRChat SDK > 🏠 Example Central"
  2. Find this prefab in the list or search for it by title (same as the title of this page).
  3. Press the "Import" button to import the Unitypackage into your project.

Technical Breakdown​

The SimplePenSystem has a VRCPlayerObject component on it, which instructs VRChat to automatically spawn it for each player in the world, and remove it when they leave. VRCEnablePersistence ensures that all synced properties of the pen system, such as the positions, points, and colors of each line, are automatically saved and loaded.

Udon Program Details​

This experience is powered by two programs - one for the Pen, and another for each Line.

Udon Pen​

Check out the Udon Pen script in the scene under SimplePenSystem/Pen.

  • Change the gradient used as the Palette Color to swap the available colors.

Lines​

You can find the Lines the pen uses under SimplePenSystem/Lines.

  • If you want more lines available per pen, just duplicate some of the existing lines! No other changes are needed.
  • You can make changes per line, like setting different widths or materials.

Roadmap​

We plan to make the following improvements to this example in the future:

  • Respawn the pen whenever it's more than X units away from you.
  • Add a color picker where you hold a button to show a palette, then move to the color you want to use.
  • Refactor the prefab to allow infinite lines.