Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/samuelasherrivello/unity-project-template

This repo represents the ideal starting point for new OOP Unity projects. It includes best practices for project structure and C# coding standards.
https://github.com/samuelasherrivello/unity-project-template

best-practices coding-standards design-patterns unity unity3d

Last synced: 5 days ago
JSON representation

This repo represents the ideal starting point for new OOP Unity projects. It includes best practices for project structure and C# coding standards.

Host: GitHub
URL: https://github.com/samuelasherrivello/unity-project-template
Owner: SamuelAsherRivello
License: mit
Created: 2021-02-09T21:46:03.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-11-13T18:46:13.000Z (about 2 months ago)
Last Synced: 2024-12-23T10:32:21.418Z (12 days ago)
Topics: best-practices, coding-standards, design-patterns, unity, unity3d
Language: C#
Homepage: http://SamuelAsherRivello.com
Size: 4.17 MB
Stars: 97
Watchers: 3
Forks: 26
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # 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)

1. Download the [Unity Editor](https://store.unity.com/#plans-individual)

1. Open this repo in the Unity Editor

1. Enjoy







**Getting Started: Video**









## Table of Contents

1. [About](#about)

1. [Overview](#overview)

1. [Best Practices](#best-practices)

    * [Project Structure](#project-structure)

    * [Coding Standards](#coding-standards)

1. [Resources](#resources)

1. [Credits](#credits)







## About

### Template Basics

This template contains the following:

| Name                                                                                             | Description                                               |

|-------------------------------------------------------------------------------------------------|-----------------------------------------------------------|

| [Assembly Definitions](https://docs.unity3d.com/Manual/ScriptCompilationAssemblyDefinitionFiles.html) | Organize and optimize script compilation.                 |

| [Best Practices: Coding Standards](https://www.samuelasherrivello.com/best-practices)            | Guidelines for consistent code style and format.          |

| [Best Practices: Project Structure](https://www.samuelasherrivello.com/best-practices)           | Recommended project structure and organization.           |

| [Cinemachine](https://docs.unity3d.com/Packages/com.unity.cinemachine@latest)                    | Advanced camera system for dynamic shots.                 |

| [Physics](https://docs.unity3d.com/Manual/PhysicsSection.html)                                   | Physics simulation for 2D and 3D games.                   |

| [ProBuilder](https://docs.unity3d.com/Packages/com.unity.probuilder@latest)                      | 3D modeling and level design toolset.                     |

| [Rendering: Post-Processing](https://docs.unity3d.com/Packages/com.unity.postprocessing@latest)  | Visual effects like color grading and bloom.              |

| [Rendering: URP](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@latest)  | Efficient rendering pipeline for various platforms.       |

| [Text Mesh Pro](https://docs.unity3d.com/Packages/com.unity.textmeshpro@latest)                  | High-quality text rendering and formatting.               |

| [Unit Testing](https://docs.unity3d.com/Packages/com.unity.test-framework@latest)                | Automated tests to verify code stability.                 |

| [Unit Testing: Code Coverage](https://docs.unity3d.com/Packages/com.unity.test-framework.codecoverage@latest) | 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](https://github.com/SamuelAsherRivello/unity-project-template)             | ✅              | ❌  | ❌  | ❌          | ❌     | ❌   |

| [unity-project-template-ar](https://github.com/SamuelAsherRivello/unity-project-template-ar)       | ✅              | ✅  | ❌  | ❌          | ❌     | ❌   |

| [unity-project-template-vr](https://github.com/SamuelAsherRivello/unity-project-template-vr)       | ✅              | ❌  | ✅  | ❌          | ❌     | ❌   |

| [unity-project-template-coherence-multiplayer](https://github.com/SamuelAsherRivello/unity-project-template-coherence-multiplayer) | ✅              | ❌  | ❌  | ✅          | ❌     | ❌   |

| [unity-multiplayer-ngo-2d-playground](https://github.com/SamuelAsherRivello/unity-multiplayer-ngo-2d-playground) | ✅              | ❌  | ❌  | ✅          | ❌     | ❌   |

| [unity-project-template-webgpu](https://github.com/SamuelAsherRivello/unity-project-template-webgpu) | ✅              | ❌  | ❌  | ❌          | ✅     | ❌   |

| [rmc-dots-examples](https://github.com/SamuelAsherRivello/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](https://support.unity.com/hc/en-us/articles/206336795-What-platforms-are-supported-by-Unity-)

* `Unity Version` - Use this [Version](./Unity/ProjectSettings/ProjectVersion.txt)

* `Unity Rendering` - [Universal Render Pipeline (URP)](https://docs.unity3d.com/Manual/universal-render-pipeline.html)

* `Unity Aspect Ratio` - [Game View 10x16](https://docs.unity3d.com/Manual/GameView.html)

**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](https://docs.unity3d.com/Manual/upm-ui.html) as this [Version](./Unity/Packages/manifest.json)







## 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](https://www.SamuelAsherRivello.com/best-practices)

**Medium**

* [Best Practices — 1 — Unity Project Structure](https://samuel-asher-rivello.medium.com/unity-project-structure-a694792cefed)

* [Best Practices — 2 — Unity C# Coding Standards](https://samuel-asher-rivello.medium.com/coding-standards-in-c-39aefee92db8)

* [Best Practices — 3 — Unity Overview](https://samuel-asher-rivello.medium.com/best-practices-3-unity-8abcce214ddc)

* [Best Practices — 4 — MVC Architecture For Unity](https://samuel-asher-rivello.medium.com/unleashing-the-power-of-mvc-architecture-in-unity-a-journey-of-structured-game-development-492ef9c53817)

* [Best Practices — 5 — Unit Testing For Unity](https://samuel-asher-rivello.medium.com/unity-testing-for-unity-elevating-your-game-development-skills-eb76fc0bbea3)







## Credits

**Created By**

- Samuel Asher Rivello

- Over 26 years XP with game development (2025)

- Over 12 years XP with Unity (2025)

**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 - 2025 Rivello Multimedia Consulting, LLC