README.md

anvil-unity-dots

An opinionated collection of systems and utilities that add Unity DOTS specific implementations on top of Anvil.

Refer to anvil-csharp-core and anvil-unity-core for a description of Anvil's purpose, the team's motivations, and the features provided to traditional Unity development.

Expectations

See: anvil-csharp-core

The code is reasonably clean but documentation and examples are sparse. Feel free to reach out on Twitter or open issues with questions.

⚠️ We welcome PRs and bug reports but making this repo a public success is not our priority. No promises on when it will be addressed!

Dependencies

• Unity 2022.3.15+
• anvil-csharp-core (main...usually 😬)
• anvil-unity-core (main...usually 😬)
• DOTS Packages
  • com.unity.entities (1.0.16)
  • com.unity.entities.graphics (1.0.16)
  • com.unity.burst (1.8.11)
  • com.unity.collections (2.1.4)
  • com.unity.mathematics (1.2.6)

At this point in time, all DOTS related functionality is in this one repository. In the future, we may split the functionality into specialized repositories. Maintaining a repository per Unity DOTS package seems overly tedious at the moment.

Features

• TODO: #1

Project Setup

1. Add dependencies as submodules or Unity Packages to your project
2. Make use of features as desired.
3. Done!

This is the recommended Unity project folder structure:

• Assets
  • Anvil
    • csharp
      • anvil-csharp-core
    • unity
      • anvil-unity-core
      • anvil-unity-dots

Known Issues

• #24 Systems Editor Panel throws exceptions - Waiting on a fix from Unity