unity-vrc-skills-renovator

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

VRC Skills Renovator

VRC技能更新工具

Overview

概述

A guide for renovating (filling knowledge, refreshing, and improving quality of) VRChat-related skills in this repository.
本指南用于翻新(知识填充、内容刷新、质量提升)本仓库中与VRChat相关的技能。

Three Pillars of Renovation

翻新三大核心方向

PillarDescriptionExamples
FillAdding missing knowledgeUndocumented APIs, patterns, tips
RefreshUpdating outdated informationNew SDK version support, removing deprecated APIs
Quality ImprovementImproving accuracy and coverage of existing knowledgeAdding code examples, improving explanations
核心方向说明示例
补充添加缺失的知识未文档化的API、开发模式、实用技巧
刷新更新过时的信息新SDK版本支持、移除已废弃API
质量提升提升现有知识的准确性和覆盖范围添加代码示例、优化解释说明

Target Skills

目标技能

Path notation:
skills/
refers to the
skills/
directory at the repository root.
rules/
refers to files under
skills/unity-vrc-udon-sharp/rules/
. This skill itself resides at
.claude/skills/unity-vrc-skills-renovator/
(dev-only, not distributed via npm).
SkillDirectoryContent
unity-vrc-udon-sharp
skills/unity-vrc-udon-sharp/
UdonSharp coding, networking, events
unity-vrc-world-sdk-3
skills/unity-vrc-world-sdk-3/
VRC components, layer settings, world optimization
路径说明:
skills/
指代仓库根目录下的
skills/
文件夹。
rules/
指代
skills/unity-vrc-udon-sharp/rules/
下的文件。 本技能本身存放于
.claude/skills/unity-vrc-skills-renovator/
(仅用于开发,不通过npm分发)。
技能目录内容
unity-vrc-udon-sharp
skills/unity-vrc-udon-sharp/
UdonSharp编码、网络、事件相关内容
unity-vrc-world-sdk-3
skills/unity-vrc-world-sdk-3/
VRC组件、层设置、世界优化相关内容

Renovation Procedure

翻新流程

Phase 1: Current State Analysis

阶段1:现状分析

  1. Check the current SDK version support for each skill
text
Read: skills/unity-vrc-udon-sharp/SKILL.md
Read: skills/unity-vrc-world-sdk-3/SKILL.md
→ Check the "Supported SDK version" line in each file
  1. Check the file list for each skill
text
Glob: skills/unity-vrc-udon-sharp/**/*
Glob: skills/unity-vrc-world-sdk-3/**/*
  1. 检查每个技能当前支持的SDK版本
text
Read: skills/unity-vrc-udon-sharp/SKILL.md
Read: skills/unity-vrc-world-sdk-3/SKILL.md
→ 检查每个文件中的「Supported SDK version」行
  1. 检查每个技能的文件列表
text
Glob: skills/unity-vrc-udon-sharp/**/*
Glob: skills/unity-vrc-world-sdk-3/**/*

Phase 2: Information Gathering

阶段2:信息收集

Execute the following search queries in parallel to collect the latest information:
text
undefined
并行执行以下搜索查询以收集最新信息:
text
undefined

Required searches (parallel execution recommended)

必选搜索(建议并行执行)

  1. "VRChat SDK {current year} new features updates changelog"
  2. "UdonSharp VRChat SDK 3.{next minor version} changes"
  3. "VRChat Worlds SDK {current year} UdonSharp"
  4. "VRChat World SDK components new features {current year}"
  1. "VRChat SDK {current year} new features updates changelog"
  2. "UdonSharp VRChat SDK 3.{next minor version} changes"
  3. "VRChat Worlds SDK {current year} UdonSharp"
  4. "VRChat World SDK components new features {current year}"

Supplementary searches (as needed)

补充搜索(按需执行)

  1. "VRChat SDK NetworkCallable parameters"
  2. "VRChat SDK persistence PlayerData"
  3. "VRChat SDK PhysBones Contacts worlds"

See `references/search-queries.md` for details.
  1. "VRChat SDK NetworkCallable parameters"
  2. "VRChat SDK persistence PlayerData"
  3. "VRChat SDK PhysBones Contacts worlds"

查看 `references/search-queries.md` 了解详情。

Phase 3: Renovation Plan

阶段3:翻新计划

Classify collected information by the 3 pillars and target skills:
将收集到的信息按照三大核心方向目标技能进行分类:

Classification by Pillar

按核心方向分类

PillarContentAction
FillInformation not yet in the skillAdd new sections, add code examples
RefreshOutdated informationUpdate version references, remove deprecated APIs
Quality ImprovementInaccurate or insufficient descriptionsImprove explanations, add patterns
核心方向内容操作
补充技能中尚未收录的信息添加新章节、补充代码示例
刷新过时的信息更新版本引用、移除已废弃API
质量提升不准确或不完善的描述优化解释说明、补充开发模式

Classification by Skill

按技能分类

CategoryTarget SkillExamples
C# API, networking, sync variables
unity-vrc-udon-sharp
NetworkCallable, new events
Components, layers, optimization
unity-vrc-world-sdk-3
New components, setting changes
Affects bothBothSDK version references, Persistence
类别目标技能示例
C# API、网络、同步变量
unity-vrc-udon-sharp
NetworkCallable、新事件
组件、层、优化
unity-vrc-world-sdk-3
新组件、设置变更
同时影响两者全部SDK版本引用、持久化

Phase 4: Update unity-vrc-udon-sharp

阶段4:更新unity-vrc-udon-sharp

PriorityFileUpdate Content
1SKILL.mdSDK version support, new feature summary
2references/constraints.mdNewly available features
3references/networking.mdNew networking features
4references/events.mdNew events
5references/api.mdNew APIs
6CHEATSHEET.mdQuick reference update
7references/patterns.mdNew feature usage patterns
8references/troubleshooting.mdTroubleshooting
优先级文件更新内容
1SKILL.mdSDK版本支持、新特性汇总
2references/constraints.md新增可用特性
3references/networking.md新网络特性
4references/events.md新增事件
5references/api.md新增API
6CHEATSHEET.md速查手册更新
7references/patterns.md新特性使用模式
8references/troubleshooting.md问题排查内容

Phase 5: Update unity-vrc-world-sdk-3

阶段5:更新unity-vrc-world-sdk-3

PriorityFileUpdate Content
1SKILL.mdSDK version support, new feature summary
2references/components.mdNew components, property changes
3references/layers.mdLayer/collision changes
4references/performance.mdNew optimization guidelines
5references/lighting.mdLighting-related changes
6references/audio-video.mdAudio/video-related changes
7references/upload.mdUpload procedure changes
8CHEATSHEET.mdQuick reference update
9references/troubleshooting.mdTroubleshooting
优先级文件更新内容
1SKILL.mdSDK版本支持、新特性汇总
2references/components.md新组件、属性变更
3references/layers.md层/碰撞设置变更
4references/performance.md新优化指南
5references/lighting.md光照相关变更
6references/audio-video.md音视频相关变更
7references/upload.md上传流程变更
8CHEATSHEET.md速查手册更新
9references/troubleshooting.md问题排查内容

Phase 6: New File Creation (if needed)

阶段6:新建文件(按需)

When major new features are added:
  • Create a dedicated reference file in the corresponding skill's
    references/
  • Add a link in the corresponding SKILL.md Resources section
当添加重大新特性时:
  • 在对应技能的
    references/
    目录下创建专用参考文件
  • 在对应SKILL.md的资源部分添加链接

Phase 7: Rules & Enforcement Layer Sync

阶段7:规则与执行层同步

When the Knowledge layer (references/*.md) changes, always sync the Rules layer and Enforcement layer as well.
当知识层(references/*.md)发生变更时,必须同时同步规则层和执行层。

7a. Rules Layer — Auto-loaded Rules (skills/unity-vrc-udon-sharp/rules/)

7a. 规则层 — 自动加载规则(skills/unity-vrc-udon-sharp/rules/)

text
Read: skills/unity-vrc-udon-sharp/rules/udonsharp-constraints.md
Read: skills/unity-vrc-udon-sharp/rules/udonsharp-networking.md
Read: skills/unity-vrc-udon-sharp/rules/udonsharp-sync-selection.md
→ Check for differences with the Knowledge layer and reflect the same facts
Change TypeTarget Rule FileAction
Blocked feature added/removedudonsharp-constraints.mdUpdate block list / available list
Networking changesudonsharp-networking.mdUpdate sync modes, limits, patterns
Data budget changesudonsharp-sync-selection.mdUpdate budget values, decision tree
text
Read: skills/unity-vrc-udon-sharp/rules/udonsharp-constraints.md
Read: skills/unity-vrc-udon-sharp/rules/udonsharp-networking.md
Read: skills/unity-vrc-udon-sharp/rules/udonsharp-sync-selection.md
→ 检查与知识层的差异,同步更新内容
变更类型目标规则文件操作
新增/移除禁用特性udonsharp-constraints.md更新禁用/可用列表
网络相关变更udonsharp-networking.md更新同步模式、限制、开发模式
数据预算变更udonsharp-sync-selection.md更新预算值、决策树

7b. Enforcement Layer — Validation Hooks (hooks/)

7b. 执行层 — 校验钩子(hooks/)

text
Read: skills/unity-vrc-udon-sharp/hooks/validate-udonsharp.sh
Read: skills/unity-vrc-udon-sharp/hooks/validate-udonsharp.ps1
→ Add/remove/modify rules based on constraint changes
Change TypeHook-side Action
Feature unblockedRemove the corresponding grep pattern
New constraint addedAdd a new grep pattern
Limit value changedUpdate threshold (synced_count, etc.)
New anti-patternAdd a new warning rule
Important:
.sh
and
.ps1
must maintain the same rule set (don't update only one).
text
Read: skills/unity-vrc-udon-sharp/hooks/validate-udonsharp.sh
Read: skills/unity-vrc-udon-sharp/hooks/validate-udonsharp.ps1
→ 根据约束变更新增/移除/修改规则
变更类型钩子端操作
特性解禁移除对应的grep匹配规则
新增约束添加新的grep匹配规则
限制值变更更新阈值(synced_count等)
新增反模式添加新的警告规则
重要提示:
.sh
.ps1
必须保持规则集一致(不要只更新其中一个)。

7c. Enforcement Layer — Templates (assets/templates/)

7c. 执行层 — 模板(assets/templates/)

text
Read: skills/unity-vrc-udon-sharp/assets/templates/BasicInteraction.cs
Read: skills/unity-vrc-udon-sharp/assets/templates/SyncedObject.cs
Read: skills/unity-vrc-udon-sharp/assets/templates/PlayerSettings.cs
Read: skills/unity-vrc-udon-sharp/assets/templates/CustomInspector.cs
→ Remove deprecated patterns and reflect new best practices
Change TypeTemplate-side Action
New API becomes recommendedUpdate template to use the new API
Pattern becomes deprecatedRewrite to the recommended pattern
New best practiceReflect in the relevant template, or create a new template
text
Read: skills/unity-vrc-udon-sharp/assets/templates/BasicInteraction.cs
Read: skills/unity-vrc-udon-sharp/assets/templates/SyncedObject.cs
Read: skills/unity-vrc-udon-sharp/assets/templates/PlayerSettings.cs
Read: skills/unity-vrc-udon-sharp/assets/templates/CustomInspector.cs
→ 移除已废弃模式,同步新的最佳实践
变更类型模板端操作
新API成为推荐方案更新模板使用新API
模式被废弃重写为推荐模式
新增最佳实践同步到相关模板,或创建新模板

Phase 8: Validation

阶段8:校验

  1. Unify SDK version references across all files
  2. Verify cross-reference links between both skills
  3. Check code sample syntax
  4. 3-layer consistency check: Verify that Knowledge / Rules / Enforcement reflect the same facts
    • Constraint lists are consistent across all 3 layers
    • Limit values (synced variable count, string length, etc.) are consistent across all 3 layers
    • Templates do not use blocked features
  1. 统一所有文件中的SDK版本引用
  2. 验证两个技能之间的交叉引用链接
  3. 检查代码示例语法
  4. 三层一致性校验:验证知识层/规则层/执行层内容一致
    • 约束列表在三层中保持一致
    • 限制值(同步变量数量、字符串长度等)在三层中保持一致
    • 模板未使用被禁用的特性

Official Sources

官方来源

See
references/changelog-sources.md
for details.
查看
references/changelog-sources.md
了解详情。

Primary Sources

主要来源

SourceURLContent
SDK Releasescreators.vrchat.com/releases/Official release notes
UdonSharp Blogudonsharp.docs.vrchat.com/news/UdonSharp-specific updates
VRChat Cannyfeedback.vrchat.com/udonFeature requests and completion status
来源URL内容
SDK版本发布creators.vrchat.com/releases/官方发布说明
UdonSharp博客udonsharp.docs.vrchat.com/news/UdonSharp专属更新
VRChat Cannyfeedback.vrchat.com/udon功能需求和完成状态

WebSearch for Official Documentation

官方文档搜索

text
undefined
text
undefined

Search official documentation

搜索官方文档

WebSearch: "API name or feature site:creators.vrchat.com"
WebSearch: "API name or feature site:creators.vrchat.com"

UdonSharp API reference

UdonSharp API参考

WebSearch: "API name site:udonsharp.docs.vrchat.com"
undefined
WebSearch: "API name site:udonsharp.docs.vrchat.com"
undefined

Search Notes

搜索注意事项

  • The VRChat official site may return 403 errors, so use WebSearch instead of WebFetch
  • Japanese sources (Qiita, etc.) can be helpful but prioritize official information
  • Also check the UdonSharp releases page on GitHub
  • VRChat官方站点可能返回403错误,因此使用WebSearch而非WebFetch
  • 日语来源(Qiita等)可作为参考,但优先使用官方信息
  • 同时请查看GitHub上的UdonSharp发布页面

Renovation History Template

翻新版记录模板

Record renovations in the following format:
markdown
undefined
按照以下格式记录翻新操作:
markdown
undefined

Renovation History

翻新历史

YYYY-MM-DD - Summary (e.g., SDK X.Y.Z support / knowledge fill / quality improvement)

YYYY-MM-DD - 摘要(例如:SDK X.Y.Z支持 / 知识填充 / 质量提升)

Fill (New additions):
  • Added knowledge / sections
Refresh (Updates / Fixes):
  • Updated info / corrections
Quality Improvement:
  • Improved descriptions / added examples
Rules Layer Sync:
  • unity-vrc-udon-sharp/rules/udonsharp-constraints.md: changes
  • unity-vrc-udon-sharp/rules/udonsharp-networking.md: changes
Enforcement Layer Sync:
  • hooks/validate-udonsharp.sh: rules added/removed
  • hooks/validate-udonsharp.ps1: synced with .sh
  • assets/templates/SyncedObject.cs: pattern updated
Changed Files:
  • unity-vrc-udon-sharp/file.md: changes
  • unity-vrc-world-sdk-3/file.md: changes
3-Layer Consistency: OK / NG (details)
undefined
补充(新增内容):
  • 新增的知识/章节
刷新(更新/修复):
  • 更新的信息/修正内容
质量提升:
  • 优化的描述/新增的示例
规则层同步:
  • unity-vrc-udon-sharp/rules/udonsharp-constraints.md: 变更内容
  • unity-vrc-udon-sharp/rules/udonsharp-networking.md: 变更内容
执行层同步:
  • hooks/validate-udonsharp.sh: 新增/移除的规则
  • hooks/validate-udonsharp.ps1: 与.sh同步
  • assets/templates/SyncedObject.cs: 模式更新
变更文件:
  • unity-vrc-udon-sharp/file.md: 变更内容
  • unity-vrc-world-sdk-3/file.md: 变更内容
三层一致性: OK / NG(详细说明)
undefined