com.wallstop-studios.dxmessaging 2.1.6 → 2.1.8

package/docs/reference/compatibility.md

@@ -1,44 +0,0 @@
-# Compatibility
-
-DxMessaging is render‑pipeline agnostic (pure C#) and targets Unity 2021.3+. The matrix below summarizes support by Unity version and Render Pipeline.
-
-Unity Version vs Render Pipeline
-
-| Unity      | Built‑In RP   | URP           | HDRP          |
-| ---------- | ------------- | ------------- | ------------- |
-| 2021.3 LTS | ✅ Compatible | ✅ Compatible | ✅ Compatible |
-| 2022.3 LTS | ✅ Compatible | ✅ Compatible | ✅ Compatible |
-| 2023.x     | ✅ Compatible | ✅ Compatible | ✅ Compatible |
-| 6.x        | ✅ Compatible | ✅ Compatible | ✅ Compatible |
-
-Notes
-
-- RP‑agnostic: DxMessaging does not depend on rendering APIs; it works equally across Built‑In, URP, and HDRP.
-- Minimum version is governed by the package manifest (`unity`: 2021.3). Newer LTS versions are expected to work.
-
-## Architecture Pattern Compatibility
-
-### Scriptable Object Architecture (SOA)
-
-DxMessaging can work alongside Scriptable Object Architecture patterns, though SOA has documented limitations. See [Pattern 14: SOA Compatibility](../guides/patterns.md#14-compatibility-with-scriptable-object-architecture-soa) for detailed integration strategies, code examples, and migration paths.
-
-#### Quick summary
-
-- ✅ **Compatible** - DxMessaging can bridge with SOA systems
-- ⚠️ **Not recommended** - SOA has scalability and maintainability concerns ([detailed critique](https://github.com/cathei/AntiScriptableObjectArchitecture))
-- ✅ **Best practice** - Use ScriptableObjects for immutable design data, DxMessaging for runtime events
-- → See [SOA Integration Patterns](../guides/patterns.md#14-compatibility-with-scriptable-object-architecture-soa) for three coexistence strategies with code examples
-
-### Dependency Injection (DI) Frameworks
-
-DxMessaging integrates with popular DI frameworks:
-
-- **Zenject** - See [Zenject Integration Guide](../integrations/zenject.md)
-- **VContainer** - See [VContainer Integration Guide](../integrations/vcontainer.md)
-- **Reflex** - See [Reflex Integration Guide](../integrations/reflex.md)
-
-DI and DxMessaging complement each other: DI manages dependencies/services, DxMessaging handles event communication.
-
-### Other Unity Frameworks
-
-For comparisons with other messaging/event frameworks (UniRx, MessagePipe, Zenject Signals, etc.), see [Framework Comparisons](../architecture/comparisons.md).

package/docs/reference/compatibility.md.meta

@@ -1,7 +0,0 @@
-fileFormatVersion: 2
-guid: a74217f7a583d18438f237a82d105c71
-TextScriptImporter:
-  externalObjects: {}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 

package/docs/reference/faq.md

@@ -1,57 +0,0 @@
-# FAQ — Frequently Asked Questions
-
-[← Back to Index](../getting-started/index.md) | [Troubleshooting](troubleshooting.md) | [Getting Started](../getting-started/getting-started.md) | [Glossary](glossary.md)
-
----
-
-## Do I need to use attributes or source generators
-
-- No. You can implement `IUntargetedMessage<T>`, `ITargetedMessage<T>`, or `IBroadcastMessage<T>` directly (recommended for structs). Attributes are optional and help tooling/source‑gen.
-
-## Which message type should I use?
-
-- **Untargeted** - global notifications (any listener).
-- **Targeted** - commands/events for a specific recipient.
-- **Broadcast** - facts emitted from a source that others may observe.
-
-## How do I enforce ordering?
-
-- Use the `priority` parameter at registration; lower runs earlier. Interceptors run before handlers; post‑processors run after.
-
-## Can I observe all targets/sources for a type?
-
-- Yes. Use `RegisterTargetedWithoutTargeting<T>` or `RegisterBroadcastWithoutSource<T>` (and their post‑processor counterparts).
-
-## How do I diagnose what's happening?
-
-- Enable logs and diagnostics: [Diagnostics](../guides/diagnostics.md).
-
-## What happens if I register a listener inside a message handler?
-
-- The newly registered listener will **not** run for the current message emission. It will only become active starting with the **next** message emission.
-- This is called "snapshot semantics" — when a message is emitted, DxMessaging takes a snapshot of all current listeners and uses that frozen list for the entire emission.
-- This applies to all listener types (handlers, interceptors, post-processors) and all message categories (Untargeted, Targeted, Broadcast).
-- This behavior prevents infinite loops and ensures predictable execution order. See [Interceptors & Ordering](../concepts/interceptors-and-ordering.md#snapshot-semantics-frozen-listener-lists) for details and examples.
-
-## Do I need a global bus?
-
-- A global bus is provided (`MessageHandler.MessageBus`). You can also create and pass your own `MessageBus` instance to isolate subsystems and tests.
-
-## Is this compatible with Unity's SendMessage/UnityEvents
-
-- Yes. You can integrate with legacy patterns via `ReflexiveMessage`. Prefer DxMessaging for new code.
-
----
-
-## Related Documentation
-
-- **New to DxMessaging?**
-  - → [Visual Guide](../getting-started/visual-guide.md) — Beginner-friendly introduction
-  - → [Getting Started](../getting-started/getting-started.md) — Complete guide
-  - → [Glossary](glossary.md) — All terms explained
-- **Common Issues**
-  - → [Troubleshooting](troubleshooting.md) — Solutions to common problems
-  - → [Common Patterns](../guides/patterns.md) — See how to use it correctly
-- **Reference**
-  - → [Quick Reference](quick-reference.md) — API cheat sheet
-  - → [Message Types](../concepts/message-types.md) — Which type to use when

package/docs/reference/faq.md.meta

@@ -1,7 +0,0 @@
-fileFormatVersion: 2
-guid: e3e07317cd6c4574c9987ef152e97dec
-TextScriptImporter:
-  externalObjects: {}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 

package/docs/reference/glossary.md

@@ -1,267 +0,0 @@
-# Glossary — DxMessaging Terms Explained
-
-[← Back to Index](../getting-started/index.md) | [Getting Started](../getting-started/getting-started.md) | [Visual Guide](../getting-started/visual-guide.md)
-
----
-
-**New to messaging systems?** This glossary explains key terms in plain English.
-
-## Core Concepts
-
-### Message
-
-A **data structure** that represents something that happened or should happen. Think of it like a letter or announcement containing information.
-
-Example: `Heal { amount: 10 }` is a message saying "heal for 10 points."
-
-### Message Type
-
-The **category** of message that determines who receives it:
-
-- **Untargeted**: Everyone hears it (like a megaphone announcement)
-- **Targeted**: One specific recipient gets it (like a letter to an address)
-- **Broadcast**: Comes from one source, anyone can listen (like a news broadcast)
-
-### Handler
-
-A **function** that runs when a message is received. Your game logic goes here.
-
-Example:
-
-```csharp
-void OnHeal(ref Heal msg) {
-    health += msg.amount; // This is the handler
-}
-```
-
-### Token
-
-A **registration handle** that manages the lifecycle of your message handlers. It automatically enables/disables handlers when your component is active/inactive.
-
-Think of it like a subscription card — when you destroy it, all your subscriptions end automatically.
-
-### MessageAwareComponent
-
-A **Unity MonoBehaviour base class** that handles all the lifecycle management for you. Inherit from this and you get automatic setup/cleanup.
-
-```csharp
-public class MyComponent : MessageAwareComponent {
-    // Token is created automatically!
-}
-```
-
-## Message Pipeline
-
-### Interceptor
-
-Code that runs **before** handlers. Can **validate, modify, or cancel** messages before anyone else sees them.
-
-Example: "Only allow damage between 1 and 999"
-
-```csharp
-// Use the type-specific interceptor variant based on your message type:
-// - RegisterUntargetedInterceptor<T> for IUntargetedMessage
-// - RegisterTargetedInterceptor<T> for ITargetedMessage
-// - RegisterBroadcastInterceptor<T> for IBroadcastMessage
-_ = token.RegisterBroadcastInterceptor<Damage>((ref InstanceId source, ref Damage msg) => {
-    if (msg.amount <= 0) return false; // Cancel
-    if (msg.amount > 999) msg = new Damage(999); // Clamp
-    return true; // Allow
-});
-```
-
-### Post-Processor
-
-Code that runs **after** all handlers. Perfect for **logging, analytics, or metrics** that shouldn't affect gameplay.
-
-Example: "Track every damage event for statistics"
-
-```csharp
-// Use the type-specific post-processor variant based on your message type:
-// - RegisterUntargetedPostProcessor<T> for IUntargetedMessage
-// - RegisterBroadcastWithoutSourcePostProcessor<T> for IBroadcastMessage from any source
-_ = token.RegisterBroadcastWithoutSourcePostProcessor<Damage>((InstanceId source, Damage msg) => {
-    Analytics.LogDamage(source, msg.amount);
-});
-```
-
-### Priority
-
-A **number** that controls execution order. **Lower numbers run first**.
-
-Example:
-
-```csharp
-_ = token.RegisterUntargeted<GameExit>(SaveGame, priority: 0);  // Runs first
-_ = token.RegisterUntargeted<GameExit>(FadeAudio, priority: 5); // Runs second
-_ = token.RegisterUntargeted<GameExit>(ShowUI, priority: 10);   // Runs third
-```
-
-## Unity Integration
-
-### InstanceId
-
-A **unique identifier** for a GameObject or Component. Used internally to route messages to the right place.
-
-You rarely use this directly — use the GameObject/Component helpers instead:
-
-```csharp
-msg.EmitGameObjectTargeted(gameObject); // Helper (use this)
-// vs
-msg.EmitTargeted(gameObject.GetInstanceID()); // Manual InstanceId (avoid)
-```
-
-### MessagingComponent
-
-The **base Unity component** that provides messaging infrastructure. `MessageAwareComponent` inherits from this.
-
-### Emit
-
-To **send** a message. Like hitting "send" on an email.
-
-```csharp
-var heal = new Heal(10);
-heal.Emit(); // Send it!
-```
-
-### Register
-
-To **sign up** to receive messages. Like subscribing to a newsletter.
-
-```csharp
-_ = Token.RegisterUntargeted<Heal>(OnHeal); // Subscribe
-```
-
-## Advanced Terms
-
-### Message Bus
-
-The **central routing system** that delivers messages. Think of it like a post office.
-
-There's a global bus (`MessageHandler.MessageBus`) that most code uses, but you can create local buses for testing or isolation.
-
-### Local Bus / Bus Island
-
-A **separate message bus** used to isolate subsystems or tests. Messages sent to a local bus don't affect the global bus.
-
-```csharp
-var testBus = new MessageBus(); // Create island
-var token = MessageRegistrationToken.Create(handler, testBus); // Use it
-```
-
-### Global Accept-All
-
-A special handler that receives **every single message** regardless of type. Used for tools, debuggers, and analytics.
-
-```csharp
-_ = Token.RegisterGlobalAcceptAll(
-    (ref IUntargetedMessage m) => Debug.Log("Untargeted: " + m),
-    (ref InstanceId t, ref ITargetedMessage m) => Debug.Log("Targeted: " + m),
-    (ref InstanceId s, ref IBroadcastMessage m) => Debug.Log("Broadcast: " + m)
-);
-```
-
-### Diagnostics Mode
-
-A **debug feature** that tracks message history and handler statistics. Enable in Editor, disable in builds for performance.
-
-```csharp
-IMessageBus.GlobalDiagnosticsMode = true; // See message history
-```
-
-## Attributes (Source Generation)
-
-### [DxUntargetedMessage]
-
-Marks a struct as an **Untargeted message** (global announcement).
-
-### [DxTargetedMessage]
-
-Marks a struct as a **Targeted message** (command to one recipient).
-
-### [DxBroadcastMessage]
-
-Marks a struct as a **Broadcast message** (event from a source).
-
-### [DxAutoConstructor]
-
-Auto-generates a **constructor** for your message struct so you don't have to write it manually.
-
-```csharp
-[DxTargetedMessage]
-[DxAutoConstructor] // Generates: public Heal(int amount) { this.amount = amount; }
-public readonly partial struct Heal {
-    public readonly int amount;
-}
-```
-
-## Common Patterns
-
-### Lifecycle
-
-The **creation and destruction** of components and their message registrations.
-
-DxMessaging handles this automatically via `MessageAwareComponent`:
-
-- `Awake()`: Token created, handlers registered
-- `OnEnable()`: Token enabled, handlers active
-- `OnDisable()`: Token disabled, handlers inactive
-- `OnDestroy()`: Token destroyed, everything cleaned up
-
-### Decoupling
-
-Making systems **independent** so they don't need references to each other.
-
-#### Before DxMessaging
-
-```csharp
-public class UI : MonoBehaviour {
-    [SerializeField] Player player; // Tight coupling!
-    [SerializeField] EnemySpawner spawner;
-    [SerializeField] AudioManager audio;
-}
-```
-
-##### With DxMessaging
-
-```csharp
-public class UI : MessageAwareComponent {
-    // No references needed! Just listen for messages.
-    protected override void RegisterMessageHandlers() {
-        _ = Token.RegisterBroadcastWithoutSource<PlayerDamaged>(OnDamage);
-    }
-}
-```
-
-## Quick Reference Table
-
-| Term               | One-Line Explanation                                 |
-| ------------------ | ---------------------------------------------------- |
-| **Message**        | Data saying "something happened" or "do something"   |
-| **Handler**        | Function that runs when you receive a message        |
-| **Token**          | Subscription manager (auto-cleanup)                  |
-| **Interceptor**    | Guard that checks/modifies messages before delivery  |
-| **Post-Processor** | Code that runs after all handlers (logging/metrics)  |
-| **Priority**       | Number controlling execution order (lower = earlier) |
-| **Emit**           | Send a message                                       |
-| **Register**       | Subscribe to receive messages                        |
-| **InstanceId**     | Unique ID for a GameObject or Component              |
-| **Bus**            | Central message router (like a post office)          |
-
----
-
-## Related Documentation
-
-### Learn More
-
-- → [Visual Guide](../getting-started/visual-guide.md) — See these concepts visualized
-- → [Getting Started](../getting-started/getting-started.md) — Full introduction with examples
-- → [Message Types](../concepts/message-types.md) — When to use each type
-
-#### Reference
-
-- → [Quick Reference](quick-reference.md) — API cheat sheet
-- → [API Reference](reference.md) — Complete API documentation
-
-- → [Mini Combat sample](https://github.com/wallstop/DxMessaging/blob/master/Samples~/Mini%20Combat/README.md) — See concepts in action
-- → [Patterns](../guides/patterns.md) — Real-world usage patterns

package/docs/reference/glossary.md.meta

@@ -1,7 +0,0 @@
-fileFormatVersion: 2
-guid: 422b46819fc38c441b0ffb92dacf693d
-TextScriptImporter:
-  externalObjects: {}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: