Skip to content
Back to search

agent-skills-vrc-udon

MarketplaceWorks with Claude CodeGitHubIncomplete

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/niaka3dayo--agent-skills-vrc-udon/badge.svg)](/listings/niaka3dayo--agent-skills-vrc-udon)

HTML

<a href="/listings/niaka3dayo--agent-skills-vrc-udon"><img src="/api/listings/niaka3dayo--agent-skills-vrc-udon/badge.svg" alt="findsafeskills safety rating" /></a>

Install

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

All published versions remain permanently available on npm and as git tags — nothing is ever removed.

# skills CLI, pinned to a git tag
npx skills add https://github.com/niaka3dayo/agent-skills-vrc-udon/tree/v2.3.0

# npm (any published version, v1.0.0 and later); the skills are in node_modules/agent-skills-vrc-udon/skills/
npm install --save-exact agent-skills-vrc-udon@2.3.0

# git tag
git clone --branch v2.3.0 https://github.com/niaka3dayo/agent-skills-vrc-udon.git

---

<h2 id="structure">Structure</h2>

skills/                                  # All skills
  unity-vrc-udon-sharp/                 # UdonSharp core skill
    SKILL.md                              # Skill definition + frontmatter
    LICENSE.txt                           # MIT License
    CHEATSHEET.md                         # Quick reference (1 page)
    rules/                               # Constraint rules
      udonsharp-constraints.md
      udonsharp-networking.md
      udonsharp-sync-selection.md
    hooks/                               # PostToolUse validation
      validate-udonsharp.sh
      validate-udonsharp.ps1
    assets/templates/                    # Code templates (17 files)
    references/                          # Detailed documentation (25 files)
  unity-vrc-world-sdk-3/                # VRC World SDK skill
    SKILL.md, LICENSE.txt, CHEATSHEET.md, references/ (8 files)
templates/                               # AI tool config templates
  CLAUDE.md  AGENTS.md  GEMINI.md        # Starter project instructions (copy manually)
.claude-plugin/marketplace.json         # Claude Code plugin registration
hooks/hooks.json                        # Claude Code plugin hook registration
CLAUDE.md                               # Development guide (this repo only)

---

<h2 id="skills">Skills</h2>

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json · Manifest · 21 lines
  1. {
  2. "name": "agent-skills-vrc-udon",
  3. "owner": {
  4. "name": "niaka3dayo"
  5. },
  6. "metadata": {
  7. "description": "AI Agent Skills for VRChat UdonSharp world development",
  8. "version": "4.3.1"
  9. },
  10. "plugins": [
  11. {
  12. "name": "vrc-udon-skills",
  13. "description": "VRChat UdonSharp skills, rules, and validation hooks for correct code generation",
  14. "source": "./",
  15. "skills": [
  16. "./skills/unity-vrc-udon-sharp",
  17. "./skills/unity-vrc-world-sdk-3"
  18. ]
  19. }
  20. ]
  21. }
README.md · README · 340 lines
  1. **English** | [日本語](README.ja.md) | [简体中文](README.zh-CN.md) | [繁體中文](README.zh-TW.md) | [한국어](README.ko.md)
  2. <p align="center">
  3. <img src="https://img.shields.io/badge/VRChat_SDK-3.10.6-00b4d8?style=for-the-badge" alt="VRChat SDK" />
  4. <img src="https://img.shields.io/badge/UdonSharp-C%23_%E2%86%92_Udon-5C2D91?style=for-the-badge&logo=csharp&logoColor=white" alt="UdonSharp" />
  5. <img src="https://img.shields.io/badge/AI_Agent-Skills_%26_Rules-ff6b35?style=for-the-badge" alt="Agent Skills" />
  6. <img src="https://img.shields.io/github/license/niaka3dayo/agent-skills-vrc-udon?style=for-the-badge" alt="License" />
  7. </p>
  8. <p align="center">
  9. <img src="https://img.shields.io/npm/v/agent-skills-vrc-udon?style=flat-square&label=npm" alt="npm version" />
  10. <img src="https://img.shields.io/npm/dm/agent-skills-vrc-udon?style=flat-square&label=downloads" alt="npm downloads" />
  11. <img src="https://img.shields.io/github/actions/workflow/status/niaka3dayo/agent-skills-vrc-udon/ci.yml?branch=dev&style=flat-square&label=CI" alt="CI" />
  12. </p>
  13. <h1 align="center">Agent Skills for VRChat UdonSharp</h1>
  14. <p align="center">
  15. <b>Skills, rules, and validation hooks that teach AI coding agents to generate correct UdonSharp code</b>
  16. </p>
  17. <p align="center">
  18. <a href="#about">About</a> &bull;
  19. <a href="#install">Install</a> &bull;
  20. <a href="#structure">Structure</a> &bull;
  21. <a href="#skills">Skills</a> &bull;
  22. <a href="#rules">Rules</a> &bull;
  23. <a href="#hooks">Hooks</a> &bull;
  24. <a href="#contributing">Contributing</a> &bull;
  25. <a href="#disclaimer">Disclaimer</a>
  26. </p>
  27. ---
  28. <h2 id="about">About</h2>
  29. VRChat world development with **UdonSharp** (C# &rarr; Udon Assembly) has strict compile constraints that differ significantly from standard C#. In Udon runtime code, features like `List<T>`, `async/await`, `try/catch`, LINQ, and lambdas cause **compile errors**. Editor-evaluated field initializers are a separate C# context and may use some of these features to generate a final field value that Udon supports.
  30. This repository provides AI coding agents with the knowledge to generate correct UdonSharp code from the start.
  31. | Problem | Solution |
  32. |---------|----------|
  33. | AI generates Udon-incompatible `List<T>`, `async/await`, etc. in runtime code | Rules + hooks auto-detect and warn |
  34. | Sync variable bloat | Decision tree + data budget |
  35. | Incorrect networking patterns | Pattern library + anti-patterns |
  36. | SDK version feature differences | Version table with feature mapping |
  37. | Late Joiner state inconsistency | Sync pattern selection framework |
  38. **This is NOT:**
  39. - A VRChat SDK or UdonSharp distribution
  40. - A Unity project (no executable code)
  41. - A replacement for [official VRChat documentation](https://creators.vrchat.com/)
  42. - A guarantee of all AI behaviors
  43. > **Issues**: Bug reports and knowledge requests are welcome via [GitHub Issues](https://github.com/niaka3dayo/agent-skills-vrc-udon/issues).
  44. > **PRs**: Pull Requests are not accepted. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
  45. ---
  46. <h2 id="install">Install</h2>
  47. > **Migrating from fork/clone?** &mdash; You no longer need to fork or clone this repository. Run one of the install commands below inside your VRChat Unity project. If you cloned this repo earlier, you can delete the cloned directory after switching.
  48. ### Method 1: skills CLI (recommended)
  49. ```bash
  50. npx skills add niaka3dayo/agent-skills-vrc-udon
  51. ```
  52. This uses the [skills.sh](https://skills.sh) ecosystem to install skills into your project. The skills CLI requires Node.js 22.20 or later.
  53. ### Method 2: Claude Code plugin
  54. ```bash
  55. claude plugin install vrc-udon-skills --marketplace niaka3dayo/agent-skills-vrc-udon
  56. ```
  57. On Claude Code older than 2.1.292, run `claude plugin marketplace add niaka3dayo/agent-skills-vrc-udon` first, then `claude plugin install vrc-udon-skills@agent-skills-vrc-udon`.
  58. ### Method 3: git clone
  59. ```bash
  60. git clone https://github.com/niaka3dayo/agent-skills-vrc-udon.git
  61. ```
  62. ### Installing a specific version
  63. All published versions remain permanently available on npm and as git tags — nothing is ever removed.
  64. ```bash
  65. # skills CLI, pinned to a git tag
  66. npx skills add https://github.com/niaka3dayo/agent-skills-vrc-udon/tree/v2.3.0
  67. # npm (any published version, v1.0.0 and later); the skills are in node_modules/agent-skills-vrc-udon/skills/
  68. npm install --save-exact agent-skills-vrc-udon@2.3.0
  69. # git tag
  70. git clone --branch v2.3.0 https://github.com/niaka3dayo/agent-skills-vrc-udon.git
  71. ```
  72. ---
  73. <h2 id="structure">Structure</h2>
  74. ```
  75. skills/ # All skills
  76. unity-vrc-udon-sharp/ # UdonSharp core skill
  77. SKILL.md # Skill definition + frontmatter
  78. LICENSE.txt # MIT License
  79. CHEATSHEET.md # Quick reference (1 page)
  80. rules/ # Constraint rules
  81. udonsharp-constraints.md
  82. udonsharp-networking.md
  83. udonsharp-sync-selection.md
  84. hooks/ # PostToolUse validation
  85. validate-udonsharp.sh
  86. validate-udonsharp.ps1
  87. assets/templates/ # Code templates (17 files)
  88. references/ # Detailed documentation (25 files)
  89. unity-vrc-world-sdk-3/ # VRC World SDK skill
  90. SKILL.md, LICENSE.txt, CHEATSHEET.md, references/ (8 files)
  91. templates/ # AI tool config templates
  92. CLAUDE.md AGENTS.md GEMINI.md # Starter project instructions (copy manually)
  93. .claude-plugin/marketplace.json # Claude Code plugin registration
  94. hooks/hooks.json # Claude Code plugin hook registration
  95. CLAUDE.md # Development guide (this repo only)
  96. ```
  97. ---
  98. <h2 id="skills">Skills</h2>
  99. ### unity-vrc-udon-sharp
  100. UdonSharp scripting core skill. Covers compile constraints, networking, events, and templates.
  101. | Area | Content |
  102. |------|---------|
  103. | **Constraints** | C# features blocked in Udon runtime, their alternatives (`List<T>` &rarr; `DataList`, `async` &rarr; `SendCustomEventDelayedSeconds`), and the Editor-evaluated initializer boundary |
  104. | **Networking** | Ownership model, Manual/Continuous sync, FieldChangeCallback, anti-patterns |
  105. | **NetworkCallable** | Introduced in SDK 3.8.1: parameterized network events (up to 8 args) |
  106. | **Persistence** | Introduced in SDK 3.7.4: PlayerData/PlayerObject API |
  107. | **Dynamics** | Introduced in SDK 3.10.0: PhysBones, Contacts, VRC Constraints for Worlds |
  108. | **Web Loading** | String/Image download, VRCJson, VRCUrl constraints |
  109. | **Templates** | 17 templates (interactions, sync patterns, persistence, editor utilities, and more) |
  110. ### unity-vrc-world-sdk-3
  111. World-level scene setup, component placement, and optimization.
  112. | Area | Content |
  113. |------|---------|
  114. | **Scene Setup** | VRC_SceneDescriptor, spawn points, Reference Camera |
  115. | **Components** | VRC_Pickup, Station, ObjectSync, Mirror, Portal, CameraDolly |
  116. | **Layers** | VRChat reserved layers and collision matrix |
  117. | **Performance** | FPS targets, Quest/Android limits, optimization checklist |
  118. | **Lighting** | Baked lighting best practices |
  119. | **Audio/Video** | Spatial audio, video player selection (AVPro vs Unity) |
  120. | **Upload** | Build and upload workflow, pre-upload checklist |
  121. ---
  122. <h2 id="rules">Rules</h2>
  123. Rules are constraint files that guide AI agents before code generation.
  124. | Rule File | Content |
  125. |-----------|---------|
  126. | `udonsharp-constraints` | Blocked C# features, code generation rules, attributes, syncable types |
  127. | `udonsharp-networking` | Ownership model, sync modes, anti-patterns, NetworkCallable constraints |
  128. | `udonsharp-sync-selection` | Sync decision tree, data budget targets, 6 minimization principles |
  129. **Networking rule:** A parameterless `public` method without a leading `_` is a legacy network entry. Prefix local-only/custom public methods with `_`, and use `[NetworkCallable]` to expose only intentional entries. Confirm `NetworkCalling.InNetworkCall` before reading `NetworkCalling.CallingPlayer`; authorize the caller separately from receiver ownership. Never use instance master as a security or access-control boundary.
  130. ### Sync Decision Tree
  131. ```
  132. Q1: Visible to other players?
  133. No --> No sync (0 bytes)
  134. Yes --> Q2
  135. Q2: Late Joiner needs current state?
  136. No --> Events only (0 bytes)
  137. Yes --> Q3
  138. Q3: Continuous change? (position/rotation)
  139. Yes --> Continuous sync
  140. No --> Manual sync (minimal [UdonSynced])
  141. ```
  142. **Target**: < 50 bytes per behaviour. Small-medium worlds: < 100 bytes total.
  143. ---
  144. <h2 id="hooks">Validation Hooks</h2>
  145. A PostToolUse hook checks every `.cs` file the agent writes or edits and reports what it finds back to the agent.
  146. **Claude Code plugin** &mdash; registered automatically. The plugin runs the Bash validator, so `bash` must be on `PATH`. On Windows, Git Bash is enough; `jq` is not needed.
  147. **skills CLI or git clone** &mdash; register the hook yourself. For Claude Code, add this to `.claude/settings.json`:
  148. ```json
  149. {
  150. "hooks": {
  151. "PostToolUse": [
  152. {
  153. "matcher": "Write|Edit",
  154. "hooks": [
  155. {
  156. "type": "command",
  157. "command": "bash \"$CLAUDE_PROJECT_DIR/.claude/skills/unity-vrc-udon-sharp/hooks/validate-udonsharp.sh\""
  158. }
  159. ]
  160. }
  161. ]
  162. }
  163. }
  164. ```
  165. To use the PowerShell validator, set the command to `pwsh -NoProfile -File "$CLAUDE_PROJECT_DIR/.claude/skills/unity-vrc-udon-sharp/hooks/validate-udonsharp.ps1"`.
  166. | Category | Check | Severity |
  167. |----------|-------|----------|
  168. | Context-sensitive Features | `List<T>`, LINQ, lambdas (blocked in Udon runtime; may be valid in Editor-evaluated field initializers) | WARNING |
  169. | Blocked Runtime Features | `async/await`, `try/catch`, coroutines | ERROR |
  170. | Blocked Patterns | `AddListener()`, `StartCoroutine()` | ERROR |
  171. | Networking | `[UdonSynced]` without `RequestSerialization()` | WARNING |
  172. | Networking | `[UdonSynced]` without `Networking.SetOwner()` | WARNING |
  173. | Sync Bloat | 6+ synced variables per behaviour | WARNING |
  174. | Sync Bloat | `int[]`/`float[]` sync (recommend smaller types) | WARNING |
  175. | Config Mismatch | `NoVariableSync` mode with `[UdonSynced]` fields | ERROR |
  176. | Config Mismatch | `None` mode with `[NetworkCallable]` or a `SendCustomNetworkEvent` call on itself (the event is never delivered) | WARNING |
  177. Supports both **Bash** (`validate-udonsharp.sh`) and **PowerShell** (`validate-udonsharp.ps1`).
  178. Findings reach the agent as additional context on the edit, and the same lines are printed to stderr for manual runs. The hook never blocks an edit.
  179. When a validator cannot run, for example because it cannot read the hook input or the file, it reports `VALIDATOR-WARNING: validation skipped (<reason>)`; the hook does not silently claim that validation succeeded.
  180. Codex edits files with `apply_patch`, which passes the patch text to the hook instead of a file path. Both validators accept that input and check each `.cs` file named in the patch.
  181. ---
  182. ## SDK Versions
  183. **Active support / last verified**: VRChat SDK 3.10.6
  184. From v4.0.0 onward, the support policy is latest stable SDK only; the support target moves to a new stable release only after this repository verifies it. A new stable release is not supported automatically. Current last verified target: 3.10.6.
  185. The table below keeps historical feature-introduction notes for migration reference. SDK 3.7.1-3.10.5 entries are historical information only; they are not active support or validation targets for this Skill. This is the Skill's support boundary, not a statement about VRChat's own SDK policy.
  186. | SDK Version | Key Features | Status |
  187. |:-----------:|:-------------|:------:|
  188. | **3.7.1** | `StringBuilder`, `Regex`, `System.Random` | Historical |
  189. | **3.7.4** | Persistence API (PlayerData / PlayerObject) | Historical |
  190. | **3.7.6** | Multi-platform Build & Publish (PC + Android) | Historical |
  191. | **3.8.0** | PhysBone dependency sorting, Force Kinematic On Remote | Historical |
  192. | **3.8.1** | `[NetworkCallable]` parameterized events, `Others`/`Self` targets | Historical |
  193. | **3.9.0** | Camera Dolly API, Auto Hold pickup | Historical |
  194. | **3.10.0** | VRChat Dynamics for Worlds (PhysBones, Contacts, VRC Constraints) | Historical |
  195. | **3.10.1** | Bug fixes, stability improvements | Historical |
  196. | **3.10.2** | EventTiming.PostLateUpdate/FixedUpdate, PhysBones fixes, shader time globals | Historical |
  197. | **3.10.3** | `VRCPlayerApi.isVRCPlus`, VRCRaycast (avatar), Mirror render-order fix | Historical |
  198. | **3.10.4** | VRCTween, Box-shaped Contacts, Global Avatar PhysBone Colliders, world `VRCPhysBoneCollider` Udon access, DataList/DataDictionary capacity APIs | Historical |
  199. | **3.10.5** | WorldQualitySettings, writable VRCQualitySettings, Assembly Version Defines, Pickup Outline Renderers, Pipeline Manager validation | Historical |
  200. | **3.10.6** | VRCBillboard, VRCVelocityTracker, VRCPlacementZone, constraint source methods and Smoothing Factor, Interact Outline Renderers, UdonSharp enum-comparison and named-argument fixes | Active / Last verified |
  201. > **Note**: Before publishing, confirm that the project uses an SDK version currently supported by VRChat.
  202. ---
  203. ## Official Resources
  204. | Resource | URL |
  205. |----------|-----|
  206. | VRChat Creators Docs | https://creators.vrchat.com/ |
  207. | UdonSharp API Reference | https://udonsharp.docs.vrchat.com/ |
  208. | VRChat Forums (Q&A) | https://ask.vrchat.com/ |
  209. | VRChat Canny (Bugs/Features) | https://feedback.vrchat.com/ |
  210. | VRChat Community GitHub | https://github.com/vrchat-community |
  211. ---
  212. <h2 id="community-contributors">Community Contributors</h2>
  213. This project has benefited from people who took the time to file concrete Issues and help verify the fixes. Thank you to:
  214. <!-- community-contributors:start -->
  215. <p>
  216. <a href="https://github.com/KatanoShingo" title="@KatanoShingo"><img src="https://github.com/KatanoShingo.png?size=64" width="64" height="64" alt="@KatanoShingo"></a>
  217. <a href="https://github.com/Guribo" title="@Guribo"><img src="https://github.com/Guribo.png?size=64" width="64" height="64" alt="@Guribo"></a>
  218. <a href="https://github.com/haru0416-dev" title="@haru0416-dev"><img src="https://github.com/haru0416-dev.png?size=64" width="64" height="64" alt="@haru0416-dev"></a>
  219. <a href="https://github.com/Yodokoro" title="@Yodokoro"><img src="https://github.com/Yodokoro.png?size=64" width="64" height="64" alt="@Yodokoro"></a>
  220. <a href="https://github.com/tetradice" title="@tetradice"><img src="https://github.com/tetradice.png?size=64" width="64" height="64" alt="@tetradice"></a>
  221. <a href="https://github.com/owlboy" title="@owlboy"><img src="https://github.com/owlboy.png?size=64" width="64" height="64" alt="@owlboy"></a>
  222. <a href="https://github.com/nomlasvrc" title="@nomlasvrc"><img src="https://github.com/nomlasvrc.png?size=64" width="64" height="64" alt="@nomlasvrc"></a>
  223. <a href="https://github.com/ureishi" title="@ureishi"><img src="https://github.com/ureishi.png?size=64" width="64" height="64" alt="@ureishi"></a>
  224. <a href="https://github.com/irucaVRC" title="@irucaVRC"><img src="https://github.com/irucaVRC.png?size=64" width="64" height="64" alt="@irucaVRC"></a>
  225. </p>
  226. <!-- community-contributors:end -->
  227. ---
  228. <h2 id="contributing">Contributing</h2>
  229. **Issues are welcome** -- bug reports and knowledge requests help improve this project.
  230. **Pull Requests are not accepted** -- all fixes and updates are made by the maintainer.
  231. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
  232. ---
  233. <h2 id="disclaimer">Disclaimer</h2>
  234. > **This project is not affiliated with VRChat Inc. No official endorsement, partnership, or association is implied.**
  235. >
  236. > "VRChat", "UdonSharp", "Udon" and related names/logos are trademarks of VRChat Inc. All trademarks belong to their respective owners.
  237. >
  238. > This repository is a **personal knowledge base** for AI coding agents to generate correct UdonSharp code. It does not distribute any part of the VRChat SDK or UdonSharp compiler.
  239. ### Accuracy
  240. - Content is provided **"AS IS"** without warranty. See [LICENSE](LICENSE).
  241. - This is a personal project. **Errors, outdated information, or incomplete content may exist.** Always verify against [official VRChat documentation](https://creators.vrchat.com/).
  242. - The author assumes no liability for issues caused by this repository (build errors, upload rejections, unexpected world behavior, etc.).
  243. - Active SDK support is limited to 3.10.6, the last verified target. Older version entries are historical migration information, not a promise to test or fix those SDKs. Behavior may change with new VRChat releases.
  244. ### AI-Assisted Creation
  245. This knowledge base was created and maintained with AI tool assistance (Claude, Gemini, Codex). All content has been reviewed, but AI-generated portions may contain subtle errors. Use at your own risk.
  246. ---
  247. ## License
  248. This project is licensed under the **MIT License**. See [LICENSE](LICENSE) for details.
  249. Fork, modify, and redistribute freely under MIT License terms. This license applies to the documentation, rules, templates, and hooks in this repository. It does **not** grant any rights to VRChat's SDK, UdonSharp compiler, or other VRChat intellectual property.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.