npm - com.wallstop-studios.dxmessaging - Versions diffs - 2.1.4 → 2.1.5 - Mend

com.wallstop-studios.dxmessaging 2.1.4 → 2.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1219) hide show

package/site/getting-started/getting-started/index.html ADDED Viewed

@@ -0,0 +1,66 @@
+<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="High-performance type-safe messaging library for Unity"><meta name=author content="Wallstop Studios"><link href=https://wallstop.github.io/DxMessaging/getting-started/getting-started/ rel=canonical><link href=../quick-start/ rel=prev><link href=../visual-guide/ rel=next><link rel=icon href=../../assets/images/favicon.png><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.7.1"><title>Getting Started Guide - DxMessaging Documentation</title><link rel=stylesheet href=../../assets/stylesheets/main.484c7ddc.min.css><link rel=stylesheet href=../../assets/stylesheets/palette.ab4e12ef.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../../css/timeago.css><link rel=stylesheet href=../../stylesheets/extra.css><script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script></head> <body dir=ltr data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#getting-started-with-dxmessaging class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <header class="md-header md-header--shadow md-header--lifted" data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../.. title="DxMessaging Documentation" class="md-header__button md-logo" aria-label="DxMessaging Documentation" data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> DxMessaging Documentation </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> Getting Started Guide </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> </form> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> </label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query required> <label class="md-search__icon md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </label> <nav class=md-search__options aria-label=Search> <a href=javascript:void(0) class="md-search__icon md-icon" title=Share aria-label=Share data-clipboard data-clipboard-text data-md-component=search-share tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg> </a> <button type=reset class="md-search__icon md-icon" title=Clear aria-label=Clear tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg> </button> </nav> <div class=md-search__suggest data-md-component=search-suggest></div> </form> <div class=md-search__output> <div class=md-search__scrollwrap tabindex=0 data-md-scrollfix> <div class=md-search-result data-md-component=search-result> <div class=md-search-result__meta> Initializing search </div> <ol class=md-search-result__list role=presentation></ol> </div> </div> </div> </div> </div> <div class=md-header__source> <a href=https://github.com/wallstop/DxMessaging title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </div> <div class=md-source__repository> wallstop/DxMessaging </div> </a> </div> </nav> <nav class=md-tabs aria-label=Tabs data-md-component=tabs> <div class=md-grid> <ul class=md-tabs__list> <li class=md-tabs__item> <a href=../.. class=md-tabs__link> Home </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href=../ class=md-tabs__link> Getting Started </a> </li> <li class=md-tabs__item> <a href=../../concepts/message-types/ class=md-tabs__link> Concepts </a> </li> <li class=md-tabs__item> <a href=../../guides/patterns/ class=md-tabs__link> Guides </a> </li> <li class=md-tabs__item> <a href=../../architecture/design-and-architecture/ class=md-tabs__link> Architecture </a> </li> <li class=md-tabs__item> <a href=../../advanced/emit-shorthands/ class=md-tabs__link> Advanced </a> </li> <li class=md-tabs__item> <a href=../../integrations/ class=md-tabs__link> Integrations </a> </li> <li class=md-tabs__item> <a href=../../examples/end-to-end/ class=md-tabs__link> Examples </a> </li> <li class=md-tabs__item> <a href=../../reference/reference/ class=md-tabs__link> Reference </a> </li> </ul> </div> </nav> </header> <div class=md-container data-md-component=container> <main class=md-main data-md-component=main> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component=sidebar data-md-type=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary md-nav--lifted" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=../.. title="DxMessaging Documentation" class="md-nav__button md-logo" aria-label="DxMessaging Documentation" data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg> </a> DxMessaging Documentation </label> <div class=md-nav__source> <a href=https://github.com/wallstop/DxMessaging title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </div> <div class=md-source__repository> wallstop/DxMessaging </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../.. class=md-nav__link> <span class=md-ellipsis> Home </span> </a> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_2 checked> <div class="md-nav__link md-nav__container"> <a href=../ class="md-nav__link "> <span class=md-ellipsis> Getting Started </span> </a> <label class="md-nav__link " for=__nav_2 id=__nav_2_label tabindex> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_2_label aria-expanded=true> <label class=md-nav__title for=__nav_2> <span class="md-nav__icon md-icon"></span> Getting Started </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../overview/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <li class=md-nav__item> <a href=../install/ class=md-nav__link> <span class=md-ellipsis> Installation </span> </a> </li> <li class=md-nav__item> <a href=../quick-start/ class=md-nav__link> <span class=md-ellipsis> Quick Start </span> </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> <span class=md-ellipsis> Getting Started Guide </span> <span class="md-nav__icon md-icon"></span> </label> <a href=./ class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> Getting Started Guide </span> </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#your-goal class=md-nav__link> <span class=md-ellipsis> Your Goal </span> </a> </li> <li class=md-nav__item> <a href=#table-of-contents class=md-nav__link> <span class=md-ellipsis> Table of Contents </span> </a> </li> <li class=md-nav__item> <a href=#what-is-dxmessaging class=md-nav__link> <span class=md-ellipsis> What is DxMessaging? </span> </a> <nav class=md-nav aria-label="What is DxMessaging?"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-you-get class=md-nav__link> <span class=md-ellipsis> What you get </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#quick-start class=md-nav__link> <span class=md-ellipsis> Quick Start </span> </a> </li> <li class=md-nav__item> <a href=#message-types class=md-nav__link> <span class=md-ellipsis> Message Types </span> </a> <nav class=md-nav aria-label="Message Types"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#new-to-messaging-use-this-decision-tree class=md-nav__link> <span class=md-ellipsis> New to messaging? Use this decision tree </span> </a> <nav class=md-nav aria-label="New to messaging? Use this decision tree"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#examples class=md-nav__link> <span class=md-ellipsis> Examples </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#common-patterns class=md-nav__link> <span class=md-ellipsis> Common Patterns </span> </a> <nav class=md-nav aria-label="Common Patterns"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#example-use-cases class=md-nav__link> <span class=md-ellipsis> Example use cases </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#troubleshooting class=md-nav__link> <span class=md-ellipsis> Troubleshooting </span> </a> <nav class=md-nav aria-label=Troubleshooting> <ul class=md-nav__list> <li class=md-nav__item> <a href=#my-handler-isnt-being-called class=md-nav__link> <span class=md-ellipsis> "My handler isn't being called" </span> </a> </li> <li class=md-nav__item> <a href=#my-message-is-firing-twice class=md-nav__link> <span class=md-ellipsis> "My message is firing twice" </span> </a> </li> <li class=md-nav__item> <a href=#i-get-a-compile-error-on-dxautoconstructor class=md-nav__link> <span class=md-ellipsis> "I get a compile error on [DxAutoConstructor]" </span> </a> </li> <li class=md-nav__item> <a href=#which-message-type-should-i-use class=md-nav__link> <span class=md-ellipsis> "Which message type should I use" </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#next-steps class=md-nav__link> <span class=md-ellipsis> Next Steps </span> </a> </li> <li class=md-nav__item> <a href=#quick-reference class=md-nav__link> <span class=md-ellipsis> Quick Reference </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../visual-guide/ class=md-nav__link> <span class=md-ellipsis> Visual Guide </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_3> <label class=md-nav__link for=__nav_3 id=__nav_3_label tabindex=0> <span class=md-ellipsis> Concepts </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_3_label aria-expanded=false> <label class=md-nav__title for=__nav_3> <span class="md-nav__icon md-icon"></span> Concepts </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../concepts/message-types/ class=md-nav__link> <span class=md-ellipsis> Message Types </span> </a> </li> <li class=md-nav__item> <a href=../../concepts/listening-patterns/ class=md-nav__link> <span class=md-ellipsis> Listening Patterns </span> </a> </li> <li class=md-nav__item> <a href=../../concepts/targeting-and-context/ class=md-nav__link> <span class=md-ellipsis> Targeting & Context </span> </a> </li> <li class=md-nav__item> <a href=../../concepts/interceptors-and-ordering/ class=md-nav__link> <span class=md-ellipsis> Interceptors & Ordering </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4> <label class=md-nav__link for=__nav_4 id=__nav_4_label tabindex=0> <span class=md-ellipsis> Guides </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4> <span class="md-nav__icon md-icon"></span> Guides </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../guides/patterns/ class=md-nav__link> <span class=md-ellipsis> Patterns </span> </a> </li> <li class=md-nav__item> <a href=../../guides/unity-integration/ class=md-nav__link> <span class=md-ellipsis> Unity Integration </span> </a> </li> <li class=md-nav__item> <a href=../../guides/testing/ class=md-nav__link> <span class=md-ellipsis> Testing </span> </a> </li> <li class=md-nav__item> <a href=../../guides/diagnostics/ class=md-nav__link> <span class=md-ellipsis> Diagnostics </span> </a> </li> <li class=md-nav__item> <a href=../../guides/advanced/ class=md-nav__link> <span class=md-ellipsis> Advanced Topics </span> </a> </li> <li class=md-nav__item> <a href=../../guides/migration-guide/ class=md-nav__link> <span class=md-ellipsis> Migration Guide </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5> <label class=md-nav__link for=__nav_5 id=__nav_5_label tabindex=0> <span class=md-ellipsis> Architecture </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_5_label aria-expanded=false> <label class=md-nav__title for=__nav_5> <span class="md-nav__icon md-icon"></span> Architecture </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../architecture/design-and-architecture/ class=md-nav__link> <span class=md-ellipsis> Design & Architecture </span> </a> </li> <li class=md-nav__item> <a href=../../architecture/comparisons/ class=md-nav__link> <span class=md-ellipsis> Comparisons </span> </a> </li> <li class=md-nav__item> <a href=../../architecture/performance/ class=md-nav__link> <span class=md-ellipsis> Performance </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6> <label class=md-nav__link for=__nav_6 id=__nav_6_label tabindex=0> <span class=md-ellipsis> Advanced </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_6_label aria-expanded=false> <label class=md-nav__title for=__nav_6> <span class="md-nav__icon md-icon"></span> Advanced </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../advanced/emit-shorthands/ class=md-nav__link> <span class=md-ellipsis> Emit Shorthands </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/message-bus-providers/ class=md-nav__link> <span class=md-ellipsis> Message Bus Providers </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/registration-builders/ class=md-nav__link> <span class=md-ellipsis> Registration Builders </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/runtime-configuration/ class=md-nav__link> <span class=md-ellipsis> Runtime Configuration </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/string-messages/ class=md-nav__link> <span class=md-ellipsis> String Messages </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_7> <div class="md-nav__link md-nav__container"> <a href=../../integrations/ class="md-nav__link "> <span class=md-ellipsis> Integrations </span> </a> <label class="md-nav__link " for=__nav_7 id=__nav_7_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_7_label aria-expanded=false> <label class=md-nav__title for=__nav_7> <span class="md-nav__icon md-icon"></span> Integrations </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../integrations/vcontainer/ class=md-nav__link> <span class=md-ellipsis> VContainer </span> </a> </li> <li class=md-nav__item> <a href=../../integrations/zenject/ class=md-nav__link> <span class=md-ellipsis> Zenject </span> </a> </li> <li class=md-nav__item> <a href=../../integrations/reflex/ class=md-nav__link> <span class=md-ellipsis> Reflex </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_8> <label class=md-nav__link for=__nav_8 id=__nav_8_label tabindex=0> <span class=md-ellipsis> Examples </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_8_label aria-expanded=false> <label class=md-nav__title for=__nav_8> <span class="md-nav__icon md-icon"></span> Examples </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../examples/end-to-end/ class=md-nav__link> <span class=md-ellipsis> End-to-End </span> </a> </li> <li class=md-nav__item> <a href=../../examples/end-to-end-scene-transitions/ class=md-nav__link> <span class=md-ellipsis> Scene Transitions </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_9> <label class=md-nav__link for=__nav_9 id=__nav_9_label tabindex=0> <span class=md-ellipsis> Reference </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_9_label aria-expanded=false> <label class=md-nav__title for=__nav_9> <span class="md-nav__icon md-icon"></span> Reference </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../reference/reference/ class=md-nav__link> <span class=md-ellipsis> API Reference (Practical) </span> </a> </li> <li class=md-nav__item> <a href=../../reference/quick-reference/ class=md-nav__link> <span class=md-ellipsis> Quick Reference </span> </a> </li> <li class=md-nav__item> <a href=../../reference/helpers/ class=md-nav__link> <span class=md-ellipsis> Helpers </span> </a> </li> <li class=md-nav__item> <a href=../../reference/faq/ class=md-nav__link> <span class=md-ellipsis> FAQ </span> </a> </li> <li class=md-nav__item> <a href=../../reference/glossary/ class=md-nav__link> <span class=md-ellipsis> Glossary </span> </a> </li> <li class=md-nav__item> <a href=../../reference/troubleshooting/ class=md-nav__link> <span class=md-ellipsis> Troubleshooting </span> </a> </li> <li class=md-nav__item> <a href=../../reference/compatibility/ class=md-nav__link> <span class=md-ellipsis> Compatibility </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=sidebar data-md-type=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#your-goal class=md-nav__link> <span class=md-ellipsis> Your Goal </span> </a> </li> <li class=md-nav__item> <a href=#table-of-contents class=md-nav__link> <span class=md-ellipsis> Table of Contents </span> </a> </li> <li class=md-nav__item> <a href=#what-is-dxmessaging class=md-nav__link> <span class=md-ellipsis> What is DxMessaging? </span> </a> <nav class=md-nav aria-label="What is DxMessaging?"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-you-get class=md-nav__link> <span class=md-ellipsis> What you get </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#quick-start class=md-nav__link> <span class=md-ellipsis> Quick Start </span> </a> </li> <li class=md-nav__item> <a href=#message-types class=md-nav__link> <span class=md-ellipsis> Message Types </span> </a> <nav class=md-nav aria-label="Message Types"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#new-to-messaging-use-this-decision-tree class=md-nav__link> <span class=md-ellipsis> New to messaging? Use this decision tree </span> </a> <nav class=md-nav aria-label="New to messaging? Use this decision tree"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#examples class=md-nav__link> <span class=md-ellipsis> Examples </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#common-patterns class=md-nav__link> <span class=md-ellipsis> Common Patterns </span> </a> <nav class=md-nav aria-label="Common Patterns"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#example-use-cases class=md-nav__link> <span class=md-ellipsis> Example use cases </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#troubleshooting class=md-nav__link> <span class=md-ellipsis> Troubleshooting </span> </a> <nav class=md-nav aria-label=Troubleshooting> <ul class=md-nav__list> <li class=md-nav__item> <a href=#my-handler-isnt-being-called class=md-nav__link> <span class=md-ellipsis> "My handler isn't being called" </span> </a> </li> <li class=md-nav__item> <a href=#my-message-is-firing-twice class=md-nav__link> <span class=md-ellipsis> "My message is firing twice" </span> </a> </li> <li class=md-nav__item> <a href=#i-get-a-compile-error-on-dxautoconstructor class=md-nav__link> <span class=md-ellipsis> "I get a compile error on [DxAutoConstructor]" </span> </a> </li> <li class=md-nav__item> <a href=#which-message-type-should-i-use class=md-nav__link> <span class=md-ellipsis> "Which message type should I use" </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#next-steps class=md-nav__link> <span class=md-ellipsis> Next Steps </span> </a> </li> <li class=md-nav__item> <a href=#quick-reference class=md-nav__link> <span class=md-ellipsis> Quick Reference </span> </a> </li> </ul> </nav> </div> </div> </div> <div class=md-content data-md-component=content> <nav class=md-path aria-label=Navigation> <ol class=md-path__list> <li class=md-path__item> <a href=../.. class=md-path__link> <span class=md-ellipsis> Home </span> </a> </li> <li class=md-path__item> <a href=../ class=md-path__link> <span class=md-ellipsis> Getting Started </span> </a> </li> </ol> </nav> <article class="md-content__inner md-typeset"> <a href=https://github.com/wallstop/DxMessaging/edit/master/docs/getting-started/getting-started.md title="Edit this page" class="md-content__button md-icon" rel=edit> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg> </a> <a href=https://github.com/wallstop/DxMessaging/raw/master/docs/getting-started/getting-started.md title="View source of this page" class="md-content__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg> </a> <h1 id=getting-started-with-dxmessaging>Getting Started with DxMessaging<a class=headerlink href=#getting-started-with-dxmessaging title="Anchor link to this section">&para;</a></h1> <p><a href=../ >Back to Index</a> | <a href=../visual-guide/ >Visual Guide</a> | <a href=../quick-start/ >Quick Start</a> | <a href=../../reference/faq/ >FAQ</a></p> <hr> <p>This guide covers the basics of DxMessaging. By the end, you'll understand what DxMessaging is, when it might be useful, and how to use it in your Unity projects.</p> <h2 id=your-goal>Your Goal<a class=headerlink href=#your-goal title="Anchor link to this section">&para;</a></h2> <p>By the end of this guide, you will:</p> <ul> <li>Understand the three message types and when to use each</li> <li>Write your first message handler in Unity</li> <li>Know when to use DxMessaging vs. traditional events</li> <li>Avoid common beginner mistakes</li> </ul> <h2 id=table-of-contents>Table of Contents<a class=headerlink href=#table-of-contents title="Anchor link to this section">&para;</a></h2> <ul> <li><a href=#what-is-dxmessaging>What is DxMessaging?</a></li> <li><a href=#quick-start>Quick Start</a></li> <li><a href=#message-types>Message Types</a></li> <li><a href=#common-patterns>Common Patterns</a></li> <li><a href=#troubleshooting>Troubleshooting</a></li> <li><a href=#next-steps>Next Steps</a></li> <li><a href=#quick-reference>Quick Reference</a></li> </ul> <h2 id=what-is-dxmessaging>What is DxMessaging?<a class=headerlink href=#what-is-dxmessaging title="Anchor link to this section">&para;</a></h2> <p><strong>Picture this:</strong> You're building a Unity game. Your player takes damage. Now you need to:</p> <ul> <li>Update the health bar UI</li> <li>Play a damage sound</li> <li>Show a damage number popup</li> <li>Track damage for analytics</li> <li>Check if an achievement unlocked</li> <li>Maybe trigger a tutorial tip</li> </ul> <p><strong>One approach:</strong> The Player script needs references to all 6 systems. Or they all need references to the Player. This can create tight coupling.</p> <p><strong>With DxMessaging:</strong> The Player emits one message: <code>TookDamage(25)</code>. Interested systems receive it through subscriptions. This approach decouples systems and handles cleanup automatically.</p> <hr> <p><strong>Technical summary:</strong> DxMessaging is a type-safe messaging system that provides an alternative to C# events, UnityEvents, and global event buses.</p> <p><strong>Think of it as:</strong> An alternative event system designed for larger projects.</p> <h3 id=what-you-get>What you get<a class=headerlink href=#what-you-get title="Anchor link to this section">&para;</a></h3> <ul> <li><strong>Decoupled systems</strong> - no manual subscribe/unsubscribe, leak prevention built-in</li> <li><strong>Predictable execution</strong> - priority-based ordering, see exactly what runs when</li> <li><strong>Actually debuggable</strong> - Inspector shows message history with timestamps</li> <li><strong>Designed to scale</strong> - works for prototypes and larger codebases</li> </ul> <h2 id=quick-start>Quick Start<a class=headerlink href=#quick-start title="Anchor link to this section">&para;</a></h2> <ol> <li>Define messages</li> </ol> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=k>using</span><span class=w> </span><span class=nn>DxMessaging.Core.Attributes</span><span class=p>;</span>
+</span><span id=__span-0-2><a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a>
+</span><span id=__span-0-3><a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a><span class=na>[DxTargetedMessage]</span>
+</span><span id=__span-0-4><a id=__codelineno-0-4 name=__codelineno-0-4 href=#__codelineno-0-4></a><span class=na>[DxAutoConstructor]</span>
+</span><span id=__span-0-5><a id=__codelineno-0-5 name=__codelineno-0-5 href=#__codelineno-0-5></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>partial</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>Heal</span>
+</span><span id=__span-0-6><a id=__codelineno-0-6 name=__codelineno-0-6 href=#__codelineno-0-6></a><span class=p>{</span>
+</span><span id=__span-0-7><a id=__codelineno-0-7 name=__codelineno-0-7 href=#__codelineno-0-7></a><span class=w>    </span><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=n>amount</span><span class=p>;</span>
+</span><span id=__span-0-8><a id=__codelineno-0-8 name=__codelineno-0-8 href=#__codelineno-0-8></a><span class=p>}</span>
+</span><span id=__span-0-9><a id=__codelineno-0-9 name=__codelineno-0-9 href=#__codelineno-0-9></a>
+</span><span id=__span-0-10><a id=__codelineno-0-10 name=__codelineno-0-10 href=#__codelineno-0-10></a><span class=na>[DxBroadcastMessage]</span>
+</span><span id=__span-0-11><a id=__codelineno-0-11 name=__codelineno-0-11 href=#__codelineno-0-11></a><span class=na>[DxAutoConstructor]</span>
+</span><span id=__span-0-12><a id=__codelineno-0-12 name=__codelineno-0-12 href=#__codelineno-0-12></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>partial</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>TookDamage</span>
+</span><span id=__span-0-13><a id=__codelineno-0-13 name=__codelineno-0-13 href=#__codelineno-0-13></a><span class=p>{</span>
+</span><span id=__span-0-14><a id=__codelineno-0-14 name=__codelineno-0-14 href=#__codelineno-0-14></a><span class=w>    </span><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=n>amount</span><span class=p>;</span>
+</span><span id=__span-0-15><a id=__codelineno-0-15 name=__codelineno-0-15 href=#__codelineno-0-15></a><span class=p>}</span>
+</span></code></pre></div> <ol> <li>Listen in a component</li> </ol> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-1-1><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=k>using</span><span class=w> </span><span class=nn>DxMessaging.Core</span><span class=p>;</span>
+</span><span id=__span-1-2><a id=__codelineno-1-2 name=__codelineno-1-2 href=#__codelineno-1-2></a><span class=k>using</span><span class=w> </span><span class=nn>DxMessaging.Core.Extensions</span><span class=p>;</span>
+</span><span id=__span-1-3><a id=__codelineno-1-3 name=__codelineno-1-3 href=#__codelineno-1-3></a><span class=k>using</span><span class=w> </span><span class=nn>DxMessaging.Unity</span><span class=p>;</span>
+</span><span id=__span-1-4><a id=__codelineno-1-4 name=__codelineno-1-4 href=#__codelineno-1-4></a>
+</span><span id=__span-1-5><a id=__codelineno-1-5 name=__codelineno-1-5 href=#__codelineno-1-5></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>GameUI</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>MessageAwareComponent</span>
+</span><span id=__span-1-6><a id=__codelineno-1-6 name=__codelineno-1-6 href=#__codelineno-1-6></a><span class=p>{</span>
+</span><span id=__span-1-7><a id=__codelineno-1-7 name=__codelineno-1-7 href=#__codelineno-1-7></a><span class=w>    </span><span class=c1>// Assume this references a Player GameObject</span>
+</span><span id=__span-1-8><a id=__codelineno-1-8 name=__codelineno-1-8 href=#__codelineno-1-8></a><span class=w>    </span><span class=k>public</span><span class=w> </span><span class=n>UnityEngine</span><span class=p>.</span><span class=n>GameObject</span><span class=w> </span><span class=n>playerGO</span><span class=p>;</span>
+</span><span id=__span-1-9><a id=__codelineno-1-9 name=__codelineno-1-9 href=#__codelineno-1-9></a>
+</span><span id=__span-1-10><a id=__codelineno-1-10 name=__codelineno-1-10 href=#__codelineno-1-10></a><span class=w>    </span><span class=k>protected</span><span class=w> </span><span class=k>override</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>RegisterMessageHandlers</span><span class=p>()</span>
+</span><span id=__span-1-11><a id=__codelineno-1-11 name=__codelineno-1-11 href=#__codelineno-1-11></a><span class=w>    </span><span class=p>{</span>
+</span><span id=__span-1-12><a id=__codelineno-1-12 name=__codelineno-1-12 href=#__codelineno-1-12></a><span class=w>        </span><span class=k>base</span><span class=p>.</span><span class=n>RegisterMessageHandlers</span><span class=p>();</span>
+</span><span id=__span-1-13><a id=__codelineno-1-13 name=__codelineno-1-13 href=#__codelineno-1-13></a>
+</span><span id=__span-1-14><a id=__codelineno-1-14 name=__codelineno-1-14 href=#__codelineno-1-14></a><span class=w>        </span><span class=n>_</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>Token</span><span class=p>.</span><span class=n>RegisterGameObjectTargeted</span><span class=o>&lt;</span><span class=n>Heal</span><span class=o>&gt;</span><span class=p>(</span><span class=n>playerGO</span><span class=p>,</span><span class=w> </span><span class=n>OnPlayerHealed</span><span class=p>);</span>
+</span><span id=__span-1-15><a id=__codelineno-1-15 name=__codelineno-1-15 href=#__codelineno-1-15></a><span class=w>        </span><span class=n>_</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>Token</span><span class=p>.</span><span class=n>RegisterBroadcastWithoutSource</span><span class=o>&lt;</span><span class=n>TookDamage</span><span class=o>&gt;</span><span class=p>(</span><span class=n>OnAnyDamage</span><span class=p>);</span>
+</span><span id=__span-1-16><a id=__codelineno-1-16 name=__codelineno-1-16 href=#__codelineno-1-16></a><span class=w>    </span><span class=p>}</span>
+</span><span id=__span-1-17><a id=__codelineno-1-17 name=__codelineno-1-17 href=#__codelineno-1-17></a>
+</span><span id=__span-1-18><a id=__codelineno-1-18 name=__codelineno-1-18 href=#__codelineno-1-18></a><span class=w>    </span><span class=k>private</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>OnPlayerHealed</span><span class=p>(</span><span class=k>ref</span><span class=w> </span><span class=n>Heal</span><span class=w> </span><span class=n>m</span><span class=p>)</span><span class=w> </span><span class=o>=&gt;</span><span class=w> </span><span class=n>UpdateHealthBar</span><span class=p>(</span><span class=n>m</span><span class=p>.</span><span class=n>amount</span><span class=p>);</span>
+</span><span id=__span-1-19><a id=__codelineno-1-19 name=__codelineno-1-19 href=#__codelineno-1-19></a><span class=w>    </span><span class=k>private</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>OnAnyDamage</span><span class=p>(</span><span class=n>InstanceId</span><span class=w> </span><span class=n>source</span><span class=p>,</span><span class=w> </span><span class=n>TookDamage</span><span class=w> </span><span class=n>m</span><span class=p>)</span><span class=w> </span><span class=o>=&gt;</span><span class=w> </span><span class=n>ShowDamageEffect</span><span class=p>(</span><span class=n>source</span><span class=p>);</span>
+</span><span id=__span-1-20><a id=__codelineno-1-20 name=__codelineno-1-20 href=#__codelineno-1-20></a><span class=p>}</span>
+</span></code></pre></div> <ol> <li>Send a message</li> </ol> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-2-1><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a><span class=kt>var</span><span class=w> </span><span class=n>heal</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=w> </span><span class=n>Heal</span><span class=p>(</span><span class=mi>10</span><span class=p>);</span>
+</span><span id=__span-2-2><a id=__codelineno-2-2 name=__codelineno-2-2 href=#__codelineno-2-2></a><span class=n>heal</span><span class=p>.</span><span class=n>EmitGameObjectTargeted</span><span class=p>(</span><span class=n>playerGameObject</span><span class=p>);</span>
+</span></code></pre></div> <h2 id=message-types>Message Types<a class=headerlink href=#message-types title="Anchor link to this section">&para;</a></h2> <h3 id=new-to-messaging-use-this-decision-tree>New to messaging? Use this decision tree<a class=headerlink href=#new-to-messaging-use-this-decision-tree title="Anchor link to this section">&para;</a></h3> <div class="language-text highlight"><span class=filename>Text Only</span><pre><span></span><code><span id=__span-3-1><a id=__codelineno-3-1 name=__codelineno-3-1 href=#__codelineno-3-1></a>Is it a global announcement? (pause, settings, scene load)
+</span><span id=__span-3-2><a id=__codelineno-3-2 name=__codelineno-3-2 href=#__codelineno-3-2></a>  -&gt; Use UNTARGETED
+</span><span id=__span-3-3><a id=__codelineno-3-3 name=__codelineno-3-3 href=#__codelineno-3-3></a>
+</span><span id=__span-3-4><a id=__codelineno-3-4 name=__codelineno-3-4 href=#__codelineno-3-4></a>Are you commanding a specific entity? (heal Player, open Chest #3)
+</span><span id=__span-3-5><a id=__codelineno-3-5 name=__codelineno-3-5 href=#__codelineno-3-5></a>  -&gt; Use TARGETED
+</span><span id=__span-3-6><a id=__codelineno-3-6 name=__codelineno-3-6 href=#__codelineno-3-6></a>
+</span><span id=__span-3-7><a id=__codelineno-3-7 name=__codelineno-3-7 href=#__codelineno-3-7></a>Is an entity announcing something happened? (Enemy died, Chest opened)
+</span><span id=__span-3-8><a id=__codelineno-3-8 name=__codelineno-3-8 href=#__codelineno-3-8></a>  -&gt; Use BROADCAST
+</span></code></pre></div> <h4 id=examples>Examples<a class=headerlink href=#examples title="Anchor link to this section">&para;</a></h4> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-4-1><a id=__codelineno-4-1 name=__codelineno-4-1 href=#__codelineno-4-1></a><span class=c1>// Untargeted: &quot;Everyone, the game paused!&quot;</span>
+</span><span id=__span-4-2><a id=__codelineno-4-2 name=__codelineno-4-2 href=#__codelineno-4-2></a><span class=na>[DxUntargetedMessage]</span>
+</span><span id=__span-4-3><a id=__codelineno-4-3 name=__codelineno-4-3 href=#__codelineno-4-3></a><span class=k>public</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>GamePaused</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=p>}</span>
+</span><span id=__span-4-4><a id=__codelineno-4-4 name=__codelineno-4-4 href=#__codelineno-4-4></a>
+</span><span id=__span-4-5><a id=__codelineno-4-5 name=__codelineno-4-5 href=#__codelineno-4-5></a><span class=c1>// Targeted: &quot;Player, heal yourself by 50!&quot;</span>
+</span><span id=__span-4-6><a id=__codelineno-4-6 name=__codelineno-4-6 href=#__codelineno-4-6></a><span class=na>[DxTargetedMessage]</span>
+</span><span id=__span-4-7><a id=__codelineno-4-7 name=__codelineno-4-7 href=#__codelineno-4-7></a><span class=k>public</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>Heal</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=k>public</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=n>amount</span><span class=p>;</span><span class=w> </span><span class=p>}</span>
+</span><span id=__span-4-8><a id=__codelineno-4-8 name=__codelineno-4-8 href=#__codelineno-4-8></a>
+</span><span id=__span-4-9><a id=__codelineno-4-9 name=__codelineno-4-9 href=#__codelineno-4-9></a><span class=c1>// Broadcast: &quot;I (Enemy #3) just died!&quot;</span>
+</span><span id=__span-4-10><a id=__codelineno-4-10 name=__codelineno-4-10 href=#__codelineno-4-10></a><span class=na>[DxBroadcastMessage]</span>
+</span><span id=__span-4-11><a id=__codelineno-4-11 name=__codelineno-4-11 href=#__codelineno-4-11></a><span class=k>public</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>EnemyDied</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=k>public</span><span class=w> </span><span class=kt>string</span><span class=w> </span><span class=n>enemyName</span><span class=p>;</span><span class=w> </span><span class=p>}</span>
+</span></code></pre></div> <p><strong>Need more detail?</strong> See the <a href=../visual-guide/ >Visual Guide</a> for additional explanations, or <a href=../../concepts/message-types/ >Message Types</a> for technical details.</p> <h2 id=common-patterns>Common Patterns<a class=headerlink href=#common-patterns title="Anchor link to this section">&para;</a></h2> <h3 id=example-use-cases>Example use cases<a class=headerlink href=#example-use-cases title="Anchor link to this section">&para;</a></h3> <ul> <li><strong>UI reacting to gameplay</strong> - Health bar updates when player takes damage (without UI knowing about Player)</li> <li><strong>Achievement systems</strong> - Track ALL kills across ALL enemies with ONE listener</li> <li><strong>Cross-system coordination</strong> - Scene transitions coordinate audio, save system, and UI automatically</li> <li><strong>Input handling</strong> - Decouple input system from player controller</li> <li><strong>Analytics</strong> - Track all events without polluting gameplay code</li> </ul> <p><strong>Want code examples?</strong> See <a href=../../guides/patterns/ >Patterns</a> for example patterns and <a href=../../concepts/listening-patterns/ >Listening Patterns</a> for additional techniques.</p> <h2 id=troubleshooting>Troubleshooting<a class=headerlink href=#troubleshooting title="Anchor link to this section">&para;</a></h2> <h3 id=my-handler-isnt-being-called>"My handler isn't being called"<a class=headerlink href=#my-handler-isnt-being-called title="Anchor link to this section">&para;</a></h3> <p>Checklist:</p> <ol> <li>Did you call <code>base.RegisterMessageHandlers()</code> first?</li> <li>Is your component enabled in the scene?</li> <li>Are you emitting to the right target? (Check GameObject vs Component)</li> <li>Check the Inspector - does the registration show up?</li> </ol> <h3 id=my-message-is-firing-twice>"My message is firing twice"<a class=headerlink href=#my-message-is-firing-twice title="Anchor link to this section">&para;</a></h3> <ul> <li>Check if you accidentally registered the same handler multiple times</li> <li>Make sure you're calling <code>base.RegisterMessageHandlers()</code> only once</li> </ul> <h3 id=i-get-a-compile-error-on-dxautoconstructor>"I get a compile error on <code>[DxAutoConstructor]</code>"<a class=headerlink href=#i-get-a-compile-error-on-dxautoconstructor title="Anchor link to this section">&para;</a></h3> <ul> <li>Did you mark the struct as <code>partial</code>? (required for code generation)</li> <li>Example: <code>public readonly partial struct MyMessage</code></li> </ul> <h3 id=which-message-type-should-i-use>"Which message type should I use"<a class=headerlink href=#which-message-type-should-i-use title="Anchor link to this section">&para;</a></h3> <ul> <li>See the decision tree in <a href=#message-types>Message Types</a> above</li> <li>When in doubt, start with <code>Broadcast</code> - it's the most flexible</li> </ul> <p><strong>Still stuck?</strong> See <a href=../../reference/troubleshooting/ >Troubleshooting</a> for the complete guide or <a href=../../reference/faq/ >FAQ</a> for common questions.</p> <h2 id=next-steps>Next Steps<a class=headerlink href=#next-steps title="Anchor link to this section">&para;</a></h2> <ul> <li><a href=../visual-guide/ >Visual Guide</a></li> <li><a href=../../reference/quick-reference/ >Quick Reference</a></li> <li><a href=../../guides/diagnostics/ >Diagnostics</a></li> <li><a href=../../concepts/interceptors-and-ordering/ >Interceptors and Ordering</a></li> </ul> <h2 id=quick-reference>Quick Reference<a class=headerlink href=#quick-reference title="Anchor link to this section">&para;</a></h2> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-5-1><a id=__codelineno-5-1 name=__codelineno-5-1 href=#__codelineno-5-1></a><span class=c1>// Listen</span>
+</span><span id=__span-5-2><a id=__codelineno-5-2 name=__codelineno-5-2 href=#__codelineno-5-2></a><span class=n>_</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>Token</span><span class=p>.</span><span class=n>RegisterBroadcastWithoutSource</span><span class=o>&lt;</span><span class=n>TookDamage</span><span class=o>&gt;</span><span class=p>(</span><span class=n>OnAnyDamage</span><span class=p>);</span>
+</span><span id=__span-5-3><a id=__codelineno-5-3 name=__codelineno-5-3 href=#__codelineno-5-3></a><span class=n>_</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>Token</span><span class=p>.</span><span class=n>RegisterGameObjectTargeted</span><span class=o>&lt;</span><span class=n>Heal</span><span class=o>&gt;</span><span class=p>(</span><span class=n>playerGO</span><span class=p>,</span><span class=w> </span><span class=n>OnPlayerHealed</span><span class=p>);</span>
+</span><span id=__span-5-4><a id=__codelineno-5-4 name=__codelineno-5-4 href=#__codelineno-5-4></a>
+</span><span id=__span-5-5><a id=__codelineno-5-5 name=__codelineno-5-5 href=#__codelineno-5-5></a><span class=c1>// Emit (broadcasts always require a source)</span>
+</span><span id=__span-5-6><a id=__codelineno-5-6 name=__codelineno-5-6 href=#__codelineno-5-6></a><span class=kt>var</span><span class=w> </span><span class=n>damage</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=w> </span><span class=n>TookDamage</span><span class=p>(</span><span class=mi>25</span><span class=p>);</span>
+</span><span id=__span-5-7><a id=__codelineno-5-7 name=__codelineno-5-7 href=#__codelineno-5-7></a><span class=n>damage</span><span class=p>.</span><span class=n>EmitGameObjectBroadcast</span><span class=p>(</span><span class=n>enemyGO</span><span class=p>);</span><span class=w>  </span><span class=c1>// enemyGO is the source</span>
+</span><span id=__span-5-8><a id=__codelineno-5-8 name=__codelineno-5-8 href=#__codelineno-5-8></a><span class=kt>var</span><span class=w> </span><span class=n>heal</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=w> </span><span class=n>Heal</span><span class=p>(</span><span class=mi>10</span><span class=p>);</span>
+</span><span id=__span-5-9><a id=__codelineno-5-9 name=__codelineno-5-9 href=#__codelineno-5-9></a><span class=n>heal</span><span class=p>.</span><span class=n>EmitGameObjectTargeted</span><span class=p>(</span><span class=n>playerGO</span><span class=p>);</span>
+</span></code></pre></div> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="January 26, 2026 18:15:02 UTC"><span class=timeago datetime=2026-01-26T18:15:02+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="January 26, 2026 18:15:02 UTC">2026-01-26</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Created> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="January 26, 2026 18:15:02 UTC"><span class=timeago datetime=2026-01-26T18:15:02+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="January 26, 2026 18:15:02 UTC">2026-01-26</span> </span> </aside> </article> </div> <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg> Back to top </button> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../quick-start/ class="md-footer__link md-footer__link--prev" aria-label="Previous: Quick Start"> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> Quick Start </div> </div> </a> <a href=../visual-guide/ class="md-footer__link md-footer__link--next" aria-label="Next: Visual Guide"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> Visual Guide </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright &copy; 2017-2026 Wallstop Studios </div> </div> <div class=md-social> <a href=https://github.com/wallstop target=_blank rel=noopener title="Wallstop Studios on GitHub" class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <div class=md-progress data-md-component=progress role=progressbar></div> <script id=__config type=application/json>{"annotate": null, "base": "../..", "features": ["announce.dismiss", "content.action.edit", "content.action.view", "content.code.annotate", "content.code.copy", "content.tabs.link", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.instant.prefetch", "navigation.instant.progress", "navigation.path", "navigation.sections", "navigation.tabs", "navigation.tabs.sticky", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script> <script src=../../assets/javascripts/bundle.79ae519e.min.js></script> <script src=../../js/timeago.min.js></script> <script src=../../js/timeago_mkdocs_material.js></script> <script src=https://unpkg.com/mermaid@11/dist/mermaid.min.js></script> <script src=../../javascripts/mermaid-config.js></script> <script src=../../javascripts/csharp-highlight.js></script> </body> </html>

package/site/getting-started/getting-started/index.html.meta ADDED Viewed

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

package/site/getting-started/getting-started.meta ADDED Viewed

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: eb19dba6b53dd2f478bfef735130c628
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData:
+  assetBundleName:
+  assetBundleVariant:

package/site/getting-started/index.html ADDED Viewed

@@ -0,0 +1,29 @@
+<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="High-performance type-safe messaging library for Unity"><meta name=author content="Wallstop Studios"><link href=https://wallstop.github.io/DxMessaging/getting-started/ rel=canonical><link rel=prev href=..><link href=overview/ rel=next><link rel=icon href=../assets/images/favicon.png><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.7.1"><title>DxMessaging Documentation Hub - DxMessaging Documentation</title><link rel=stylesheet href=../assets/stylesheets/main.484c7ddc.min.css><link rel=stylesheet href=../assets/stylesheets/palette.ab4e12ef.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../css/timeago.css><link rel=stylesheet href=../stylesheets/extra.css><script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script></head> <body dir=ltr data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#dxmessaging-documentation-hub class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <header class="md-header md-header--shadow md-header--lifted" data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=.. title="DxMessaging Documentation" class="md-header__button md-logo" aria-label="DxMessaging Documentation" data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> DxMessaging Documentation </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> DxMessaging Documentation Hub </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> </form> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> </label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query required> <label class="md-search__icon md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </label> <nav class=md-search__options aria-label=Search> <a href=javascript:void(0) class="md-search__icon md-icon" title=Share aria-label=Share data-clipboard data-clipboard-text data-md-component=search-share tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg> </a> <button type=reset class="md-search__icon md-icon" title=Clear aria-label=Clear tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg> </button> </nav> <div class=md-search__suggest data-md-component=search-suggest></div> </form> <div class=md-search__output> <div class=md-search__scrollwrap tabindex=0 data-md-scrollfix> <div class=md-search-result data-md-component=search-result> <div class=md-search-result__meta> Initializing search </div> <ol class=md-search-result__list role=presentation></ol> </div> </div> </div> </div> </div> <div class=md-header__source> <a href=https://github.com/wallstop/DxMessaging title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </div> <div class=md-source__repository> wallstop/DxMessaging </div> </a> </div> </nav> <nav class=md-tabs aria-label=Tabs data-md-component=tabs> <div class=md-grid> <ul class=md-tabs__list> <li class=md-tabs__item> <a href=.. class=md-tabs__link> Home </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href=./ class=md-tabs__link> Getting Started </a> </li> <li class=md-tabs__item> <a href=../concepts/message-types/ class=md-tabs__link> Concepts </a> </li> <li class=md-tabs__item> <a href=../guides/patterns/ class=md-tabs__link> Guides </a> </li> <li class=md-tabs__item> <a href=../architecture/design-and-architecture/ class=md-tabs__link> Architecture </a> </li> <li class=md-tabs__item> <a href=../advanced/emit-shorthands/ class=md-tabs__link> Advanced </a> </li> <li class=md-tabs__item> <a href=../integrations/ class=md-tabs__link> Integrations </a> </li> <li class=md-tabs__item> <a href=../examples/end-to-end/ class=md-tabs__link> Examples </a> </li> <li class=md-tabs__item> <a href=../reference/reference/ class=md-tabs__link> Reference </a> </li> </ul> </div> </nav> </header> <div class=md-container data-md-component=container> <main class=md-main data-md-component=main> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component=sidebar data-md-type=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary md-nav--lifted" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=.. title="DxMessaging Documentation" class="md-nav__button md-logo" aria-label="DxMessaging Documentation" data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg> </a> DxMessaging Documentation </label> <div class=md-nav__source> <a href=https://github.com/wallstop/DxMessaging title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </div> <div class=md-source__repository> wallstop/DxMessaging </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=.. class=md-nav__link> <span class=md-ellipsis> Home </span> </a> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_2 checked> <div class="md-nav__link md-nav__container"> <a href=./ class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> Getting Started </span> </a> <label class="md-nav__link md-nav__link--active" for=__nav_2 id=__nav_2_label tabindex> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_2_label aria-expanded=true> <label class=md-nav__title for=__nav_2> <span class="md-nav__icon md-icon"></span> Getting Started </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=overview/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <li class=md-nav__item> <a href=install/ class=md-nav__link> <span class=md-ellipsis> Installation </span> </a> </li> <li class=md-nav__item> <a href=quick-start/ class=md-nav__link> <span class=md-ellipsis> Quick Start </span> </a> </li> <li class=md-nav__item> <a href=getting-started/ class=md-nav__link> <span class=md-ellipsis> Getting Started Guide </span> </a> </li> <li class=md-nav__item> <a href=visual-guide/ class=md-nav__link> <span class=md-ellipsis> Visual Guide </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_3> <label class=md-nav__link for=__nav_3 id=__nav_3_label tabindex=0> <span class=md-ellipsis> Concepts </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_3_label aria-expanded=false> <label class=md-nav__title for=__nav_3> <span class="md-nav__icon md-icon"></span> Concepts </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../concepts/message-types/ class=md-nav__link> <span class=md-ellipsis> Message Types </span> </a> </li> <li class=md-nav__item> <a href=../concepts/listening-patterns/ class=md-nav__link> <span class=md-ellipsis> Listening Patterns </span> </a> </li> <li class=md-nav__item> <a href=../concepts/targeting-and-context/ class=md-nav__link> <span class=md-ellipsis> Targeting & Context </span> </a> </li> <li class=md-nav__item> <a href=../concepts/interceptors-and-ordering/ class=md-nav__link> <span class=md-ellipsis> Interceptors & Ordering </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4> <label class=md-nav__link for=__nav_4 id=__nav_4_label tabindex=0> <span class=md-ellipsis> Guides </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4> <span class="md-nav__icon md-icon"></span> Guides </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../guides/patterns/ class=md-nav__link> <span class=md-ellipsis> Patterns </span> </a> </li> <li class=md-nav__item> <a href=../guides/unity-integration/ class=md-nav__link> <span class=md-ellipsis> Unity Integration </span> </a> </li> <li class=md-nav__item> <a href=../guides/testing/ class=md-nav__link> <span class=md-ellipsis> Testing </span> </a> </li> <li class=md-nav__item> <a href=../guides/diagnostics/ class=md-nav__link> <span class=md-ellipsis> Diagnostics </span> </a> </li> <li class=md-nav__item> <a href=../guides/advanced/ class=md-nav__link> <span class=md-ellipsis> Advanced Topics </span> </a> </li> <li class=md-nav__item> <a href=../guides/migration-guide/ class=md-nav__link> <span class=md-ellipsis> Migration Guide </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5> <label class=md-nav__link for=__nav_5 id=__nav_5_label tabindex=0> <span class=md-ellipsis> Architecture </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_5_label aria-expanded=false> <label class=md-nav__title for=__nav_5> <span class="md-nav__icon md-icon"></span> Architecture </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../architecture/design-and-architecture/ class=md-nav__link> <span class=md-ellipsis> Design & Architecture </span> </a> </li> <li class=md-nav__item> <a href=../architecture/comparisons/ class=md-nav__link> <span class=md-ellipsis> Comparisons </span> </a> </li> <li class=md-nav__item> <a href=../architecture/performance/ class=md-nav__link> <span class=md-ellipsis> Performance </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6> <label class=md-nav__link for=__nav_6 id=__nav_6_label tabindex=0> <span class=md-ellipsis> Advanced </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_6_label aria-expanded=false> <label class=md-nav__title for=__nav_6> <span class="md-nav__icon md-icon"></span> Advanced </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../advanced/emit-shorthands/ class=md-nav__link> <span class=md-ellipsis> Emit Shorthands </span> </a> </li> <li class=md-nav__item> <a href=../advanced/message-bus-providers/ class=md-nav__link> <span class=md-ellipsis> Message Bus Providers </span> </a> </li> <li class=md-nav__item> <a href=../advanced/registration-builders/ class=md-nav__link> <span class=md-ellipsis> Registration Builders </span> </a> </li> <li class=md-nav__item> <a href=../advanced/runtime-configuration/ class=md-nav__link> <span class=md-ellipsis> Runtime Configuration </span> </a> </li> <li class=md-nav__item> <a href=../advanced/string-messages/ class=md-nav__link> <span class=md-ellipsis> String Messages </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_7> <div class="md-nav__link md-nav__container"> <a href=../integrations/ class="md-nav__link "> <span class=md-ellipsis> Integrations </span> </a> <label class="md-nav__link " for=__nav_7 id=__nav_7_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_7_label aria-expanded=false> <label class=md-nav__title for=__nav_7> <span class="md-nav__icon md-icon"></span> Integrations </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../integrations/vcontainer/ class=md-nav__link> <span class=md-ellipsis> VContainer </span> </a> </li> <li class=md-nav__item> <a href=../integrations/zenject/ class=md-nav__link> <span class=md-ellipsis> Zenject </span> </a> </li> <li class=md-nav__item> <a href=../integrations/reflex/ class=md-nav__link> <span class=md-ellipsis> Reflex </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_8> <label class=md-nav__link for=__nav_8 id=__nav_8_label tabindex=0> <span class=md-ellipsis> Examples </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_8_label aria-expanded=false> <label class=md-nav__title for=__nav_8> <span class="md-nav__icon md-icon"></span> Examples </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../examples/end-to-end/ class=md-nav__link> <span class=md-ellipsis> End-to-End </span> </a> </li> <li class=md-nav__item> <a href=../examples/end-to-end-scene-transitions/ class=md-nav__link> <span class=md-ellipsis> Scene Transitions </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_9> <label class=md-nav__link for=__nav_9 id=__nav_9_label tabindex=0> <span class=md-ellipsis> Reference </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_9_label aria-expanded=false> <label class=md-nav__title for=__nav_9> <span class="md-nav__icon md-icon"></span> Reference </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../reference/reference/ class=md-nav__link> <span class=md-ellipsis> API Reference (Practical) </span> </a> </li> <li class=md-nav__item> <a href=../reference/quick-reference/ class=md-nav__link> <span class=md-ellipsis> Quick Reference </span> </a> </li> <li class=md-nav__item> <a href=../reference/helpers/ class=md-nav__link> <span class=md-ellipsis> Helpers </span> </a> </li> <li class=md-nav__item> <a href=../reference/faq/ class=md-nav__link> <span class=md-ellipsis> FAQ </span> </a> </li> <li class=md-nav__item> <a href=../reference/glossary/ class=md-nav__link> <span class=md-ellipsis> Glossary </span> </a> </li> <li class=md-nav__item> <a href=../reference/troubleshooting/ class=md-nav__link> <span class=md-ellipsis> Troubleshooting </span> </a> </li> <li class=md-nav__item> <a href=../reference/compatibility/ class=md-nav__link> <span class=md-ellipsis> Compatibility </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=sidebar data-md-type=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#visual-documentation-map class=md-nav__link> <span class=md-ellipsis> Visual Documentation Map </span> </a> </li> <li class=md-nav__item> <a href=#table-of-contents class=md-nav__link> <span class=md-ellipsis> Table of Contents </span> </a> </li> <li class=md-nav__item> <a href=#new-to-dxmessaging class=md-nav__link> <span class=md-ellipsis> New to DxMessaging </span> </a> </li> <li class=md-nav__item> <a href=#learning-path class=md-nav__link> <span class=md-ellipsis> Learning Path </span> </a> <nav class=md-nav aria-label="Learning Path"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#for-absolute-beginners-never-used-messaging-before class=md-nav__link> <span class=md-ellipsis> For Absolute Beginners (Never Used Messaging Before) </span> </a> </li> <li class=md-nav__item> <a href=#for-advanced-users class=md-nav__link> <span class=md-ellipsis> For Advanced Users </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#core-documentation class=md-nav__link> <span class=md-ellipsis> Core Documentation </span> </a> <nav class=md-nav aria-label="Core Documentation"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#essentials class=md-nav__link> <span class=md-ellipsis> Essentials </span> </a> </li> <li class=md-nav__item> <a href=#core-concepts class=md-nav__link> <span class=md-ellipsis> Core Concepts </span> </a> </li> <li class=md-nav__item> <a href=#unity-integration class=md-nav__link> <span class=md-ellipsis> Unity Integration </span> </a> </li> <li class=md-nav__item> <a href=#architecture--performance class=md-nav__link> <span class=md-ellipsis> Architecture &amp; Performance </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#reference class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> <nav class=md-nav aria-label=Reference> <ul class=md-nav__list> <li class=md-nav__item> <a href=#quick-lookups class=md-nav__link> <span class=md-ellipsis> Quick Lookups </span> </a> </li> <li class=md-nav__item> <a href=#tools--utilities class=md-nav__link> <span class=md-ellipsis> Tools &amp; Utilities </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#examples-and-samples class=md-nav__link> <span class=md-ellipsis> Examples and Samples </span> </a> <nav class=md-nav aria-label="Examples and Samples"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#unity-samples-importable class=md-nav__link> <span class=md-ellipsis> Unity Samples (Importable!) </span> </a> </li> <li class=md-nav__item> <a href=#code-examples-in-docs class=md-nav__link> <span class=md-ellipsis> Code Examples (In Docs) </span> </a> </li> <li class=md-nav__item> <a href=#real-world-patterns class=md-nav__link> <span class=md-ellipsis> Real-World Patterns </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#by-use-case class=md-nav__link> <span class=md-ellipsis> By Use Case </span> </a> <nav class=md-nav aria-label="By Use Case"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#i-want-to class=md-nav__link> <span class=md-ellipsis> "I want to..." </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#visual-message-pipeline class=md-nav__link> <span class=md-ellipsis> Visual: Message Pipeline </span> </a> </li> <li class=md-nav__item> <a href=#learning-resources class=md-nav__link> <span class=md-ellipsis> Learning Resources </span> </a> <nav class=md-nav aria-label="Learning Resources"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#must-read-docs-in-order class=md-nav__link> <span class=md-ellipsis> Must-Read Docs (In Order) </span> </a> </li> <li class=md-nav__item> <a href=#feature-specific class=md-nav__link> <span class=md-ellipsis> Feature-Specific </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#comparison-charts class=md-nav__link> <span class=md-ellipsis> Comparison Charts </span> </a> <nav class=md-nav aria-label="Comparison Charts"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#dxmessaging-vs-alternatives class=md-nav__link> <span class=md-ellipsis> DxMessaging vs Alternatives </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#search-by-topic class=md-nav__link> <span class=md-ellipsis> Search by Topic </span> </a> <nav class=md-nav aria-label="Search by Topic"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#concepts class=md-nav__link> <span class=md-ellipsis> Concepts </span> </a> </li> <li class=md-nav__item> <a href=#features class=md-nav__link> <span class=md-ellipsis> Features </span> </a> </li> <li class=md-nav__item> <a href=#components class=md-nav__link> <span class=md-ellipsis> Components </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#complete-document-list class=md-nav__link> <span class=md-ellipsis> Complete Document List </span> </a> <nav class=md-nav aria-label="Complete Document List"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#getting-started class=md-nav__link> <span class=md-ellipsis> Getting Started </span> </a> </li> <li class=md-nav__item> <a href=#core-concepts_1 class=md-nav__link> <span class=md-ellipsis> Core Concepts </span> </a> </li> <li class=md-nav__item> <a href=#unity class=md-nav__link> <span class=md-ellipsis> Unity </span> </a> </li> <li class=md-nav__item> <a href=#deep-dives class=md-nav__link> <span class=md-ellipsis> Deep Dives </span> </a> </li> <li class=md-nav__item> <a href=#reference_1 class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=#dependency-injection class=md-nav__link> <span class=md-ellipsis> Dependency Injection </span> </a> </li> <li class=md-nav__item> <a href=#miscellaneous class=md-nav__link> <span class=md-ellipsis> Miscellaneous </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#quick-start-path class=md-nav__link> <span class=md-ellipsis> Quick Start Path </span> </a> </li> </ul> </nav> </div> </div> </div> <div class=md-content data-md-component=content> <nav class=md-path aria-label=Navigation> <ol class=md-path__list> <li class=md-path__item> <a href=.. class=md-path__link> <span class=md-ellipsis> Home </span> </a> </li> <li class=md-path__item> <a href=./ class=md-path__link> <span class=md-ellipsis> Getting Started </span> </a> </li> </ol> </nav> <article class="md-content__inner md-typeset"> <a href=https://github.com/wallstop/DxMessaging/edit/master/docs/getting-started/index.md title="Edit this page" class="md-content__button md-icon" rel=edit> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg> </a> <a href=https://github.com/wallstop/DxMessaging/raw/master/docs/getting-started/index.md title="View source of this page" class="md-content__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg> </a> <h1 id=dxmessaging-documentation-hub>DxMessaging Documentation Hub<a class=headerlink href=#dxmessaging-documentation-hub title="Anchor link to this section">&para;</a></h1> <p>This is the documentation for DxMessaging, a type-safe messaging system for Unity.</p> <h2 id=visual-documentation-map>Visual Documentation Map<a class=headerlink href=#visual-documentation-map title="Anchor link to this section">&para;</a></h2> <pre class=mermaid><code>%%{init: {'theme': 'neutral'}}%%
+graph TD
+    Start[START HERE&lt;br/&gt;Visual Guide&lt;br/&gt;5 minutes]
+    Start --&gt; Quick[Quick Start&lt;br/&gt;5 min]
+    Start --&gt; Getting[Getting Started&lt;br/&gt;10 min]
+    Start --&gt; Overview[Overview&lt;br/&gt;5 min]
+    Quick --&gt; Patterns[Patterns &amp; Samples&lt;br/&gt;Hands-on!]
+    Getting --&gt; Patterns
+    Overview --&gt; 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</code></pre> <h2 id=table-of-contents>Table of Contents<a class=headerlink href=#table-of-contents title="Anchor link to this section">&para;</a></h2> <ul> <li><a href=#new-to-dxmessaging>New to DxMessaging</a></li> <li><a href=#learning-path>Learning Path</a></li> <li><a href=#core-documentation>Core Documentation</a></li> <li><a href=#reference>Reference</a></li> <li><a href=#examples-and-samples>Examples and Samples</a></li> <li><a href=#by-use-case>By Use Case</a></li> <li><a href=#quick-start-path>Quick Start Path</a></li> </ul> <hr> <h2 id=new-to-dxmessaging>New to DxMessaging<a class=headerlink href=#new-to-dxmessaging title="Anchor link to this section">&para;</a></h2> <p><strong>Never used a messaging system before?</strong> Start here:</p> <ol> <li><strong><a href=visual-guide/ >Visual Guide</a></strong> - Beginner-friendly visual introduction (5 min)</li> <li><strong><a href=getting-started/ >Getting Started Guide</a></strong> - Comprehensive guide with examples (10 min)</li> <li><strong><a href=quick-start/ >Quick Start</a></strong> - Your first working message (5 min)</li> <li><strong><a href=overview/ >Overview</a></strong> - What DxMessaging is and why it exists (5 min)</li> </ol> <h2 id=learning-path>Learning Path<a class=headerlink href=#learning-path title="Anchor link to this section">&para;</a></h2> <h3 id=for-absolute-beginners-never-used-messaging-before>For Absolute Beginners (Never Used Messaging Before)<a class=headerlink href=#for-absolute-beginners-never-used-messaging-before title="Anchor link to this section">&para;</a></h3> <ol> <li>Read <a href=visual-guide/ >Visual Guide</a> (5 min) - Pictures and analogies!</li> <li>Read <a href=getting-started/ >Getting Started</a> (10 min) - Complete introduction</li> <li>Try <a href=quick-start/ >Quick Start</a> (5 min) - Hands-on tutorial</li> <li>Understand <a href=../concepts/message-types/ >Message Types</a> (10 min) - When to use what</li> <li>Study <a href=../guides/patterns/ >Common Patterns</a> (15 min) - Real examples</li> </ol> <h3 id=for-advanced-users>For Advanced Users<a class=headerlink href=#for-advanced-users title="Anchor link to this section">&para;</a></h3> <ol> <li>Master <a href=../concepts/interceptors-and-ordering/ >Interceptors &amp; Ordering</a></li> <li>Explore <a href=../concepts/listening-patterns/ >Listening Patterns</a></li> <li>Deep dive into <a href=../architecture/design-and-architecture/ >Design &amp; Architecture</a></li> <li>Review <a href=../guides/advanced/ >Advanced Topics</a></li> </ol> <h2 id=core-documentation>Core Documentation<a class=headerlink href=#core-documentation title="Anchor link to this section">&para;</a></h2> <h3 id=essentials>Essentials<a class=headerlink href=#essentials title="Anchor link to this section">&para;</a></h3> <ul> <li><strong><a href=visual-guide/ >Visual Guide</a></strong> - Beginner-friendly visual introduction with pictures and analogies</li> <li><strong><a href=getting-started/ >Getting Started</a></strong> - Complete beginner's guide with mental models</li> <li><strong><a href=overview/ >Overview</a></strong> - What and why</li> <li><strong><a href=quick-start/ >Quick Start</a></strong> - First message in 5 minutes</li> <li><strong><a href=../concepts/message-types/ >Message Types</a></strong> - When to use Untargeted/Targeted/Broadcast</li> <li><strong><a href=../architecture/comparisons/ >Comparisons</a></strong> - DxMessaging vs C# Events, UnityEvents, SendMessage</li> </ul> <h3 id=core-concepts>Core Concepts<a class=headerlink href=#core-concepts title="Anchor link to this section">&para;</a></h3> <ul> <li><strong><a href=../concepts/interceptors-and-ordering/ >Interceptors &amp; Ordering</a></strong> - Validate, transform, control execution</li> <li><strong><a href=../concepts/listening-patterns/ >Listening Patterns</a></strong> - All the ways to receive messages</li> <li><strong><a href=../concepts/targeting-and-context/ >Targeting &amp; Context</a></strong> - GameObject vs Component</li> <li><strong><a href=../guides/patterns/ >Patterns</a></strong> - Real-world usage patterns</li> </ul> <h3 id=unity-integration>Unity Integration<a class=headerlink href=#unity-integration title="Anchor link to this section">&para;</a></h3> <ul> <li><strong><a href=../guides/unity-integration/ >Unity Integration</a></strong> - MessagingComponent, MessageAwareComponent</li> <li><strong><a href=../guides/diagnostics/ >Diagnostics</a></strong> - Inspector tools, debugging, observability</li> </ul> <h3 id=architecture--performance>Architecture &amp; Performance<a class=headerlink href=#architecture--performance title="Anchor link to this section">&para;</a></h3> <ul> <li><strong><a href=../architecture/design-and-architecture/ >Design &amp; Architecture</a></strong> - Deep dive into internals and optimizations</li> <li><strong><a href=../architecture/performance/ >Performance Benchmarks</a></strong> - OS-specific tables auto-generated by tests</li> <li><strong><a href=../guides/advanced/ >Advanced</a></strong> - Lifecycles, safety, manual control</li> </ul> <h2 id=reference>Reference<a class=headerlink href=#reference title="Anchor link to this section">&para;</a></h2> <h3 id=quick-lookups>Quick Lookups<a class=headerlink href=#quick-lookups title="Anchor link to this section">&para;</a></h3> <ul> <li><strong><a href=../reference/glossary/ >Glossary</a></strong> - All terms explained in plain English</li> <li><strong><a href=../reference/quick-reference/ >Quick Reference</a></strong> - API cheat sheet</li> <li><strong><a href=../reference/reference/ >API Reference</a></strong> - Complete API documentation</li> <li><strong><a href=../reference/faq/ >FAQ</a></strong> - Common questions</li> <li><strong><a href=../reference/troubleshooting/ >Troubleshooting</a></strong> - Solving common issues</li> </ul> <h3 id=tools--utilities>Tools &amp; Utilities<a class=headerlink href=#tools--utilities title="Anchor link to this section">&para;</a></h3> <ul> <li><strong><a href=../reference/helpers/ >Helpers</a></strong> - Source generators, attributes, extensions</li> <li><strong><a href=../advanced/message-bus-providers/ >Message Bus Providers</a></strong> - Provider system and MessageBusProviderHandle for flexible bus configuration</li> <li><strong><a href=../advanced/runtime-configuration/ >Runtime Configuration</a></strong> - Setting message buses at runtime, re-binding registrations</li> <li><strong><a href=../advanced/registration-builders/ >Registration Builders</a></strong> - Fluent API for building message registrations</li> <li><strong><a href=../advanced/emit-shorthands/ >Emit Shorthands</a></strong> - <code>Emit</code>/<code>EmitAt</code>/<code>EmitFrom</code> usage and pitfalls</li> <li><strong><a href=../advanced/string-messages/ >String Messages</a></strong> - Prototyping and debugging</li> <li><strong><a href=../reference/compatibility/ >Compatibility</a></strong> - Unity versions and render pipelines</li> <li><strong><a href=install/ >Install</a></strong> - Installation guide</li> </ul> <h2 id=examples-and-samples>Examples and Samples<a class=headerlink href=#examples-and-samples title="Anchor link to this section">&para;</a></h2> <h3 id=unity-samples-importable>Unity Samples (Importable!)<a class=headerlink href=#unity-samples-importable title="Anchor link to this section">&para;</a></h3> <p><strong>Located in <code>Samples~/</code> directory</strong> - Import via Unity Package Manager!</p> <ul> <li><strong><a href=https://github.com/wallstop/DxMessaging/blob/master/Samples~/Mini%20Combat/README.md>Mini Combat</a></strong> - Interactive combat demo with Heal/Damage messages</li> <li>Perfect first example to understand message flow</li> <li>Shows Targeted and Broadcast messages in action</li> <li> <p>Complete working scene you can play with</p> </li> <li> <p><strong><a href=https://github.com/wallstop/DxMessaging/blob/master/Samples~/UI%20Buttons%20%2B%20Inspector/README.md>UI Buttons + Inspector</a></strong> - Interactive diagnostics demo</p> </li> <li>See the Inspector diagnostics in action</li> <li>Explore message history and handler registrations</li> <li>Great for debugging and understanding the system</li> </ul> <h3 id=code-examples-in-docs>Code Examples (In Docs)<a class=headerlink href=#code-examples-in-docs title="Anchor link to this section">&para;</a></h3> <ul> <li><strong><a href=../examples/end-to-end/ >End-to-End Example</a></strong> - Complete feature walkthrough</li> <li><strong><a href=../examples/end-to-end-scene-transitions/ >Scene Transitions Example</a></strong> - Scene management pattern</li> </ul> <h3 id=real-world-patterns>Real-World Patterns<a class=headerlink href=#real-world-patterns title="Anchor link to this section">&para;</a></h3> <p>From <a href=../guides/patterns/ >Common Patterns</a>:</p> <ul> <li>Scene-wide events (Untargeted)</li> <li>Directed commands (Targeted)</li> <li>Observability (Broadcast)</li> <li>Validation with Interceptors</li> <li>Analytics with Post-Processors</li> <li>Local bus islands for testing</li> </ul> <h2 id=by-use-case>By Use Case<a class=headerlink href=#by-use-case title="Anchor link to this section">&para;</a></h2> <h3 id=i-want-to>"I want to..."<a class=headerlink href=#i-want-to title="Anchor link to this section">&para;</a></h3> <ul> <li><strong>Decouple my systems</strong> - Start with <a href=getting-started/ >Getting Started</a></li> <li><strong>Replace C# events</strong> - See <a href=../architecture/comparisons/ >Comparisons</a></li> <li><strong>Send a command to one object</strong> - Use <a href=../concepts/message-types/#targeted-messages>Targeted Messages</a></li> <li><strong>Broadcast an event</strong> - Use <a href=../concepts/message-types/#broadcast-messages>Broadcast Messages</a></li> <li><strong>Notify globally</strong> - Use <a href=../concepts/message-types/#untargeted-messages>Untargeted Messages</a></li> <li><strong>Validate messages before execution</strong> - Learn <a href=../concepts/interceptors-and-ordering/ >Interceptors</a></li> <li><strong>Track all damage/events</strong> - See <a href=../concepts/listening-patterns/ >Listening Without Context</a></li> <li><strong>Debug message flow</strong> - Use <a href=../guides/diagnostics/ >Diagnostics</a></li> <li><strong>Optimize performance</strong> - Read <a href=../architecture/design-and-architecture/#performance-optimizations>Performance Tips</a></li> <li><strong>Isolate tests</strong> - Create <a href=../guides/patterns/#6-local-bus-islands>Local Bus Islands</a></li> <li><strong>Use dependency injection</strong> - <a href=../integrations/zenject/ >DxMessaging + Zenject</a>, <a href=../integrations/vcontainer/ >DxMessaging + VContainer</a>, <a href=../integrations/reflex/ >DxMessaging + Reflex</a></li> <li><strong>Configure buses at runtime</strong> - See <a href=../advanced/runtime-configuration/ >Runtime Configuration</a></li> <li><strong>Use message bus providers</strong> - Learn <a href=../advanced/message-bus-providers/ >Message Bus Providers</a></li> </ul> <h2 id=visual-message-pipeline>Visual: Message Pipeline<a class=headerlink href=#visual-message-pipeline title="Anchor link to this section">&para;</a></h2> <p>Every message flows through 3 stages:</p> <pre class=mermaid><code>%%{init: {'theme': 'neutral'}}%%
+flowchart LR
+    P[Producer] --&gt; I[Interceptors&lt;br/&gt;validate/mutate/cancel]
+    I --&gt; H[Handlers&lt;br/&gt;main logic by priority]
+    H --&gt; PP[Post-Processors&lt;br/&gt;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</code></pre> <h2 id=learning-resources>Learning Resources<a class=headerlink href=#learning-resources title="Anchor link to this section">&para;</a></h2> <h3 id=must-read-docs-in-order>Must-Read Docs (In Order)<a class=headerlink href=#must-read-docs-in-order title="Anchor link to this section">&para;</a></h3> <ol> <li><strong><a href=getting-started/ >Getting Started</a></strong> - Start here! (10 min)</li> <li><strong><a href=../concepts/message-types/ >Message Types</a></strong> - Choose the right type (10 min)</li> <li><strong><a href=../guides/patterns/ >Patterns</a></strong> - See real examples (15 min)</li> <li><strong><a href=../guides/diagnostics/ >Diagnostics</a></strong> - Debug like a pro (10 min)</li> <li><strong><a href=../architecture/design-and-architecture/ >Design &amp; Architecture</a></strong> - Understand the internals (30 min)</li> </ol> <h3 id=feature-specific>Feature-Specific<a class=headerlink href=#feature-specific title="Anchor link to this section">&para;</a></h3> <ul> <li><strong>Priority &amp; Ordering</strong> - <a href=../concepts/interceptors-and-ordering/ >Interceptors &amp; Ordering</a></li> <li><strong>Global Observers</strong> - <a href=../concepts/listening-patterns/ >Listening Patterns</a></li> <li><strong>Unity Lifecycle</strong> - <a href=../guides/unity-integration/ >Unity Integration</a></li> <li><strong>Performance</strong> - <a href=../architecture/design-and-architecture/ >Design &amp; Architecture</a></li> </ul> <h2 id=comparison-charts>Comparison Charts<a class=headerlink href=#comparison-charts title="Anchor link to this section">&para;</a></h2> <h3 id=dxmessaging-vs-alternatives>DxMessaging vs Alternatives<a class=headerlink href=#dxmessaging-vs-alternatives title="Anchor link to this section">&para;</a></h3> <p>From <a href=../architecture/comparisons/ >Comparisons</a>:</p> <table> <thead> <tr> <th>Feature</th> <th>DxMessaging</th> <th>C# Events</th> <th>UnityEvents</th> <th>Static Bus</th> </tr> </thead> <tbody> <tr> <td>Decoupling</td> <td>Full</td> <td>Tight</td> <td>Hidden</td> <td>Yes</td> </tr> <tr> <td>Lifecycle Safety</td> <td>Auto</td> <td>Manual</td> <td>Unity</td> <td>Manual</td> </tr> <tr> <td>Execution Order</td> <td>Priority</td> <td>Random</td> <td>Random</td> <td>Random</td> </tr> <tr> <td>Observability</td> <td>Built-in</td> <td>No</td> <td>No</td> <td>No</td> </tr> <tr> <td>Performance</td> <td>Zero-alloc</td> <td>Good</td> <td>Boxing</td> <td>Good</td> </tr> </tbody> </table> <h2 id=search-by-topic>Search by Topic<a class=headerlink href=#search-by-topic title="Anchor link to this section">&para;</a></h2> <h3 id=concepts>Concepts<a class=headerlink href=#concepts title="Anchor link to this section">&para;</a></h3> <ul> <li><strong>Messages</strong> - <a href=../concepts/message-types/ >Message Types</a>, <a href=getting-started/ >Getting Started</a></li> <li><strong>Handlers</strong> - <a href=../concepts/listening-patterns/ >Listening Patterns</a>, <a href=../guides/unity-integration/ >Unity Integration</a></li> <li><strong>Lifecycle</strong> - <a href=../guides/advanced/ >Advanced</a>, <a href=../guides/unity-integration/ >Unity Integration</a></li> <li><strong>Performance</strong> - <a href=../architecture/design-and-architecture/ >Design &amp; Architecture</a></li> <li><strong>Testing</strong> - <a href=../guides/patterns/#6-local-bus-islands>Patterns</a>, <a href=../guides/testing/ >Testing Guide</a></li> </ul> <h3 id=features>Features<a class=headerlink href=#features title="Anchor link to this section">&para;</a></h3> <ul> <li><strong>Interceptors</strong> - <a href=../concepts/interceptors-and-ordering/ >Interceptors &amp; Ordering</a></li> <li><strong>Post-Processors</strong> - <a href=../concepts/interceptors-and-ordering/ >Interceptors &amp; Ordering</a></li> <li><strong>Priorities</strong> - <a href=../concepts/interceptors-and-ordering/ >Interceptors &amp; Ordering</a></li> <li><strong>Global Accept-All</strong> - <a href=../concepts/listening-patterns/ >Listening Patterns</a></li> <li><strong>Diagnostics</strong> - <a href=../guides/diagnostics/ >Diagnostics</a></li> <li><strong>Local Buses</strong> - <a href=../architecture/design-and-architecture/ >Design &amp; Architecture</a></li> </ul> <h3 id=components>Components<a class=headerlink href=#components title="Anchor link to this section">&para;</a></h3> <ul> <li><strong>MessageBus</strong> - <a href=../architecture/design-and-architecture/#the-message-bus>Design &amp; Architecture</a></li> <li><strong>MessageHandler</strong> - <a href=../reference/reference/ >API Reference</a></li> <li><strong>MessageRegistrationToken</strong> - <a href=../guides/unity-integration/ >Unity Integration</a>, <a href=../guides/advanced/ >Advanced</a></li> <li><strong>MessageAwareComponent</strong> - <a href=../guides/unity-integration/ >Unity Integration</a>, <a href=getting-started/ >Getting Started</a></li> <li><strong>MessagingComponent</strong> - <a href=../guides/unity-integration/ >Unity Integration</a></li> </ul> <h2 id=complete-document-list>Complete Document List<a class=headerlink href=#complete-document-list title="Anchor link to this section">&para;</a></h2> <h3 id=getting-started>Getting Started<a class=headerlink href=#getting-started title="Anchor link to this section">&para;</a></h3> <ul> <li><a href=visual-guide/ >Visual Guide</a> - Perfect for beginners</li> <li><a href=getting-started/ >Getting Started Guide</a></li> <li><a href=overview/ >Overview</a></li> <li><a href=quick-start/ >Quick Start</a></li> <li><a href=install/ >Install</a></li> </ul> <h3 id=core-concepts_1>Core Concepts<a class=headerlink href=#core-concepts_1 title="Anchor link to this section">&para;</a></h3> <ul> <li><a href=../concepts/message-types/ >Message Types</a></li> <li><a href=../concepts/interceptors-and-ordering/ >Interceptors &amp; Ordering</a></li> <li><a href=../concepts/listening-patterns/ >Listening Patterns</a></li> <li><a href=../concepts/targeting-and-context/ >Targeting &amp; Context</a></li> </ul> <h3 id=unity>Unity<a class=headerlink href=#unity title="Anchor link to this section">&para;</a></h3> <ul> <li><a href=../guides/unity-integration/ >Unity Integration</a></li> <li><a href=../guides/diagnostics/ >Diagnostics</a></li> <li><a href=../guides/patterns/ >Patterns</a></li> </ul> <h3 id=deep-dives>Deep Dives<a class=headerlink href=#deep-dives title="Anchor link to this section">&para;</a></h3> <ul> <li><a href=../architecture/design-and-architecture/ >Design &amp; Architecture</a></li> <li><a href=../guides/advanced/ >Advanced</a></li> <li><a href=../architecture/comparisons/ >Comparisons</a></li> </ul> <h3 id=reference_1>Reference<a class=headerlink href=#reference_1 title="Anchor link to this section">&para;</a></h3> <ul> <li><a href=../reference/quick-reference/ >Quick Reference</a></li> <li><a href=../reference/reference/ >API Reference</a></li> <li><a href=../reference/helpers/ >Helpers</a></li> <li><a href=../reference/faq/ >FAQ</a></li> <li><a href=../reference/troubleshooting/ >Troubleshooting</a></li> </ul> <h3 id=dependency-injection>Dependency Injection<a class=headerlink href=#dependency-injection title="Anchor link to this section">&para;</a></h3> <ul> <li><a href=../advanced/runtime-configuration/ >Runtime Configuration</a> - Setting and overriding message buses, re-binding registrations</li> <li><a href=../advanced/message-bus-providers/ >Message Bus Providers</a> - Provider system and MessageBusProviderHandle</li> <li><a href=../integrations/zenject/ >DxMessaging + Zenject</a> - Zenject integration guide</li> <li><a href=../integrations/vcontainer/ >DxMessaging + VContainer</a> - VContainer integration guide</li> <li><a href=../integrations/reflex/ >DxMessaging + Reflex</a> - Reflex integration guide</li> </ul> <h3 id=miscellaneous>Miscellaneous<a class=headerlink href=#miscellaneous title="Anchor link to this section">&para;</a></h3> <ul> <li><a href=../advanced/string-messages/ >String Messages</a></li> <li><a href=../reference/compatibility/ >Compatibility</a></li> <li><a href=../examples/end-to-end/ >End-to-End Example</a></li> <li><a href=../examples/end-to-end-scene-transitions/ >Scene Transitions Example</a></li> <li><a href=https://github.com/wallstop/DxMessaging/blob/master/Samples~/Mini%20Combat/README.md>Mini Combat Sample</a></li> <li><a href=https://github.com/wallstop/DxMessaging/blob/master/Samples~/UI%20Buttons%20%2B%20Inspector/README.md>UI Buttons + Inspector Sample</a></li> </ul> <hr> <h2 id=quick-start-path>Quick Start Path<a class=headerlink href=#quick-start-path title="Anchor link to this section">&para;</a></h2> <p><strong>Absolute Beginner?</strong> Follow this 30-minute path:</p> <ol> <li>5 min: <a href=visual-guide/ >Visual Guide</a> - Start here for pictures &amp; analogies!</li> <li>10 min: <a href=getting-started/ >Getting Started</a> - Deep dive</li> <li>5 min: <a href=quick-start/ >Quick Start</a> - Hands-on code</li> <li>10 min: Try a <a href=https://github.com/wallstop/DxMessaging/blob/master/Samples~/Mini%20Combat/README.md>Sample</a> - See it in action</li> </ol> <p><strong>Want to go deep?</strong> Continue with:</p> <ol> <li>15 min: <a href=../guides/patterns/ >Patterns</a></li> <li>20 min: <a href=../concepts/interceptors-and-ordering/ >Interceptors &amp; Ordering</a></li> <li>30 min: <a href=../architecture/design-and-architecture/ >Design &amp; Architecture</a></li> </ol> <hr> <p>Need help? Check <a href=../reference/faq/ >FAQ</a> or <a href=../reference/troubleshooting/ >Troubleshooting</a>.</p> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="January 26, 2026 18:15:02 UTC"><span class=timeago datetime=2026-01-26T18:15:02+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="January 26, 2026 18:15:02 UTC">2026-01-26</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Created> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="January 26, 2026 18:15:02 UTC"><span class=timeago datetime=2026-01-26T18:15:02+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="January 26, 2026 18:15:02 UTC">2026-01-26</span> </span> </aside> </article> </div> <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg> Back to top </button> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=.. class="md-footer__link md-footer__link--prev" aria-label="Previous: Home"> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> Home </div> </div> </a> <a href=overview/ class="md-footer__link md-footer__link--next" aria-label="Next: Overview"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> Overview </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright &copy; 2017-2026 Wallstop Studios </div> </div> <div class=md-social> <a href=https://github.com/wallstop target=_blank rel=noopener title="Wallstop Studios on GitHub" class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <div class=md-progress data-md-component=progress role=progressbar></div> <script id=__config type=application/json>{"annotate": null, "base": "..", "features": ["announce.dismiss", "content.action.edit", "content.action.view", "content.code.annotate", "content.code.copy", "content.tabs.link", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.instant.prefetch", "navigation.instant.progress", "navigation.path", "navigation.sections", "navigation.tabs", "navigation.tabs.sticky", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script> <script src=../assets/javascripts/bundle.79ae519e.min.js></script> <script src=../js/timeago.min.js></script> <script src=../js/timeago_mkdocs_material.js></script> <script src=https://unpkg.com/mermaid@11/dist/mermaid.min.js></script> <script src=../javascripts/mermaid-config.js></script> <script src=../javascripts/csharp-highlight.js></script> </body> </html>

package/site/getting-started/index.html.meta ADDED Viewed

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