⚙️ UdonSharp Toybox by Kuroné Kito

My utilities library for the UdonSharp / VRChat

💻 System Requirements

• VRChat Creator Companion
• Unity 2022.3.22f1
• 🏝 Project of your world

▶ Getting Started

See the documentation

💡 Features

• 📱 Architecture free! (Windows, Android / Quest, iOS)
• 🖱 UI parts with global sync
• 🫥 Object teleporter by turning the object on or off
• ⌛ Long-press interaction
• 🛎 Notify sound playing gimmick on player joined
• 🌈 Logger with vivid colors
• ⚙️ Other features...

🧩 Example Scenes and Prefabs

Sample scenes showcasing each feature are available under Packages/black.kit.toybox/Examples.

Scenes

• ConditionalActiveRelayToAnimator.unity: relay animator parameters when objects toggle on or off.
• Doorbell.unity: simple sound trigger example.
• GlobalScroll.unity: synchronized scroll view.
• GlobalSlider.unity: synchronized slider control.
• GlobalToggle.unity: synchronized single toggle.
• GlobalToggles.unity: synchronized multiple toggles.
• LongPressTrigger.unity: long‑press button behaviour.
• PositionAnchor.unity: move objects between preset positions.
• SequenceActiveRelayToAnimator.unity: step through animator parameters in sequence.
• TickingDown.unity: display the current time repeatedly.
• ToggleWithAnimator.unity: link a UI toggle with an Animator component.
• TmpUrlSticky.unity: URL opener using TextMeshPro.
• UrlSticky.unity: open a URL when clicked.
• Whitelist.unity: enable objects for whitelisted user names.

CommonFloor.prefab: provides a simple floor used across these scenes.

Running the samples

1. Install VRChat Creator Companion and create a world project with Unity 2022.3.22f1.
2. Add UdonSharp Toybox via VPM or clone this repository into the project's Packages folder.
3. Open any scene in Packages/black.kit.toybox/Examples/Scenes from the Unity editor.
4. Enter Play mode to try the feature.

Contributing

Welcome to contribute to this repository! For more details, please refer to CONTRIBUTING.md.

🛠 Using git vrc Filter

This project uses a custom git filter named git vrc to normalize Unity files such as .asset, .prefab, and .unity. The filter removes unstable data so diffs stay readable and merges remain smooth.

1. Install the git-vrc package

cargo install --locked --git 'https://github.com/anatawa12/git-vrc.git'
git vrc install --config --global

2. Make the .gitconfig file available for referencing from local .git/config

git config include.path '../.gitconfig'

The .gitattributes file in this repository already applies the filter to Unity YAML files.

License

This repository is licensed under the MIT License.