Skip to content

Getting Started Install

github-actions[bot] edited this page Jun 3, 2026 · 4 revisions

Install (Unity UPM)

This page helps you install DxMessaging into a Unity 2021.3+ project using the Unity Package Manager (UPM).

Quick Reference

Method Command/URL Auto-Updates
OpenUPM (Recommended) openupm add com.wallstop-studios.dxmessaging Yes
Git URL https://github.com/Ambiguous-Interactive/DxMessaging.git No
NPM Scoped Registry Add registry + resolve Yes
From Releases Download npm .tgz No
From Source Clone/download zip No
Manual (not recommended) Edit manifest.json No

Methods

OpenUPM (Recommended)

The easiest way to install DxMessaging is via OpenUPM.

If you have the openupm-cli installed, run:

openupm add com.wallstop-studios.dxmessaging

Benefits of OpenUPM

  • Automatic update notifications in Unity Package Manager
  • Easy dependency management
  • Simple one-command installation
  • Version history and changelogs available on the OpenUPM page

Don't want to install the CLI? You can also add OpenUPM as a scoped registry manually.

Git URL

  • Unity Package Manager > Add package from git URL...
  • Paste:
https://github.com/Ambiguous-Interactive/DxMessaging.git
  • Click Add. Unity imports the package and its analyzers/generators.

NPM Scoped Registry

  1. Open Unity Package Manager
  2. Open the Advanced Package Settings
  3. Add an entry for a new "Scoped Registry"
    • Name: NPM
    • URL: https://registry.npmjs.org
    • Scope(s): com.wallstop-studios.dxmessaging
  4. Resolve the latest DxMessaging

Unity will notify you of version updates when using scoped registries.

From Releases

Check out the latest Releases to download the npm .tgz package and checksum. Current releases do not include a .unitypackage asset.

From Source

Embed the package under your Unity project's Packages directory, preserving the package manifest and analyzer layout:

git clone https://github.com/Ambiguous-Interactive/DxMessaging.git Packages/com.wallstop-studios.dxmessaging

For ZIP downloads, extract the repository contents into Packages/com.wallstop-studios.dxmessaging. Do not copy the package into Assets; that bypasses Unity Package Manager behavior.

Manual - Manifest.json (not recommended)

  • Open your project's Packages/manifest.json and add:
{
  "dependencies": {
    "com.wallstop-studios.dxmessaging": "https://github.com/Ambiguous-Interactive/DxMessaging.git"
  }
}

Minimum Requirements

After Installation

  • In your project, create a GameObject and add MessagingComponent to start sending/receiving.
  • Optional: enable diagnostics in Editor from the MessagingComponent inspector to see live emissions.
  • Jump to Quick-Start

Clone this wiki locally