🧮 DT.GridSystem Unity Manual

A comprehensive guide to the DT.GridSystem — a generic Unity grid framework supporting both 2D (XY) and 3D (XZ) layouts.
This manual covers architecture, usage, and function-by-function documentation with clarity.

📚 Table of Contents

1. 📘 Introduction
2. 🧩 Concepts & Architecture
3. 📦 Installation
4. 🔧 How It Works
5. 🚀 Getting Started
6. 🏗️ Core Classes
7. 🛠️ API Reference
8. 🧪 Usage Examples
9. 💡 Best Practices
10. ❓ FAQ
11. 📄 License

📘 Introduction

Welcome to DT.GridSystem, a flexible and extensible system for managing 2D and 3D grids in Unity.

🧠 Use Cases:
Turn-based tile games, AI navigation maps, level editors, placement systems, and more.

✅ Features

• ✅ Generic base class (GridSystem<T>)
• ✅ Seamless grid ↔ world conversion
• ✅ Supports XY (2D) and XZ (3D) layouts
• ✅ UnityEvent-based change notifications
• ✅ Built-in debug gizmo drawing

🧩 Concepts & Architecture

DT.GridSystem is structured into 3 clean layers:

graph TD;
    A[GridSystem<T>] --> B[GridSystem2D<T>]
    A --> C[GridSystem3D<T>]
    B --> D[Your2DGridScript]
    C --> E[Your3DGridScript]

📦 Installation

✅ Option 1: Unity Package (Recommended)

1. Open your Unity project.
2. Go to Window → Package Manager.
3. Click the + button → Add package from Git URL…
4. Enter the URL:

https://github.com/RahulLinganagoudra/com.dreamertheory.gridsystem.git

Click Add and Unity will install the package automatically.

☝️ Make sure your repo has a package.json in the root or under Packages/DT.GridSystem.

🛠 Option 2: Manual Import

1. Download or clone the repo:

git clone https://github.com/RahulLinganagoudra/com.dreamertheory.gridsystem.git

Copy the DT.GridSystem folder into your Unity project’s Assets directory.

🔧 How It Works

🗃️ Grid Array

TGridObject[,] gridArray = new TGridObject[width, height];

⚙️ Initialization

• Allocates the array on Awake()
• Calls your overridden CreateGridObject(...) per cell

🔄 Add / Remove / Get

• AddGridObject(int x, int y, T value)
• RemoveGridObject(int x, int y)
• GetGridObject(int x, int y)
• GetGridObject(Vector3 worldPos)
• TryGetGridObject(...) for safe retrieval

🌍 Grid ↔ World Conversion

• GetWorldPosition(int x, int y)
• GetGridPosition(Vector3 worldPos)

🎯 Visualization

• Draws grid lines in OnDrawGizmos()
• Extendable with custom markers
• Toggle drawGizmos to control

📢 Events

UnityEvent OnGridUpdated

Fired on any grid update.

🚀 Getting Started

1. Add DT.GridSystem to your project
2. Inherit GridSystem2D<T> or GridSystem3D<T>
3. Override:

protected override T CreateGridObject(GridSystem<T> grid, int x, int y)

• Set Grid Size, Cell Size, Enable Gizmos
• Run your scene!

🏗️ Core Classes

📄 License

MIT License — Free to use, modify, and distribute.
Pull requests and attribution are welcome but not required.