You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 9f1ad30
Browse filesBrowse the repository at this point in the historyBrowse files
Remove the ECS scaffolding claim and the "200+ entries" count, and
document target_type, ranked search, URP-only HLSL, data path behavior,
and how to run the tests.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MpEiWjv38TrdFcgqU8ER5L
Copy file name to clipboardExpand all lines: docs/index.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@
10
10
11
11
Unity Developer Tools is a plugin for [Cursor](https://www.cursor.com/) that teaches its AI assistant how to build Unity games and tools. Once installed, you can ask the AI to:
12
12
13
-
- Scaffold MonoBehaviours, ScriptableObjects, Editor windows, and ECS systems
13
+
- Scaffold MonoBehaviours, ScriptableObjects, Editor windows, inspectors, and tests
14
14
- Look up Unity APIs by name, namespace, or category
15
15
- Generate shader patterns for common effects (dissolve, outline, hologram, etc.)
16
16
- Get platform-specific defines, capabilities, and build recommendations
@@ -29,7 +29,7 @@ For a detailed walkthrough, see the [Getting Started guide](GETTING-STARTED.md).
29
29
30
30
## Features
31
31
32
-
-**Script scaffolding** -- Generate MonoBehaviours, ScriptableObjects, Editor windows, and ECS systems following Unity 6 conventions
32
+
-**Script scaffolding** -- Generate MonoBehaviours, ScriptableObjects, Editor windows, inspectors, state machines, and tests following Unity 6 conventions
33
33
-**API lookup** -- Search common Unity APIs by name, namespace, or category via MCP tools
34
34
-**Shader patterns** -- Get HLSL code and Shader Graph node setups for common effects
35
35
-**Performance-aware coding rules** -- Catch deprecated APIs, allocation-heavy patterns, and common mistakes
-**target_type**: Type inspected or drawn, for custom-inspector and property-drawer. Defaults to the name without its Editor/Inspector/Drawer suffix (`PlayerEditor` -> `Player`)
12
13
13
14
### lookup_api
14
-
Search the Unity API reference database for classes, methods, and usage patterns.
15
+
Search the Unity API reference database for classes, methods, and usage patterns. Multi-word queries match entries containing every word; exact name matches rank first.
15
16
-**query**: Search term (class name, method name, or keyword)
Get shader code patterns and property setups for common effects.
20
+
Get shader code patterns and property setups for common effects. Hand-written HLSL currently targets URP; HDRP and Built-in requests return properties and Shader Graph guidance only.
20
21
-**effect**: Effect name (dissolve, outline, toon, water, hologram, fresnel)
The server reads its data from `data/` next to `server.py`, so it can be started from any directory. Set `UNITY_DATA_PATH` to use a different data folder. If a data file is missing, the server exits with an error instead of returning empty results.
39
+
40
+
## Testing
41
+
42
+
```bash
43
+
pip install -r requirements-dev.txt
44
+
python -m pytest tests
45
+
```
46
+
47
+
The suite covers every tool and includes a stdio smoke test that starts the server and calls it through the MCP client.
48
+
37
49
## Data Files
38
50
39
-
-`unity_api_common.json` - Common Unity API reference (200+ classes and methods)
51
+
-`unity_api_common.json` - Curated Unity 6 API reference (75 entries across 9 categories)
40
52
-`shader_properties.json` - Built-in shader properties and effect patterns
41
53
-`platform_defines.json` - Platform scripting defines and capabilities
42
54
-`lifecycle_order.json` - MonoBehaviour execution order reference
0 commit comments