Skip to content

README.md

Latest commit

 

History

History
53 lines (39 loc) · 2.01 KB

README.md

File metadata and controls

53 lines (39 loc) · 2.01 KB
Raw

GridForge for Unity Lean

The Lean Unity adapter package: the same scene-owned worlds, serialized grid authoring, blockers, diagnostics, logging, and Demo Scene without the MemoryPack runtime dependency chain.

Requires Unity 2022.3 or newer.

Documentation · Getting started · Changelog

Install

In Window → Package Manager, choose + → Install package from git URL…:

https://github.com/mrdav30/GridForge-Unity.git?path=/com.mrdav30.gridforge.lean#v9.0.0

Do not install the Standard variant in the same project. In a custom asmdef, reference GridForge.Lean.Runtime.

First scene

  1. Add GridWorldComponent to the GameObject that owns the runtime world.

  2. Add GridConfigurationSaver and author a rectangular or hex, dense or sparse configuration.

  3. From a bootstrap MonoBehaviour, apply the saved configurations after the world component initializes:

    _configurationSaver.EarlyApply(
    _gridWorldComponent.RebuildWorld(_configurationSaver.SpatialGridCellSize));

    The getting-started guide includes the complete component.

  4. Import Demo Scene from this package's Samples tab for working examples of configuration, blockers, diagnostics, tracing, and logging.

The dependency bootstrapper installs the matching Lean FixedMathSharp-Unity and SwiftCollections-Unity packages on first editor load. If resolution was interrupted, choose Tools → GridForge.Lean → Repair Dependencies.

Manual dependency URLs, when needed:

https://github.com/mrdav30/FixedMathSharp-Unity.git?path=/com.mrdav30.fixedmathsharp.lean#v7.0.0
https://github.com/mrdav30/SwiftCollections-Unity.git?path=/com.mrdav30.swiftcollections.lean#v7.0.0
https://github.com/mrdav30/SwiftCollections-Unity.git?path=/com.mrdav30.swiftcollections.fixedmathsharp.lean#v7.0.0