Skip to content

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/wallstop/DxMessaging.git No
NPM Scoped Registry Add registry + resolve Yes
From Releases Download .unitypackage No
From Source Clone/download zip No
Manual (not recommended) Edit manifest.json No

Methods

The easiest way to install DxMessaging is via OpenUPM.

If you have the openupm-cli installed, run:

Bash
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:
Text Only
https://github.com/wallstop/DxMessaging.git
  • Click Add. Unity imports the package and its analyzers/generators.

NPM Scoped Registry

  1. Open Unity Package Manager
  2. (Optional) Enable Pre-release packages to get the latest, cutting-edge builds
  3. Open the Advanced Package Settings
  4. Add an entry for a new "Scoped Registry"
  5. Name: NPM
  6. URL: https://registry.npmjs.org
  7. Scope(s): com.wallstop-studios.dxmessaging
  8. Resolve the latest DxMessaging

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

From Releases

Check out the latest Releases to grab the Unity Package and import to your project.

From Source

Grab a copy of this repo (either git clone this repo or download a zip of the source) and copy the contents to your project's Assets directory.

Manual - Manifest.json (not recommended)

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

Minimum Requirements

  • Unity 2021.3+ (LTS recommended). See Compatibility for Unity × Render Pipeline support (Built‑In, URP, HDRP).

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