/unity-project-template

Unity Best Practices for Project Structure and C# Coding Standards. It is a recommended starting point for new projects.

Primary LanguageC#

Unity Project Template

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

Best Practices

Getting Started

  1. Download this repo (*.zip or *.git)
  2. Download the Unity Editor
  3. Open this repo in the Unity Editor
  4. 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

Structure

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

Dependencies

More

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

Created By

  • Samuel Asher Rivello
  • Over 23 years XP with game development (2023)
  • Over 10 years XP with Unity (2023)

Contact