1- # Unity Developer Tools
2-
3- ** AI-powered development toolkit for Unity game development in Cursor IDE.**
4-
5- ![ License: CC BY-NC-ND 4.0] ( https://img.shields.io/badge/license-CC%20BY--NC--ND%204.0-lightgrey )
6- ![ Version] ( https://img.shields.io/badge/version-1.2.0-blue )
7- ![ GitHub stars] ( https://img.shields.io/github/stars/TMHSDigital/Unity-Developer-Tools )
8-
9- [ ** Getting Started** ] ( docs/GETTING-STARTED.md ) | [ Features] ( #features ) | [ Quick Start] ( #quick-start ) | [ MCP Server] ( #mcp-server ) | [ Skills] ( #skills-18 ) | [ Rules] ( #rules-8 ) | [ Roadmap] ( #roadmap )
1+ <p align =" center " >
2+ <img src =" assets/logo.png " alt =" Unity Developer Tools " width =" 150 " />
3+ </p >
4+
5+ <h1 align =" center " >Unity Developer Tools</h1 >
6+
7+ <p align =" center " >
8+ <strong >AI-powered development toolkit for Unity game development in Cursor IDE.</strong >
9+ </p >
10+
11+ <p align =" center " >
12+ <img src =" https://img.shields.io/badge/license-CC%20BY--NC--ND%204.0-lightgrey " alt =" License: CC BY-NC-ND 4.0 " />
13+ <img src =" https://img.shields.io/badge/version-1.2.0-blue " alt =" Version " />
14+ <img src =" https://img.shields.io/github/stars/TMHSDigital/Unity-Developer-Tools " alt =" GitHub stars " />
15+ </p >
16+
17+ <p align =" center " >
18+ <a href =" docs/GETTING-STARTED.md " ><strong >Getting Started</strong ></a > &bull ;
19+ <a href =" #features " >Features</a > &bull ;
20+ <a href =" #quick-start " >Quick Start</a > &bull ;
21+ <a href =" #mcp-server " >MCP Server</a > &bull ;
22+ <a href =" #skills-18 " >Skills</a > &bull ;
23+ <a href =" #rules-8 " >Rules</a > &bull ;
24+ <a href =" #roadmap " >Roadmap</a >
25+ </p >
1026
1127---
1228
13- > 18 skills - 8 rules - 4 MCP tools - 20 snippets - 5 templates
29+ <p align =" center " >
30+ 18 skills   ;&bull ;  ; 8 rules   ;&bull ;  ; 4 MCP tools   ;&bull ;  ; 20 snippets   ;&bull ;  ; 5 templates
31+ </p >
1432
1533Scaffold Unity scripts, look up APIs, generate shader patterns, detect render pipelines, and write optimized C# -- all from within Cursor's AI chat. Covers the full Unity development lifecycle from project setup to platform deployment.
1634
17- [ ** Getting Started Guide** ] ( docs/GETTING-STARTED.md )
35+ <p align =" center " >
36+ <a href =" docs/GETTING-STARTED.md " ><img src =" https://img.shields.io/badge/%F0%9F%8E%AE_GETTING_STARTED_GUIDE-blue?style=for-the-badge " alt =" Getting Started Guide " /></a >
37+ </p >
1838
19- > ** First time here?** The ** Getting Started guide** walks you through every step -- from installing prerequisites to building your first Unity project with AI assistance. No prior Cursor plugin experience required.
39+ > ** First time here?** The ** [ Getting Started guide] ( docs/GETTING-STARTED.md ) ** walks you through every step -- from installing prerequisites to building your first Unity project with AI assistance. No prior Cursor plugin experience required.
2040
2141## How It Works
2242
@@ -45,7 +65,7 @@ cd mcp-server && pip install -r requirements.txt
4565
4666Then ask the AI agent to scaffold a MonoBehaviour, look up an API, or generate a shader effect.
4767
48- > ** Need more detail?** The [ ** Getting Started guide** ] ( docs/GETTING-STARTED.md ) covers installing prerequisites, troubleshooting, and building your first project step by step.
68+ > ** Need more detail?** The ** [ Getting Started guide] ( docs/GETTING-STARTED.md ) ** covers installing prerequisites, troubleshooting, and building your first project step by step.
4969
5070## Features
5171
@@ -61,8 +81,10 @@ Then ask the AI agent to scaffold a MonoBehaviour, look up an API, or generate a
6181<details >
6282<summary ><strong >Supported Workflows</strong ></summary >
6383
84+   ;
85+
6486| Workflow | Description |
65- | ---------- | - ------------|
87+ | : ---------| : ------------|
6688| MonoBehaviour | Classic Unity scripting with lifecycle methods |
6789| ScriptableObject Architecture | Data-driven design with events, variables, runtime sets |
6890| ECS/DOTS | High-performance data-oriented tech stack |
@@ -74,8 +96,10 @@ Then ask the AI agent to scaffold a MonoBehaviour, look up an API, or generate a
7496<details >
7597<summary ><strong >Supported Render Pipelines</strong ></summary >
7698
99+   ;
100+
77101| Pipeline | Status |
78- | ---------- | - -------|
102+ | : ---------| : -------|
79103| ** URP** (Universal) | Primary -- recommended for all new projects |
80104| ** HDRP** (High Definition) | Supported -- maintenance mode guidance |
81105| ** Built-in** (Legacy) | Migration guidance -- deprecated in Unity 6.5 |
@@ -85,8 +109,10 @@ Then ask the AI agent to scaffold a MonoBehaviour, look up an API, or generate a
85109<details >
86110<summary ><strong >Supported Platforms</strong ></summary >
87111
112+   ;
113+
88114| Platform | Backend |
89- | ---------- | - --------|
115+ | : ---------| : --------|
90116| Windows | IL2CPP or Mono |
91117| macOS | IL2CPP or Mono |
92118| Linux | IL2CPP or Mono |
@@ -100,7 +126,7 @@ Then ask the AI agent to scaffold a MonoBehaviour, look up an API, or generate a
100126## Skills (18)
101127
102128| Skill | What it does |
103- | ------- | -------------|
129+ | : ------| : -------------|
104130| ** Project Setup** | Unity project configuration, folder structure, assembly definitions, package management |
105131| ** MonoBehaviour Patterns** | Lifecycle methods, Awaitable async, FindFirstObjectByType, design patterns |
106132| ** ScriptableObjects** | Data-driven architecture with events, variables, and runtime sets |
@@ -123,12 +149,12 @@ Then ask the AI agent to scaffold a MonoBehaviour, look up an API, or generate a
123149## Rules (8)
124150
125151| Rule | What it enforces |
126- | ------ | -----------------|
152+ | : -----| : -----------------|
127153| ** C# Unity Conventions** | SerializeField, Awaitable over coroutines, modern API usage |
128154| ** MonoBehaviour Lifecycle** | Correct initialization order, Update vs FixedUpdate usage |
129155| ** Performance Rules** | No FindObjectOfType, no Resources.Load, allocation warnings |
130156| ** Naming Conventions** | PascalCase methods, _ camelCase privates, Unity-standard naming |
131- | ** Serialization Rules** | Proper [ SerializeField] , [ field: SerializeField] for events |
157+ | ** Serialization Rules** | Proper ` [SerializeField] ` , ` [field: SerializeField] ` for events |
132158| ** Shader Conventions** | HLSLPROGRAM over CGPROGRAM, URP-first shader patterns |
133159| ** Visual Scripting Conventions** | Graph naming, Subgraph usage, variable scoping |
134160| ** Security and Builds** | No credentials in code, IL2CPP stripping, signed packages |
@@ -138,51 +164,57 @@ Then ask the AI agent to scaffold a MonoBehaviour, look up an API, or generate a
138164<details >
139165<summary ><strong >C# (15)</strong ></summary >
140166
167+   ;
168+
141169| Snippet | Description |
142- | --------- | - ------------|
143- | monobehaviour-template.cs | Complete MonoBehaviour with lifecycle methods |
144- | singleton-pattern.cs | Thread-safe singleton using FindFirstObjectByType |
145- | object-pool.cs | Generic object pool with warm-up and auto-expand |
146- | scriptableobject-template.cs | ScriptableObject with custom editor support |
147- | coroutine-pattern.cs | Coroutine patterns with cancellation |
148- | async-await-pattern.cs | Awaitable async with single-await pooling rule |
149- | event-system.cs | C# event system with UnityEvent integration |
150- | state-machine.cs | Finite state machine pattern |
151- | custom-inspector.cs | Custom inspector with UI Toolkit |
152- | editor-window.cs | Editor window with UI Toolkit |
153- | property-drawer.cs | Custom property drawer |
154- | input-system-actions.cs | New Input System with Action Assets |
155- | raycast-patterns.cs | Physics.Raycast and NonAlloc patterns |
156- | interface-component.cs | Interface-based component communication |
157- | save-load-json.cs | JSON save/load with Application.persistentDataPath |
170+ | : --------| : ------------|
171+ | ` monobehaviour-template.cs ` | Complete MonoBehaviour with lifecycle methods |
172+ | ` singleton-pattern.cs ` | Thread-safe singleton using FindFirstObjectByType |
173+ | ` object-pool.cs ` | Generic object pool with warm-up and auto-expand |
174+ | ` scriptableobject-template.cs ` | ScriptableObject with custom editor support |
175+ | ` coroutine-pattern.cs ` | Coroutine patterns with cancellation |
176+ | ` async-await-pattern.cs ` | Awaitable async with single-await pooling rule |
177+ | ` event-system.cs ` | C# event system with UnityEvent integration |
178+ | ` state-machine.cs ` | Finite state machine pattern |
179+ | ` custom-inspector.cs ` | Custom inspector with UI Toolkit |
180+ | ` editor-window.cs ` | Editor window with UI Toolkit |
181+ | ` property-drawer.cs ` | Custom property drawer |
182+ | ` input-system-actions.cs ` | New Input System with Action Assets |
183+ | ` raycast-patterns.cs ` | Physics.Raycast and NonAlloc patterns |
184+ | ` interface-component.cs ` | Interface-based component communication |
185+ | ` save-load-json.cs ` | JSON save/load with Application.persistentDataPath |
158186
159187</details >
160188
161189<details >
162190<summary ><strong >Shaders (4)</strong ></summary >
163191
192+   ;
193+
164194| Snippet | Description |
165- | --------- | - ------------|
166- | unlit-basic.shader | Basic unlit shader for URP (HLSLPROGRAM) |
167- | urp-lit-template.shader | PBR lit shader template for URP |
168- | hlsl-vertex-fragment.shader | Custom vertex/fragment with URP lighting |
169- | surface-basic.shader | Legacy surface shader (Built-in only) |
195+ | : --------| : ------------|
196+ | ` unlit-basic.shader ` | Basic unlit shader for URP (HLSLPROGRAM) |
197+ | ` urp-lit-template.shader ` | PBR lit shader template for URP |
198+ | ` hlsl-vertex-fragment.shader ` | Custom vertex/fragment with URP lighting |
199+ | ` surface-basic.shader ` | Legacy surface shader (Built-in only) |
170200
171201</details >
172202
173203<details >
174204<summary ><strong >Visual Scripting (1)</strong ></summary >
175205
206+   ;
207+
176208| File | Description |
177- | ------ | - ------------|
178- | README.md | Graph architecture patterns and Subgraph conventions |
209+ | : -----| : ------------|
210+ | ` README.md ` | Graph architecture patterns and Subgraph conventions |
179211
180212</details >
181213
182214## Templates (5)
183215
184216| Template | Description |
185- | ---------- | - ------------|
217+ | : ---------| : ------------|
186218| ** 2D Platformer** | Player controller with new Input System, camera follow, game manager |
187219| ** 3D FPS** | First-person controller, weapon system, game manager |
188220| ** UI Menu System** | UI Toolkit menus with settings persistence |
@@ -205,16 +237,21 @@ The server starts automatically when Cursor invokes an MCP tool.
205237<details >
206238<summary ><strong >Available Tools (4)</strong ></summary >
207239
240+   ;
241+
208242| Tool | Description |
209- | ------ | - ------------|
210- | ** scaffold_script** | Generate C# scripts following Unity 6 conventions. Supports MonoBehaviour, ScriptableObject, Editor, and ECS templates. |
211- | ** lookup_api** | Search the Unity API reference database by name, namespace, or category. Returns signatures, descriptions, and examples. |
212- | ** shader_helper** | Get shader code patterns for common effects (dissolve, outline, hologram, etc.) with HLSL and Shader Graph guidance. |
213- | ** platform_info** | Get platform-specific defines, capabilities, limitations, and build recommendations. |
243+ | : -----| : ------------|
244+ | ` scaffold_script ` | Generate C# scripts following Unity 6 conventions. Supports MonoBehaviour, ScriptableObject, Editor, and ECS templates. |
245+ | ` lookup_api ` | Search the Unity API reference database by name, namespace, or category. Returns signatures, descriptions, and examples. |
246+ | ` shader_helper ` | Get shader code patterns for common effects (dissolve, outline, hologram, etc.) with HLSL and Shader Graph guidance. |
247+ | ` platform_info ` | Get platform-specific defines, capabilities, limitations, and build recommendations. |
214248
215249</details >
216250
217- ** Usage Examples**
251+ <details >
252+ <summary ><strong >Usage Examples</strong ></summary >
253+
254+   ;
218255
219256** Scaffold a script:**
220257```
@@ -236,6 +273,8 @@ Show me a dissolve effect shader for URP with edge glow
236273What are the WebGL limitations and recommended settings?
237274```
238275
276+ </details >
277+
239278## Project Structure
240279
241280```
@@ -248,6 +287,7 @@ Unity-Developer-Tools/
248287 templates/ Starter project templates (5 sets)
249288 mcp-server/ Python MCP server (4 tools) and data files
250289 docs/ Architecture, roadmap, contributing guide
290+ assets/ Logo and images
251291 .github/ CI/CD workflows (5 workflows)
252292```
253293
@@ -258,8 +298,10 @@ See [docs/ROADMAP.md](docs/ROADMAP.md) for the full project roadmap.
258298<details >
259299<summary ><strong >Release Plan</strong ></summary >
260300
301+   ;
302+
261303| Version | Milestone | Status |
262- | --------- | ----------- | - -------|
304+ | : --------| : ----------| : -------|
263305| ** v0.1.0** | Foundation -- skills, rules, snippets, templates, MCP server, CI/CD | Done |
264306| ** v1.0.0** | M1 Complete -- 18 skills, 8 rules, 20 snippets, 5 templates, 4 MCP tools | Done |
265307| ** v1.1.0** | CI/CD overhaul -- 8-job validation, zip releases, auto-labeling, data refresh | Done |
@@ -275,7 +317,7 @@ See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for guidelines on adding skills
275317
276318## Support
277319
278- If this plugin is useful to you, consider starring the repository or [ sponsoring the project] ( https://github.com/sponsors/TMHSDigital ) .
320+ If this plugin is useful to you, consider [ sponsoring the project] ( https://github.com/sponsors/TMHSDigital ) .
279321
280322## License
281323
@@ -284,6 +326,8 @@ CC BY-NC-ND 4.0 -- see [LICENSE](LICENSE) for details.
284326<details >
285327<summary ><strong >Unity Reference Links</strong ></summary >
286328
329+   ;
330+
287331- [ Unity Manual] ( https://docs.unity3d.com/Manual/ )
288332- [ Unity Scripting API] ( https://docs.unity3d.com/ScriptReference/ )
289333- [ Unity Package Manager] ( https://docs.unity3d.com/Manual/Packages.html )
@@ -294,4 +338,6 @@ CC BY-NC-ND 4.0 -- see [LICENSE](LICENSE) for details.
294338
295339---
296340
297- ** Built by [ TMHSDigital] ( https://github.com/TMHSDigital ) **
341+ <p align =" center " >
342+ <strong >Built by <a href =" https://github.com/TMHSDigital " >TMHSDigital</a ></strong >
343+ </p >
0 commit comments