https://github.com/samuelasherrivello/unity-best-practices
Unity Best Practices for C#; Design principles, design patterns, coding challenges, and more!
https://github.com/samuelasherrivello/unity-best-practices
best-practices design-patterns design-patterns-csharp design-principles unity
Last synced: 5 months ago
JSON representation
Unity Best Practices for C#; Design principles, design patterns, coding challenges, and more!
- Host: GitHub
- URL: https://github.com/samuelasherrivello/unity-best-practices
- Owner: SamuelAsherRivello
- Created: 2021-02-10T16:50:12.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T19:26:35.000Z (about 1 year ago)
- Last Synced: 2025-04-01T18:50:24.324Z (10 months ago)
- Topics: best-practices, design-patterns, design-patterns-csharp, design-principles, unity
- Language: C#
- Homepage: https://www.SamuelAsherRivello.com/best-practices
- Size: 22.9 MB
- Stars: 41
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Unity Best Practices
Design principles, design patterns, coding challenges, and more!
**Details**
Here is a complete overview of **Best Practices** and related topics for Unity.
The repo is complete with code samples.
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. | ✅ | ❌ | (See below) |
| Unity Project Template | Template showcasing best practices and coding standards for Unity projects. | ❌ | ✅ | [link](https://github.com/SamuelAsherRivello/unity-project-template/) |
## Table of Contents
1. [Configuration](#configuration)
1. [Design Principles](#design-principles)
1. [Design Patterns](#design-patterns)
1. [Features](#features)
1. [Tooling](#tooling)
1. [Credits](#credits)
## Getting Started
### Instructions
1. Download this repo (*.zip or *.git)
1. Download the [Unity Editor](https://store.unity.com/#plans-individual) (See `Unity Version` below)
1. Open the Unity Hub
1. Unity Hub: Click the 'Add' button
1. Unity Hub: Choose the `Unity` folder from the repo
1. Unity Hub: Choose the project from the project list to open the Unity Editor
1. Unity Editor: Open one of the included Scenes
1. Unity Editor: Play the Scene
1. Enjoy!
## Configuration
**Documentation**
- `ReadMe.md` - The primary documentation for this repo
**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
**Dependencies**
- `Various` - Already included via [Unity Package Manager](https://docs.unity3d.com/Manual/upm-ui.html) as this [Version](./Unity/Packages/manifest.json)
## Design Principles
**Theory**
**S.O.L.I.D. Principles** make software designs more understandable, easier to maintain and easier to extend. As a software engineer, these 5 principles are essential to know! (See ITNext.io)
**List**
| Name | Description | Code Sample Complete |
| ------------------------- | ------------------------------------------------------------------------------------------- | -------------------- |
| **S**ingle Responsibility | One reason to change. | ✅ |
| **O**pen/Closed | Open for extension, closed for modification. | ✅ |
| **L**iskov Substitution | Subtypes must be substitutable for their base types. | ✅ |
| **I**nterface Segregation | No client should be forced to depend on interfaces they do not use. | ✅ |
| **D**ependency Inversion | High-level modules should not depend on low-level ones; both should depend on abstractions. | ✅ |
## Design Patterns
### Theory
These patterns provide solutions to common design problems and are a foundational part of software design knowledge. There are 3 types.
- **Behavioral Patterns** - Design patterns to deal with object-object communication. (See Wikipedia)
- **Creational Patterns** - Design patterns to deal with object creation. (See Wikipedia)
- **Structural Patterns** - Design patterns to deal with object-object relationships. (See Wikipedia)
### Diagram
### List
| Type | Name | Description | Code Sample Complete |
| ---------- | ----------------------- | ------------------------------------------------------------- | -------------------- |
| | | | |
| Behavioral | | | |
| | Chain of Responsibility | Passes request among a chain of objects. | ❌ |
| | Command | Encapsulates a request as an object. | ✅ |
| | Interpreter | Provides a language interpreter. | ❌ |
| | Iterator | Sequentially access elements in a collection. | ❌ |
| | Mediator | Centralized external communications. | ❌ |
| | Memento | Capture and restore object's internal state. | ✅ |
| | Observer | Notify changes to its state. | ❌ |
| | State | Alter behavior when its state changes. | ✅ |
| | Strategy | Encapsulates algorithms using strategy pattern. | ✅ |
| | Template Method | Defer exact steps to subclasses. | ❌ |
| | Visitor | Add new operations without altering a class. | ❌ |
| | | | |
| Creational | | | |
| | Abstract Factory | Creates families of related objects. | ❌ |
| | Builder | Separates object construction from its representation. | ✅ |
| | Factory Method | Creates objects without specifying the exact class to create. | ✅ |
| | Prototype | Clone or copy initialized instances. | ❌ |
| | Singleton | Ensures a class has one instance. | ✅ |
| | | | |
| Structural | | | |
| | Adapter | Matches interfaces of different classes. | ❌ |
| | Bridge | Separates an object’s interface from its implementation. | ❌ |
| | Composite | Tree structure of simple and composite objects. | ❌ |
| | Decorator | Adds responsibilities to objects dynamically. | ✅ |
| | Facade | Simplified interface to a subsystem. | ✅ |
| | Flyweight | Reuses objects by sharing common state. | ✅ |
| | Proxy | Represents another object. | ❌ |
## Features
- **Editor Scripting** - Unity lets you extend the editor with your own custom inspectors and Editor Windows and you can define how properties are displayed in the inspector with custom Property Drawers. See Unity Docs for more.
## Tooling
- **Unit Testing** - Software testing where individual units/ components of a software are tested. The purpose is to validate that each unit of the software performs as designed. A unit is the smallest testable part of any software. See Unity Docs for more.
## 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 ™ & © 2006 - 2024 Rivello Multimedia Consulting, LLC