VC-create-vrchat-claude

English | 한국어

English

VRChat World development environment setup tool for Claude Code.

One command sets up everything students need to start building VRChat worlds with AI assistance.

What It Does

Running a single npx command in your VRChat Unity project folder:

1. Checks and installs Claude Code (if missing)
2. Checks and installs unity-cli (if missing)
3. Adds unity-cli connector to Unity packages
4. Checks API key setup
5. Creates CLAUDE.md with VRChat/UdonSharp conventions
6. Creates custom commands: /vrchat, /explain
7. Sets up Assets/Scripts/ folder

Prerequisites

• Unity 2022.3.x
• VRChat Creator Companion (VCC)
• Node.js 18+
• Anthropic API key

Usage

1. Create Project (GUI)

Open VCC → Create new World project → Open in Unity

2. Run Setup

Open a terminal in the project folder:

npx @0dot77/create-vrchat-claude

3. Start Claude Code

claude --model sonnet

4. Create Gimmicks

/vrchat a door that opens automatically when you approach
/vrchat stars falling from the sky when a button is pressed
/vrchat a light pillar that appears when 3 players gather in a circle

Commands

| Command | Description | |---|---| | /vrchat [description] | Describe what you want → auto-generates UdonSharp code, compiles, and provides Unity setup guide | | /explain | Explains the last generated code in beginner-friendly language |

How It Works

Student types: /vrchat door opens when I walk near it

Claude Code:
  1. Analyzes description → trigger, action, target
  2. Generates UdonSharp .cs file
  3. Runs: unity-cli asset refresh (compile)
  4. Runs: unity-cli console --filter error (check errors)
  5. If errors → auto-fix → recompile
  6. Outputs 4-step Unity setup guide

Project Structure (after setup)

YourVRChatProject/
├── CLAUDE.md                     ← VRChat conventions for Claude
├── .claude/
│   └── commands/
│       ├── vrchat.md             ← /vrchat command
│       └── explain.md            ← /explain command
├── Assets/
│   └── Scripts/                  ← Generated scripts go here
├── Packages/
│   └── manifest.json             ← unity-cli connector added
└── ...

License

MIT

한국어

VRChat 월드 개발을 위한 Claude Code 환경 자동 세팅 도구.

npx 한 줄로 학생들이 AI 기반 VRChat 월드 개발을 바로 시작할 수 있습니다.

이 도구가 하는 일

VRChat Unity 프로젝트 폴더에서 npx 한 줄 실행하면:

1. Claude Code 설치 확인 (없으면 자동 설치)
2. unity-cli 설치 확인 (없으면 자동 설치)
3. unity-cli connector Unity 패키지에 추가
4. API 키 설정 확인
5. CLAUDE.md 생성 (VRChat/UdonSharp 개발 컨벤션)
6. 커스텀 커맨드 생성: /vrchat, /explain
7. Assets/Scripts/ 폴더 세팅

사전 준비

• Unity 2022.3.x
• VRChat Creator Companion (VCC)
• Node.js 18+
• Anthropic API 키 (수업에서 제공)

사용법

1. 프로젝트 생성 (GUI)

VCC 열기 → 새 World 프로젝트 생성 → Unity에서 열기

2. 환경 세팅

프로젝트 폴더에서 터미널 열고:

npx @0dot77/create-vrchat-claude

이 한 줄이 모든 걸 알아서 세팅합니다!

3. Claude Code 시작

claude --model sonnet

4. 기믹 만들기

/vrchat 문 앞에 서면 자동으로 열리는 기믹
/vrchat 버튼 누르면 하늘에서 별이 떨어지는 효과
/vrchat 3명이 원 안에 모이면 빛기둥이 올라오는 기믹

커맨드

| 커맨드 | 설명 | |---|---| | /vrchat [설명] | 만들고 싶은 걸 자연어로 설명 → UdonSharp 코드 자동 생성 + 컴파일 + Unity 세팅 가이드 | | /explain | 마지막으로 만든 코드를 초보자 눈높이로 설명 |

작동 방식

학생 입력: /vrchat 문 앞에 서면 자동으로 열리는 기믹

Claude Code:
  1. 설명 분석 → 트리거, 동작, 대상 파악
  2. UdonSharp .cs 파일 생성
  3. unity-cli asset refresh (컴파일)
  4. unity-cli console --filter error (에러 확인)
  5. 에러 있으면 → 자동 수정 → 재컴파일
  6. 4단계 Unity 세팅 가이드 출력

세팅 후 프로젝트 구조

VRChat프로젝트/
├── CLAUDE.md                     ← Claude용 VRChat 컨벤션
├── .claude/
│   └── commands/
│       ├── vrchat.md             ← /vrchat 커맨드
│       └── explain.md            ← /explain 커맨드
├── Assets/
│   └── Scripts/                  ← 생성된 스크립트 저장 위치
├── Packages/
│   └── manifest.json             ← unity-cli connector 추가됨
└── ...

프롬프팅 팁

기본 공식: [트리거] + [동작] + [대상]

레벨 1 (단순):
  /vrchat 버튼 누르면 불 켜지는 기믹

레벨 2 (조건 추가):
  /vrchat 빨간 열쇠를 들고 있을 때만 문이 열리는 기믹

레벨 3 (연출 추가):
  /vrchat 거울 앞에 서면 2초 후 반사가 느리게 움직이고 왜곡되는 효과

레벨 4 (멀티플레이어):
  /vrchat 모든 플레이어가 스위치를 켜면 숨겨진 방이 나타나는 기믹

수정은 대화로:

"속도 좀 느리게 해줘"
"사운드도 추가해줘"
"멀티플레이어 동기화 붙여줘"

라이선스

MIT