com.wallstop-studios.dxmessaging 2.0.0-rc27.3.1 → 2.0.0

package/Samples~/Mini Combat/README.md

@@ -1,16 +1,79 @@
 # Mini Combat Sample
 
-> **What You'll Learn**: This sample demonstrates a simple combat system using DxMessaging to show how components communicate through messages. Perfect for beginners learning the messaging system!
+> **Perfect for:** First-time users who want to see messaging in action with a working combat example
 
-## Overview
+## What You'll Learn in 10 Minutes
 
-This mini-sample showcases a basic combat loop using DxMessaging with Unity-friendly APIs. You'll see how different game objects (Player, Enemy, UI) communicate without direct references to each other.
+**Stop reading documentation and start seeing it work!** This sample shows:
 
-### Key Concepts Demonstrated:
+1. How Player heals without UI knowing about Player (**zero coupling**)
+2. How Enemy broadcasts damage without knowing who cares (**observer pattern**)
+3. How settings changes update everything automatically (**global events**)
 
-- **Untargeted Messages**: Global messages anyone can listen to (like game settings)
-- **Targeted Messages**: Messages sent to a specific component (like healing a player)
-- **Broadcast Messages**: Messages announced to all listeners (like damage events)
+**No prior messaging experience needed** - this sample walks you through everything.
+
+---
+
+## Why This Sample Matters
+
+### Before DxMessaging:
+
+```csharp
+public class Player {
+    [SerializeField] private UI ui;          // Coupling!
+    [SerializeField] private AudioManager audio; // More coupling!
+
+    void Heal(int amount) {
+        health += amount;
+        ui.UpdateHealth(health);     // Manual call
+        audio.PlayHealSound();        // Manual call
+    }
+}
+```
+
+#### Every new system = another SerializeField + another manual call.
+
+##### With DxMessaging:
+
+```csharp
+public class Player : MessageAwareComponent {
+    void Heal(int amount) {
+        health += amount;
+        new PlayerHealed(amount).EmitBroadcast(this);
+        // Done! UI, audio, analytics all react automatically.
+    }
+}
+```
+
+###### Zero coupling. Zero manual wiring. That's the power of messaging.
+
+---
+
+## Key Concepts (3 Message Types)
+
+### 1. Untargeted - "Everyone, listen up!"
+
+**Example:** Game settings changed
+
+- Like a stadium announcement - everyone hears it
+- No specific target
+- Perfect for: settings, pause, scene transitions
+
+### 2. Targeted - "Hey YOU, do this!"
+
+**Example:** Heal this specific player
+
+- Like mailing a letter to one address
+- Only the target receives it
+- Perfect for: commands, direct actions
+
+### 3. Broadcast - "I did something!"
+
+**Example:** Enemy took damage
+
+- Like ringing a bell - anyone nearby can hear
+- Source announces, observers react
+- Perfect for: events, notifications, analytics
 
 ---
 
@@ -28,25 +91,22 @@ Here's what each script does:
 
 ---
 
-## Quick Start Guide
+## Quick Start Guide (2 Minutes to Working Demo)
 
-### Method 1: Import from Package Manager (Recommended)
+### Import & Run (Fastest Way)
 
-1. **Open Package Manager**:
-   - Window → Package Manager
+#### Want to see it work immediately?
 
-1. **Find DxMessaging**:
-   - Look for "DxMessaging" in the package list
-   - Click on it to select
+1. **Open Package Manager**: Window → Package Manager
+2. **Find DxMessaging** in the package list
+3. **Scroll to Samples** section → Find "Mini Combat" → Click **Import**
+4. **Navigate to** Assets/Samples/DxMessaging/.../Mini Combat/
+5. **Open the scene**
+6. **Press Play** 🎮
 
-1. **Import the Sample**:
-   - In the Package Manager details view, scroll down to find the "Samples" section
-   - Find "Mini Combat" and click **Import**
-   - The sample files will be imported into your Assets/Samples folder
+**That's it!** Watch the Console logs as messages flow.
 
-1. **Open the Scene**:
-   - Navigate to Assets/Samples/DxMessaging/.../Mini Combat/
-   - Open the sample scene or create a new scene and follow Step 1 below
+**Pro tip:** Enable diagnostics in the Inspector (MessagingComponent → Enable Diagnostics) to see message traffic in real-time.
 
 ### Method 2: Manual Setup in Your Scene
 

package/Samples~/Mini Combat/Walkthrough.md

@@ -1,6 +1,28 @@
 # Mini Combat Walkthrough
 
-> **Deep Dive**: This walkthrough explains the implementation details and shows how all the sample scripts work together at runtime. Great for understanding the "why" behind the code!
+> **Deep Dive**: Ready to understand HOW it works? This walkthrough explains every line of code and shows the complete message flow.
+
+## Who This Is For
+
+- ✅ **You've imported and run the sample** - now you want to understand it
+- ✅ **You want to build your own** - need to see the patterns in action
+- ✅ **You're debugging something** - need to understand the flow
+
+**Haven't run the sample yet?** Go back to [the sample README](README.md) and press Play first. Come back when you've seen it work.
+
+---
+
+## What You'll Understand By The End
+
+After reading this walkthrough, you'll know:
+
+1. **Why each message type was chosen** - the reasoning behind Untargeted vs Targeted vs Broadcast
+2. **How the code flows** - step-by-step from Boot.cs through every script
+3. **Common patterns** - Observer, Broadcaster, Orchestrator, and more
+4. **Debugging strategies** - how to find and fix issues
+5. **How to extend it** - add your own messages and handlers
+
+**Estimated time:** 20-30 minutes for thorough understanding
 
 ---
 

package/Samples~/UI Buttons + Inspector/README.md

@@ -1,21 +1,64 @@
-# UI Buttons + Inspector (Sample)
+# UI Buttons + Inspector Sample
 
-Make a Unity UI Button send a message with a single OnClick hook — no plumbing, no scene-wide singletons, and easy to understand even if you’re new to event systems.
+> **Perfect for:** Seeing DxMessaging work with Unity UI in 60 seconds
 
-## What You’ll Learn
+## What You'll Learn (No Code Required!)
 
-- How to wire a UI Button to emit a DxMessaging message from the Inspector.
-- How to observe messages in the Console with a tiny listener component.
-- How to turn on diagnostics to see message traffic while you click.
+**Stop writing button click handlers!** This sample shows you how to:
 
-## Import The Sample (60 seconds)
+1. **Wire UI Buttons to messages** - directly from the Inspector (drag & drop)
+2. **See messages flow in real-time** - watch the Console as you click
+3. **Enable diagnostics** - see every message with timestamps and payloads
 
-1. Open `Window > Package Manager` in Unity.
-1. Select `com.wallstop-studios.dxmessaging`.
-1. In Samples, import “UI Buttons + Inspector”.
-1. Open the sample scene (created under your project’s `Assets/Samples/...`).
+**Why this matters:** You can add new systems (analytics, audio, achievements) that react to button clicks WITHOUT touching existing code.
 
-That’s it — the scene includes everything you need to click and see messages.
+---
+
+## The Power Move
+
+### Before DxMessaging:
+
+```csharp
+public class PlayButton : MonoBehaviour {
+    [SerializeField] private GameManager gameManager;   // Coupling
+    [SerializeField] private AudioManager audio;        // Coupling
+    [SerializeField] private Analytics analytics;       // Coupling
+
+    public void OnClick() {
+        gameManager.StartGame();     // Manual call
+        audio.PlayClickSound();       // Manual call
+        analytics.LogButtonClick();   // Manual call
+    }
+}
+```
+
+#### Every new system = update PlayButton script. Exhausting.
+
+##### With DxMessaging:
+
+```csharp
+public class PlayButton : MonoBehaviour {
+    public void OnClick() {
+        new ButtonClicked("Play").Emit();
+        // Done! Everything reacts automatically.
+    }
+}
+```
+
+###### GameManager, Audio, and Analytics listen independently. Zero coupling.
+
+## Import & Run (30 Seconds)
+
+### Want to see it immediately?
+
+1. **Window → Package Manager**
+2. **Find DxMessaging** → Scroll to **Samples**
+3. **"UI Buttons + Inspector"** → Click **Import**
+4. **Navigate to** Assets/Samples/.../UI Buttons + Inspector/
+5. **Open the scene** → **Press Play** 🎮
+6. **Click the buttons** → Watch Console logs
+
+**Done!** You're seeing DxMessaging in action.
 
 ## Click-To-Message: The Quick Path
 

package/Tests/Runtime/Core/SourceGeneratorNestedTests.cs

@@ -39,7 +39,7 @@ namespace DxMessaging.Tests.Runtime.Core
             public readonly string c;
 
             [DxOptionalParameter(Expression = "null")]
-            public readonly string? d;
+            public readonly string d;
         }
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.wallstop-studios.dxmessaging",
-  "version": "2.0.0-rc27.3.1",
+  "version": "2.0.0",
   "displayName": "DxMessaging",
   "description": "Synchronous Event Bus for Unity",
   "unity": "2021.3",