Unity Project Template

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: Steps

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

Getting Started: Video

Table of Contents

1. About
2. Overview
3. Best Practices
   • Project Structure
   • Coding Standards
4. Resources
5. Credits

About

Template Basics

This template contains the following:

Name	Description
Assembly Definitions	Organize and optimize script compilation.
Best Practices: Coding Standards	Guidelines for consistent code style and format.
Best Practices: Project Structure	Recommended project structure and organization.
Cinemachine	Advanced camera system for dynamic shots.
Physics	Physics simulation for 2D and 3D games.
ProBuilder	3D modeling and level design toolset.
Rendering: Post-Processing	Visual effects like color grading and bloom.
Rendering: URP	Efficient rendering pipeline for various platforms.
Text Mesh Pro	High-quality text rendering and formatting.
Unit Testing	Automated tests to verify code stability.
Unit Testing: Code Coverage	Measure code tested during unit testing.

More Templates

If you want these template basics plus additional features, check out the following:

Repository	Template Basics	AR	VR	Multiplayer	WebGPU	DOTS
unity-project-template	✅	❌	❌	❌	❌	❌
unity-project-template-ar	✅	✅	❌	❌	❌	❌
unity-project-template-vr	✅	❌	✅	❌	❌	❌
unity-project-template-coherence-multiplayer	✅	❌	❌	✅	❌	❌
unity-multiplayer-ngo-2d-playground	✅	❌	❌	✅	❌	❌
unity-project-template-webgpu	✅	❌	❌	❌	✅	❌
rmc-dots-examples	✅	❌	❌	❌	❌	✅

Overview

Features

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

Structure

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 - Universal Render Pipeline (URP)
• 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

Best Practices

Project Structure

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

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

Resources

Here are more articles from Samuel Asher Rivello.

Portfolio

• SamuelAsherRivello.com/best-practices

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

Credits

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 © 2024 Rivello Multimedia Consulting, LLC