@automation-room-control/node-red-arc 1.0.0
Node-RED nodes for ARC: monitor game activity and trigger actions.
@automation-room-control/node-red-arc
Node-RED nodes for Automation Room Control (ARC). Use them to trigger ARC controls from flows and listen for game state, timer, and objective progress.
Requirements
- Node-RED 2.0+
- ARC Software reachable on the same network
- ARC connection
node-redenabled in Settings -> Connections
Install
cd ~/.node-red
npm install @automation-room-control/node-red-arc
Restart Node-RED after install.
Quick Start
- Add an ARC Config node. It defaults to
arc.local; change the host only if you need an IP address. - Use Test connection in the config node.
- Add ARC Control to run an ARC action from a Node-RED flow.
- Add ARC Timer, ARC State, or ARC Objective when a flow needs to react to live ARC activity.
- Deploy.
Nodes
| Node | What it does |
|---|---|
| ARC Config | Shared ARC connection settings. The port is fixed at 1183. |
| ARC Control | Runs game actions, objective actions, hint actions, display messages, display commands, or variable actions. |
| ARC Timer | Emits timer updates every N seconds or at selected thresholds. |
| ARC State | Emits selected game state changes. |
| ARC Objective | Emits simple objective triggers: all completed, selected objective completed, bypassed, or reset. |
The editor loads metadata from ARC, so games, objectives, displays, hints, and variables are selected from dropdowns instead of typed manually. Saved IDs are preserved if ARC is offline while editing.
ARC Control
ARC Control is the main output node. Pick a game, choose a control type, then choose the action from ARC-backed dropdowns.
Supported control types:
- Game action: start, pause, resume, adjust time, request help, end, success, or failure.
- Objective action: complete, bypass, or reset.
- Hint action: send a configured objective hint.
- Display message.
- Display command: clear, refresh, pause, resume, skip, reset overlay, alert, ambient audio, volume, or audio reset.
- Variable action: set, adjust, toggle, or reset a game variable.
The top-level control type list is the package's set of ARC categories. The choices inside the ARC-backed categories, such as objectives, hints, displays, and variables, are loaded from ARC metadata and refresh without republishing the Node-RED package.
Set msg.gameId to override the configured game for one trigger. Most flows do not need any other fields.
Notes
- ARC host defaults to
arc.local. - ARC always runs on port
1183; the node configuration does not expose a port field. - The ARC WebSocket path is handled by the package.
- Low-level raw event streaming is intentionally not included in this first package surface. It can return later as a separate advanced node if needed.
Release Notes
See CHANGELOG.md.
