Node-REDscape Escape Room control software is (re)launched! (Patreon)
Content
It's hard to believe that it's been 4 years since I started developing "Node-REDscape" - escape room control software based on Node-RED.
I was basically all set ready to launch at the beginning of 2020 and then, well.... then the world turned upside-down and demand for live event control systems kind of fell off the planet, so ever since then it's just lingered in the background.
But I'm pleased to say that I've been busy beavering away at it over the last months, and am now ready to (re-)launch it for public use, so here it is! And you can download it from:
https://github.com/playfultechnology/node-redscape
So, what is it?
It's software for controlling Escape Room games that runs on Windows, Mac OSX, Linux, Raspberry Pi, or on a cloud-based server. (But, crucially, it doesn't need any internet connectivity - you can run it all locally)
Based on "Node-RED", a free, open-source platform originally developed by IBM. Node-RED has been installed on millions of devices worldwide, and is used in production environments in places like Siemens and AT&T. In short, it's really, really good.
What does it do?
Node-REDscape provides a set of templates, flows, and examples that turn Node-RED into a complete Escape Room automation system, as demonstrated in the video above. That includes:
Manage a central game timer. Start/stop/reset or make manual adjustments for deductions or additions to game time. Display the time elapsed/remaining on one or more displays customised to match the theme of your room using animated backgrounds and CSS styles.
Monitor, reset, or override the state of all game devices from a browser-based dashboard
Send pre-defined or custom text messages, trigger audio or video content on in-game displays or other delivery mechanisms - a thermal printer, LCD display etc.
Create event-based gameflows, triggered after a certain amount of time, with a random chance, or on completion of certain pre-requisites. Or, use the drag-and-drop node editor to define more complex logic between devices.
Interface with lighting and sound systems using industry-standard communications such as DMX and MIDI, Philips Hue lighting, etc.
How much does it cost?
Absolutely nothing! :)
I'm hoping that there's something in it for everyone - whether your room contains just a handful of Arduino Nanos or a full mesh of wireless devices. If you previously downloaded the old version you'll notice that I've made a lot of recent changes - it's been rewritten to use the latest version of Node-RED (v3.0.2, released Aug 2022), and there have been updates throughout all the code. I've included example flows for different networks and microprocessors: MQTT over Wi-Fi on an ESP8266, UDP on an Arduino UNO with an ethernet shield, an ESP32 with a W5500 module, or an Arduino Nano connected via a USB serial cable - you can study and amend those examples to integrate your own devices into the system. Or, you can also just use the game timer and clue delivery system running in isolation without worrying about setting up a complete prop network.
I'm going to carry on developing the system, and also writing up the accompanying documentation, but I need your help! Let me know what it is you want to be able to do with the system and I can add those examples.
Get Started!
If all this is completely new to you and you don't know where to start:-
a.) Install Node-RED from https://nodered.org/
b.) Download the Node-REDscape repository from https://github.com/playfultechnology/node-redscape
c.) After starting Node-RED running, visit http://localhost:1880 in your browser to open the Node-RED editor. Open the menu at the top right and select "Import", then choose any of the .json files from the "Node-RED" folder of the Node-REDscape download.
First, I recommend importing and deploying the "NodeREDscape_Core_Main.json" flow. Then you can open the GM dashboard by visiting http://localhost:1880/ui
Then, you can import and deploy the "NodeREDscape_Core_In-GameDisplay_flow.json" flow, then open the In-Game Display by visiting http://localhost:1880/room_display/
(you can change the url for either of these displays if you prefer)
d.) You can import any of the other flow .json files to give you templates of how to perform other tasks. Double-click on any node to edit them, or drag new nodes and connect them into the flow. I've tried to make their function obvious, but please ask if you have any questions!
e.) Open any of the examples in the Arduino/ESP8266/ESP32/Unity folders to see a template of how to write code on your devices to make your props connect to the Node-RED network. There are accompanying flow files for various common puzzle types, with an assortment of connection methods (i.e. MQTT/Serial/UDP/etc.) - you can disable or delete any you don't need.
Phew! I appreciate that this all might be a bit overwhelming if you've not tried Node-RED before, but I guarantee that it's worth the effort to try it - I think it's a beautifully elegant and simple system, but capable of some really powerful results. I hope you enjoy, and do ask if you need help! Cheers x