-
Notifications
You must be signed in to change notification settings - Fork 0
Getting Started Install
This page helps you install DxMessaging into a Unity 2021.3+ project using the Unity Package Manager (UPM).
| 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 |
The easiest way to install DxMessaging is via OpenUPM.
If you have the openupm-cli installed, run:
openupm add com.wallstop-studios.dxmessaging- 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.
- 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.
- Open Unity Package Manager
- Open the Advanced Package Settings
- Add an entry for a new "Scoped Registry"
- Name:
NPM - URL:
https://registry.npmjs.org - Scope(s):
com.wallstop-studios.dxmessaging
- Name:
- Resolve the latest
DxMessaging
Unity will notify you of version updates when using scoped registries.
Check out the latest Releases to download the npm .tgz package and checksum. Current releases do not include a .unitypackage asset.
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.dxmessagingFor 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.
- Open your project's
Packages/manifest.jsonand add:
{
"dependencies": {
"com.wallstop-studios.dxmessaging": "https://github.com/Ambiguous-Interactive/DxMessaging.git"
}
}- Unity 2021.3+ (LTS recommended). See ..-Reference-Compatibility for Unity x Render Pipeline support (Built-In, URP, HDRP).
- In your project, create a GameObject and add
MessagingComponentto start sending/receiving. - Optional: enable diagnostics in Editor from the MessagingComponent inspector to see live emissions.
- Jump to Quick-Start
- Getting-Started-Overview
- Getting-Started-Getting-Started
- Getting-Started-Install
- Getting-Started-Quick-Start
- Getting-Started-Visual-Guide
- Concepts-Message-Types
- Concepts-Listening-Patterns
- Concepts-Targeting-And-Context
- Concepts-Interceptors-And-Ordering
- Guides-Patterns
- Guides-Unity-Integration
- Guides-Testing
- Guides-Diagnostics
- Guides-Advanced
- Guides-Migration-Guide
- Advanced-Emit-Shorthands
- Advanced-Message-Bus-Providers
- Advanced-Runtime-Configuration
- Advanced-String-Messages
- Reference-Reference
- Reference-Quick-Reference
- Reference-Helpers
- Reference-Faq
- Reference-Glossary
- Reference-Troubleshooting
- Reference-Compatibility
Links