Skip to content

pat-mw/EntityComponentSystemSamples

 
 

Repository files navigation

Welcome

Welcome to the DOTS Samples repository! Here you can find the resources required to start building with these new systems today. We have also provided a forum where you can find more information and share your experiences with these new systems.

Click here to visit the forum

What is the Unity Data Oriented Tech Stack?

We have been working on a new high performance multithreaded system, that will make it possible for games to fully utilise the multicore processors available today without heavy programming headache. The Data Oriented Tech Stack includes the following major systems:

  • The Entity Component System provides a way to write performant code by default.
  • The C# Job System provides a way to run your game code in parallel on multiple CPU cores
  • The Burst compiler a new math-aware, backend compiler tuned to produce highly optimized machine code.

With these systems, Unity can produce highly optimised code for the particular capabilities of the platform you’re compiling for.

For more information about the Unity DOTS initiative, see Performance by Default on the Unity website.

Entity Component System

The Entity Component System offers a better approach to game design that allows you to concentrate on the actual problems you are solving: the data and behavior that make up your game. It leverages the C# Job System and Burst Compiler enabling you to take full advantage of today's multicore processors. Moving from object-oriented to data-oriented design makes it easier for you to reuse the code and easier for others to understand and work on it.

The Entity Component System ships as an experimental package that currently supports Unity 2018.3 and later. It is important to stress that the Entity Component System is not production ready.

C# Job System

The new C# Job System takes advantage of multiple cores in a safe and easy way. Easy, as it’s designed to open this approach up to user scripts and allows you to write safe, fast, jobified code while providing protection from some of the pitfalls of multi-threading such as race conditions.

The C# Job System is a built-in module included in Unity 2018.1+.

Burst

Burst is a new LLVM-based, math-aware backend compiler. It compiles C# jobs into highly-optimized machine code that takes advantage of the particular capabilities of the platform you’re compiling for. Burst is an experimental package that currently supports Unity 2018.4 and later.

Watch Joachim Ante present these systems at Unite Austin

Installation guide for new projects

  1. Create or open a project with the Unity Editor (2020.1.9f1 or later to use the latest DOTS packages).
  2. Open the Package Manager (menu: Window > Package Manager).
  3. Click the small gear icon on the upper right and select the Advanced Project Settings menu item.
  4. Check Enable Preview Packages in the Project Settings window.
  5. In the Package Manager window, click the small + icon in the upper left and select Add package from git URL...
  6. Find the version of the DOTS packages you want to use, i.e. check https://docs.unity3d.com/Packages/com.unity.rendering.hybrid@latest
  7. Enter the package followed by the version number, e.g. [email protected] and confirm.

This will add the Hybrid Renderer package and all its dependencies, e.g. Entities, Burst, Collections, Jobs and Mathematics. Now you can start to use DOTS in you project.

Note: You can use the Unity Hub to install multiple versions of Unity on the same computer.

ECS Samples

The ECSSamples project contains samples to help you get started with DOTS. The project release notes contain a summary of changes.

Physics Samples

Unity Physics is a deterministic, rigid-body dynamics system and spatial query system written from the ground up using the Unity data oriented tech stack. You can find an overview of the samples and the release notes in this repository.

Hybrid HDRP Samples

The HybridHDRPSamples contains feature sample Scenes, stress test Scenes for the HDRP Hybrid Renderer. You can find the overview and the release notes in this repository.

Hybrid URP Samples

The HybridURPSamples contains feature sample Scenes, stress test Scenes for the URP Hybrid Renderer. You can find the overview and the release notes in this repository.

Documentation

Looking for information on how to get started or have specific questions? Visit our ECS & Job system documentation.

Note that from the Unity Editor, you can access the documentation for any package from the Package Manager window.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 88.1%
  • HLSL 7.7%
  • ShaderLab 4.2%