Unity Project Template

This repo includes Project Structure Best Practices and C# Coding Standards for Unity.

Getting Started

Download this repo (*.zip or *.git)
Download the Unity Editor
Open this repo in the Unity Editor
Enjoy

Videos

This Unity Project is featured in the following YouTube video playlist.

Unity Game Dev - In 3 Mins

Features

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

Includes Templates For ...

Git Repo - Structure, .gitignore, ReadMe.md
Scene Hiearchy Window - Structure
Project Window - Structure
Inspector Window - ReadMe.asset
Runtime Coding
Editor Coding
Unit Testing

Overview

Documentation

ReadMe.md - The primary documentation for this repo
Unity/Assets/Documentation/ReadMe.asset - Select this asset in Unity to get started

Configuration

Unity Target - Standalone MAC/PC
Unity Version - Use this Version
Unity Rendering - Standard Render Pipeline (SRP)
Unity Aspect Ratio - Game View 10x16

Structure

Unity/ - Open this folder in the Unity Editor
Unity/Assets/Scenes/ - Open any Scene. Press 'Play'!

Dependencies

Various - Already included via Unity Package Manager as this Version

A. Unity — Project Structure Best Practices

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

Scope:

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.

B. Coding Standards

Coding standards define a programming style.

See the repo's C# Templates for more info.

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

Scope:

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

Resources

Samuel Asher Rivello's Medium Article - Unity — Project Structure Best Practices
Samuel Asher Rivello's Medium Article - Unity — C# Coding Standards

Created By

Samuel Asher Rivello
Over 24 years XP with game development (2024)
Over 11 years XP with Unity (2024)

Contact

Twitter - @srivello
Resume & Portfolio - SamuelAsherRivello.com
Git - Github.com/SamuelAsherRivello
LinkedIn - Linkedin.com/in/SamuelAsherRivello <--- Say Hello! :)

samuelasherrivello / unity-project-template Goto Github PK