This repo represents the ideal starting point for new Unity projects.
The project includes best practices for project structure and C# coding standards.
Getting Started
- Download this repo (*.zip or *.git)
- Download the Unity Editor
- Open this repo in the Unity Editor
- Enjoy
Related Repos
Name | Description | Educational Use | Production Use | Link |
---|---|---|---|---|
Unity Best Practices | Repo with best practices for Unity. It covers project structure and code standards. | ✅ | ❌ | link |
Unity Project Template | Template showcasing best practices and coding standards for Unity projects. | ❌ | ✅ | (See below) |
This Unity Project is featured in the following YouTube video playlist.
Unity Game Dev - In 3 Mins |
---|
|
This project is a living template. It showcases the best practices and coding standards for many common workflows.
Scope Includes:
- Git Repo - Structure, .gitignore, ReadMe.md
- Scene Hierarchy Window - Structure
- Project Window - Structure
- Inspector Window -
ReadMe.asset
- Scripting - Runtime
- Scripting - Editor
- Unit Testing - Runtime
- Unit Testing - Editor
- UI Toolkit
- Universal Render Pipeline (URP)
- Post Processing
- Anti-Aliasing
Documentation
ReadMe.md
- The primary documentation for this repoUnity/Assets/Documentation/ReadMe.asset
- Select this asset in Unity to get started
Configuration
Unity Target
- Standalone MAC/PCUnity Version
- Use this VersionUnity Rendering
- Universal Render Pipeline (URP)Unity Aspect Ratio
- Game View 10x16
Structure
Unity/
- Open this folder in the Unity EditorUnity/Assets/Scenes/
- Open any Scene. Press 'Play'!
Dependencies
Various
- Already included via Unity Package Manager as this Version
Employing an organized project structure is beneficial to your project and your team.
See the ./Unity/Assets/ folder for more info.
Scope Includes:
- Folder Structure
- Folder Naming
- File Naming
Benefits:
- Consistency — The project structure has consistency in presentation regardless of team location, spoken language, or individual programmers.
- Maintenance — Consistent project structure will aid readability. Readability helps new and existing programmers revisit the code base for fixes and improvements.
- Communication — Developers more implicitly understand each other in written and verbal communication.
Coding standards define a programming style.
See the ./Unity/.../Templates/ folder for more info.
Employing organized coding standards is beneficial to your project and your team.
Scope Includes:
- Naming Conventions
- File Naming and Organization
- Formatting and Indentation
- Comments and Documentation
- Classes, Functions and Interfaces
- Testing
Benefits:
- Code Integration
- Team Member Integration
- Maintenance
- Uniform Problem Solving
- Minimizes Communication
- Minimizes Performance Pitfalls
- Saves Money Due to Less Man Hours
Here are more articles from Samuel Asher Rivello.
Portfolio
Medium
- Best Practices — 1 — Unity Project Structure
- Best Practices — 2 — Unity C# Coding Standards
- Best Practices — 3 — Unity Overview
- Best Practices — 4 — MVC Architecture For Unity
- Best Practices — 5 — Unit Testing For Unity
Created By
- Samuel Asher Rivello
- Over 25 years XP with game development (2024)
- Over 11 years XP with Unity (2024)
Contact
- Twitter - @srivello
- Git - Github.com/SamuelAsherRivello
- Resume & Portfolio - SamuelAsherRivello.com
- LinkedIn - Linkedin.com/in/SamuelAsherRivello <--- Say Hello! :)
License
Provided as-is under MIT License | Copyright ™ & © 2006 - 2024 Rivello Multimedia Consulting, LLC