Awesome

Unity Project Template (WebGPU)

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

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

Related Repos

Table of Contents

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

Videos

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

Overview

Features

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

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 <a href="./Unity/Assets/Scripts/Runtime/RMC/Templates">./Unity/.../Templates/</a> 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 - <a href="https://twitter.com/srivello/">@srivello</a>
• Git - <a href="https://github.com/SamuelAsherRivello/">Github.com/SamuelAsherRivello</a>
• Resume & Portfolio - <a href="http://www.SamuelAsherRivello.com">SamuelAsherRivello.com</a>
• LinkedIn - <a href="https://Linkedin.com/in/SamuelAsherRivello">Linkedin.com/in/SamuelAsherRivello</a> <--- Say Hello! :)

License

Provided as-is under <a href="./LICENSE">MIT License</a> | Copyright ™ & © 2006 - 2024 Rivello Multimedia Consulting, LLC