Skip to content

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

License

Notifications You must be signed in to change notification settings

SamuelAsherRivello/unity-project-template-vfx-shaders

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Unity Project Template (ShaderGraph / VFXGraph)

Best Practices


This repo represents the ideal starting point for new Unity projects.

The project includes best practices for project structure and C# coding standards as well as packages for ShaderGraph and VFXGraph.

Rendering Topics

In addition to all the template basics, this repo also includes:

Name Description
Rendering: URP Efficient rendering pipeline for various platforms.
Rendering: Post-Processing Visual effects like color grading and bloom.
Rendering: Shader Graph Node-based shader development.
Rendering: VFX Graph Node-based visual effects development.

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. Resources
  4. 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

Structure

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

Dependencies



Resources

Here are more articles from Samuel Asher Rivello.

Portfolio

Medium: Rendering

Medium: Best Practices

Unity Rendering - 1 - Overview Unity Rendering - 2 - URP Pipeline Unity Rendering - 3 - RenderGraph Unity Rendering - 4 - ShaderGraph Unity Rendering - 5 - VFXGraph Unity Rendering - 6 - Optimization



Credits

Created By

  • Samuel Asher Rivello
  • Over 25 years XP with game development (2024)
  • Over 11 years XP with Unity (2024)

Contact

License

Provided as-is under MIT License | Copyright ™ & © 2006 - 2024 Rivello Multimedia Consulting, LLC

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages