Skip to content

DxMessaging Documentation Hub

This is the documentation for DxMessaging, a type-safe messaging system for Unity.

Visual Documentation Map

flowchart TD
    Start[START HERE<br/>Visual Guide<br/>5 minutes]
    Start --> Quick[Quick Start<br/>5 min]
    Start --> Getting[Getting Started<br/>10 min]
    Start --> Overview[Overview<br/>5 min]
    Quick --> Patterns[Patterns & Samples<br/>Hands-on!]
    Getting --> Patterns
    Overview --> Patterns

    classDef primary stroke-width:3px
    class Start primary
    classDef success stroke-width:2px
    class Patterns success
    classDef secondary stroke-width:2px
    class Quick,Getting,Overview secondary

Table of Contents

New to DxMessaging

Never used a messaging system before? Start here:

  1. Mental Model - How to think about DxMessaging (10 min)
  2. Visual Guide - Beginner-friendly visual introduction (5 min)
  3. Getting Started Guide - Comprehensive guide with examples (10 min)
  4. Quick Start - Your first working message (5 min)
  5. Overview - What DxMessaging is and why it exists (5 min)

Learning Path

For Absolute Beginners (Never Used Messaging Before)

  1. Read Mental Model (10 min) - Philosophy first!
  2. Read Visual Guide (5 min) - Pictures and analogies!
  3. Read Getting Started (10 min) - Complete introduction
  4. Try Quick Start (5 min) - Hands-on tutorial
  5. Understand Message Types (10 min) - When to use what
  6. Study Common Patterns (15 min) - Real examples

For Advanced Users

  1. Master Interceptors & Ordering
  2. Explore Listening Patterns
  3. Deep dive into Design & Architecture
  4. Review Advanced Topics

Core Documentation

Essentials

Core Concepts

Unity Integration

Architecture & Performance

Reference

Quick Lookups

Tools & Utilities

Examples and Samples

Unity Samples (Importable!)

Located in Samples~/ directory - Import via Unity Package Manager!

  • Mini Combat - Interactive combat demo with Heal/Damage messages
  • Perfect first example to understand message flow
  • Shows Targeted and Broadcast messages in action

  • Complete working scene you can play with

  • UI Buttons + Inspector - Interactive diagnostics demo

  • See the Inspector diagnostics in action
  • Explore message history and handler registrations
  • Great for debugging and understanding the system

Code Examples (In Docs)

Real-World Patterns

From Common Patterns:

  • Scene-wide events (Untargeted)
  • Directed commands (Targeted)
  • Observability (Broadcast)
  • Validation with Interceptors
  • Analytics with Post-Processors
  • Local bus islands for testing

By Use Case

"I want to..."

Visual: Message Pipeline

Every message flows through 3 stages:

flowchart LR
    P[Producer] --> I[Interceptors<br/>validate/mutate/cancel]
    I --> H[Handlers<br/>main logic by priority]
    H --> PP[Post-Processors<br/>analytics/logging]

    classDef neutral stroke-width:2px
    class P neutral
    classDef warning stroke-width:2px
    class I warning
    classDef primary stroke-width:2px
    class H primary
    classDef success stroke-width:2px
    class PP success

Learning Resources

Must-Read Docs (In Order)

  1. Getting Started - Start here! (10 min)
  2. Message Types - Choose the right type (10 min)
  3. Patterns - See real examples (15 min)
  4. Diagnostics - Debug like a pro (10 min)
  5. Design & Architecture - Understand the internals (30 min)

Feature-Specific

Comparison Charts

DxMessaging vs Alternatives

From Comparisons:

Feature DxMessaging C# Events UnityEvents Static Bus
Decoupling Full Tight Hidden Yes
Lifecycle Safety Auto Manual Unity Manual
Execution Order Priority Random Random Random
Observability Built-in No No No
Performance Zero-alloc Good Boxing Good

Search by Topic

Concepts

Features

Components

Complete Document List

Getting Started

Core Concepts

Unity

Deep Dives

Reference

Dependency Injection

Miscellaneous

Quick Start Path

Absolute Beginner? Follow this 40-minute path:

  1. 10 min: Mental Model - Understand the philosophy first!
  2. 5 min: Visual Guide - Pictures & analogies
  3. 10 min: Getting Started - Deep dive
  4. 5 min: Quick Start - Hands-on code
  5. 10 min: Try a Sample - See it in action

Want to go deep? Continue with:

  1. 15 min: Patterns
  2. 20 min: Interceptors & Ordering
  3. 30 min: Design & Architecture

Need help? Check FAQ or Troubleshooting.