Skip to content

Commit c0ff81d

Browse files
Add Probuilder
1 parent b628bef commit c0ff81d

40 files changed

+6622
-386
lines changed

README.md

+41-82
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,62 @@
11
# Unity Project Template
22

3+
<img width="600" src="./Unity/Assets/Documentation/Images/BestPractices.png" alt="Best Practices">
4+
5+
<BR>
6+
37
This repo represents the ideal starting point for new Unity projects.
48

59
The project includes best practices for **project structure** and **C# coding standards**.
610

711
<BR>
812

9-
**Getting Started**
13+
**Getting Started: Steps**
1014
1. Download this repo (*.zip or *.git)
1115
1. Download the [Unity Editor](https://store.unity.com/#plans-individual)
1216
1. Open this repo in the Unity Editor
1317
1. Enjoy
1418

1519
<BR>
1620

17-
<img width="600" src="./Unity/Assets/Documentation/Images/BestPractices.png" alt="Best Practices">
21+
**Getting Started: Video**
1822

23+
<a href="https://www.youtube.com/playlist?list=PL5domiITryHhlCKPSpiGuUt_kQg0nk3Of"><img width="600" src="https://i3.ytimg.com/vi/pXzLXNEW3bk/maxresdefault.jpg" /></a>
1924

2025
<BR>
2126

22-
## Comparison
27+
## Table of Contents
28+
29+
1. [About](#about)
30+
1. [Overview](#overview)
31+
1. [Best Practices](#best-practices)
32+
* [Project Structure](#project-structure)
33+
* [Coding Standards](#coding-standards)
34+
1. [Resources](#resources)
35+
1. [Credits](#credits)
36+
37+
38+
39+
<BR>
40+
41+
## About
2342

2443
### Template Basics
2544

2645
This template contains the following:
2746

28-
| Name | Description |
29-
|-------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|
30-
| [Cinemachine](https://docs.unity3d.com/Packages/com.unity.cinemachine@latest) | Advanced camera control for dynamic, in-game cinematography and cutscenes. |
31-
| [Universal Render Pipeline (URP)](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@latest) | A scalable rendering solution optimized for performance and visual quality. |
32-
| [ProBuilder](https://docs.unity3d.com/Packages/com.unity.probuilder@latest) | 3D modeling and level design directly within the Unity Editor. |
33-
| [Post-Processing Stack](https://docs.unity3d.com/Packages/com.unity.postprocessing@latest) | Advanced visual effects like color grading, bloom, and ambient occlusion. |
34-
| [Physics (2D and 3D)](https://docs.unity3d.com/Manual/PhysicsSection.html) | Realistic collision detection and response, rigidbody dynamics, and joints. |
35-
| [Best Practices](https://www.samuelasherrivello.com/best-practices) | Proven approaches for Unity project structure, asset organization, and workflow. |
36-
| [Coding Standards](https://www.samuelasherrivello.com/best-practices) | Naming conventions, file organization, and formatting for Unity C# development. |
37-
| [Unit Testing](https://docs.unity3d.com/Packages/com.unity.test-framework@latest) | Verify the correctness of code with automated tests, ensuring stability and quality. |
38-
| [Code Coverage](https://docs.unity3d.com/Packages/com.unity.test-framework.codecoverage@latest) | Measure the percentage of code executed during testing to identify untested areas. |
39-
| [Text Mesh Pro](https://docs.unity3d.com/Packages/com.unity.textmeshpro@latest) | Advanced text rendering and formatting options for high-quality text in Unity. |
47+
| Name | Description |
48+
|-------------------------------------------------------------------------------------------------|-----------------------------------------------------------|
49+
| [Assembly Definitions](https://docs.unity3d.com/Manual/ScriptCompilationAssemblyDefinitionFiles.html) | Organize and optimize script compilation. |
50+
| [Best Practices: Coding Standards](https://www.samuelasherrivello.com/best-practices) | Guidelines for consistent code style and format. |
51+
| [Best Practices: Project Structure](https://www.samuelasherrivello.com/best-practices) | Recommended project structure and organization. |
52+
| [Cinemachine](https://docs.unity3d.com/Packages/com.unity.cinemachine@latest) | Advanced camera system for dynamic shots. |
53+
| [Physics](https://docs.unity3d.com/Manual/PhysicsSection.html) | Physics simulation for 2D and 3D games. |
54+
| [ProBuilder](https://docs.unity3d.com/Packages/com.unity.probuilder@latest) | 3D modeling and level design toolset. |
55+
| [Rendering: Post-Processing](https://docs.unity3d.com/Packages/com.unity.postprocessing@latest) | Visual effects like color grading and bloom. |
56+
| [Rendering: URP](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@latest) | Efficient rendering pipeline for various platforms. |
57+
| [Text Mesh Pro](https://docs.unity3d.com/Packages/com.unity.textmeshpro@latest) | High-quality text rendering and formatting. |
58+
| [Unit Testing](https://docs.unity3d.com/Packages/com.unity.test-framework@latest) | Automated tests to verify code stability. |
59+
| [Unit Testing: Code Coverage](https://docs.unity3d.com/Packages/com.unity.test-framework.codecoverage@latest) | Measure code tested during unit testing. |
4060

4161
### More Templates
4262

@@ -54,75 +74,17 @@ If you want these template basics **plus** additional features, check out the fo
5474

5575

5676

57-
58-
59-
<BR>
60-
61-
<BR>
62-
63-
---
64-
65-
<BR>
66-
67-
## Table of Contents
68-
69-
1. [Videos](#videos)
70-
2. [Overview](#features)
71-
3. [Best Practices](#best-practices)
72-
1. [Project Structure](#project-structure)
73-
2. [Coding Standards](#coding-standards)
74-
4. [Resources](#resources)
75-
5. [Credits](#credits)
76-
7777
<BR>
78-
79-
---
80-
8178
<BR>
8279

83-
## Videos
84-
85-
This **Unity Project** is featured in the following YouTube video playlist.
86-
87-
<table>
88-
<tr>
89-
<th>Unity Game Dev - In 3 Mins</th>
90-
</tr>
91-
<tr>
92-
<td>
93-
<a href="https://www.youtube.com/playlist?list=PL5domiITryHhlCKPSpiGuUt_kQg0nk3Of"><img width="500" src="https://i3.ytimg.com/vi/pXzLXNEW3bk/maxresdefault.jpg" /></a>
94-
</td>
95-
</tr>
96-
</table>
97-
98-
<BR>
99-
100-
---
101-
102-
<BR>
10380

10481
## Overview
10582

10683
### Features
10784

10885
This project is a living template. It showcases the best practices and coding standards for many common workflows.
10986

110-
<img width = "400" src="./Unity/Assets/Documentation/Images/Screenshot.png" />
111-
112-
**Scope Includes:**
113-
* Git Repo - Structure, .gitignore, ReadMe.md
114-
* Scene Hierarchy Window - Structure
115-
* Project Window - Structure
116-
* Inspector Window - `ReadMe.asset`
117-
* Scripting - Runtime
118-
* Scripting - Editor
119-
* Unit Testing - Runtime
120-
* Unit Testing - Editor
121-
* UI Toolkit
122-
* Universal Render Pipeline (URP)
123-
* Post Processing
124-
* Anti-Aliasing
125-
87+
<img width = "600" src="./Unity/Assets/Documentation/Images/Screenshot.png" />
12688

12789
### Structure
12890

@@ -144,9 +106,6 @@ This project is a living template. It showcases the best practices and coding st
144106
* `Various` - Already included via [Unity Package Manager](https://docs.unity3d.com/Manual/upm-ui.html) as this [Version](./Unity/Packages/manifest.json)
145107

146108
<BR>
147-
148-
---
149-
150109
<BR>
151110

152111
## Best Practices
@@ -155,7 +114,7 @@ This project is a living template. It showcases the best practices and coding st
155114

156115
Employing an organized project structure is beneficial to your project and your team.
157116

158-
See the [./Unity/Assets/](./Unity/Assets/) folder for more info.
117+
See the <a href="./Unity/Assets/">Unity/Assets/</a> folder for more info.
159118

160119
Scope Includes:
161120
* Folder Structure
@@ -172,7 +131,7 @@ Benefits:
172131

173132
Coding standards define a programming style.
174133

175-
See the <a href="./Unity/Assets/Scripts/Runtime/RMC/Templates">./Unity/.../Templates/</a> folder for more info.
134+
See the <a href="./Unity/Assets/Scripts/Runtime/RMC/Templates">Unity/.../Templates/</a> folder for more info.
176135

177136
Employing organized coding standards is beneficial to your project and your team.
178137

@@ -195,6 +154,9 @@ Benefits:
195154
* Minimizes Performance Pitfalls
196155
* Saves Money Due to Less Man Hours
197156

157+
<BR>
158+
<BR>
159+
198160
## Resources
199161

200162
Here are more articles from Samuel Asher Rivello.
@@ -210,9 +172,6 @@ Here are more articles from Samuel Asher Rivello.
210172
* [Best Practices — 5 — Unit Testing For Unity](https://samuel-asher-rivello.medium.com/unity-testing-for-unity-elevating-your-game-development-skills-eb76fc0bbea3)
211173

212174
<BR>
213-
214-
---
215-
216175
<BR>
217176

218177
## Credits

Unity/Assets/Art/Materials/PlayerMaterial.mat

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Material:
1414
m_ValidKeywords:
1515
- _EMISSION
1616
m_InvalidKeywords: []
17-
m_LightmapFlags: 2
17+
m_LightmapFlags: 1
1818
m_EnableInstancingVariants: 0
1919
m_DoubleSidedGI: 0
2020
m_CustomRenderQueue: -1
@@ -114,9 +114,9 @@ Material:
114114
- _WorkflowMode: 1
115115
- _ZWrite: 1
116116
m_Colors:
117-
- _BaseColor: {r: 1, g: 0.8513514, b: 0, a: 1}
118-
- _Color: {r: 1, g: 0.8513514, b: 0, a: 1}
119-
- _EmissionColor: {r: 8, g: 5.73822, b: 0, a: 1}
117+
- _BaseColor: {r: 1, g: 0.41822243, b: 0, a: 1}
118+
- _Color: {r: 1, g: 0.41822243, b: 0, a: 1}
119+
- _EmissionColor: {r: 8, g: 1.1762184, b: 0, a: 1}
120120
- _SpecColor: {r: 0.2, g: 0.2, b: 0.2, a: 1}
121121
m_BuildTextureStacks: []
122122
--- !u!114 &4656055993927858532

Unity/Assets/Art/Textures.meta

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Loading

Unity/Assets/Documentation/ReadMe.asset

+9
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,13 @@ MonoBehaviour:
5151
PingObjectGuid: 5a22eb9ce84e5194ca5658315e96758d
5252
MenuItemName:
5353
MenuItemPath:
54+
- TextHeading: Customize ReadMe
55+
TextSubheading:
56+
TextBody: Open this Unity Inspector Window as 'Debug' to edit.
57+
LinkName:
58+
LinkUrl:
59+
PingObjectName:
60+
PingObjectGuid:
61+
MenuItemName:
62+
MenuItemPath:
5463
HasLoadedLayout: 0

Unity/Assets/Documentation/ReadMe/Scripts/Editor/ReadMeMenuItems.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ public static class ReadMeMenuItems
88
// Fields ----------------------------------------
99
public const string PathMenuItemWindowCompanyProject = "Window/" + CompanyName + "/" + ProjectName;
1010
public const string CompanyName = "RMC";
11-
public const string ProjectName = "My Project";
12-
public const int PriorityMenuItem_Examples = 1;
11+
public const string ProjectName = "[MyProject]";
12+
public const int PriorityMenuItem_Examples = -1000;
1313

1414
// Fields ----------------------------------------
1515

0 commit comments

Comments
 (0)