Home Creators Posts Import Register Favorites Logout

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

Files

maxresdefault.jpg

What is Node-REDscape? - Node-REDscape is software for controlling Escape Room games that runs locally on Windows, Mac OSX, Linux, Raspberry Pi, or on a cloud-based server. - Based on "Node-RED", a free, open-source platform originally developed by IBM, available from nodered.org. 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 Node-REDscape do? - Node-REDscape provides a set of templates, flows, and examples that turn Node-RED into a complete Escape Room automation system. - Manages 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 devices from a browser-based dashboard. There are examples provided for several common microprocessor-controlled escape room puzzles using Arduino, ESP8266, ESP32, and Raspberry Pi. - 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 define more complex automated logic using a simple drag-and-drop node-based editor. - Interface with lighting and sound systems using industry-standard communications such as DMX and MIDI, Philips Hue lighting, etc. - And much, much more! How much does it cost? - Nothing! Where can I get it from? - https://github.com/playfultechnology/node-redscape Timings 00:00:00 - 00:00:18 Introduction 00:00:19 - 00:02:09 General approach and infrastructure 00:02:10 - 00:03:17 Integrating a device with Node-REDscape 00:03:18 - 00:05:30 Realtime GM dashboard demonstration 00:05:31 - 00:06:37 In-Game timer/clue delivery display for players 00:06:38 - 00:07:27 Github download

Comments

Marlon Jones

Hi Alastair, I really love your tutorials and escape room projects. Quick question! I'm having problems with using the "Room Display". I've followed your instructions and gone through the information you wrote to the community, but all I get is a white background with "{{MSG.TIMERTEXT}} {{MSG.DISPLAYTEXT}}" off-centered on my screen. (As a side note, I'm using a Raspberry PI to run Node-Red) Do you know what I'm doing wrong? Bu the way, I do have other questions, but I'll ask them one at a time. Thanks again for all you're doing!

Olga Saltovsky

I'm so waiting for more explanations about this software.

Matt

Man this has hurt my head tonight. Couldn't work out how to install front end libraries like VUE etc to get the display to work.

Marlon Jones

Your "Triggering an action on startup" link for NodeScape on github is not working. Do you have the documentation somewhere else?

Scott Emigh

Hey Alistair thank you for this amazing resource. Wondering if you have sample code for connecting an Uno R3 via wifi. I see the ESP32 example, but it states it won't work correctly with Uno.

Pue Gonzales

Hi. Is this for IOT devices only? What i mean for likes like Arduino, ESP32, Raspberry's, etc? Can i connect something like RF relays?

Code1882

Hi.I'm currently trying to create an in-room display for my escape room based on the Wiki posts. Node Red is a new world for me, but I've already familiarized myself well and I understand most of it quite well. Things get difficult with the function.nodes. I still have a lot to learn here. Things get really difficult with the UIBuilder. I would like to give players a tip like: Here is a VERY VERY helpful tip Is there a way to format msg.clueText so that I can send a line-wrapped text to UIBuilder?

Alan gilman

Hello Alastair, I was working with a local escape room owner to develop a "control panel" for his room and stumbled on this video. Fantastic work! I notice that you are using Font Awesome fonts but I can't seem to determine how you did it. In general I would really enjoy a video on how you configured the Node Red dashboard to display the different "cards", fonts, and icons. Thank you so much for all the game room videos you have created!

Adam Waite

Wow! You have been busy! I have already learned so much about node-red from your tutorials and look forward to digging into this. Thank you for all that you do!

Remco Dresen

Really cool! Thanks so much !

Euan Hair

For anyone feeling overwhelmed reading that intro believe me when I say Alastair makes it soooo easy and it's incredibly worth following!

Ofer Groman

Absolutely amazing. The amount of work you put into your videos.. and now this?.. This is going to ruin some nights for me 😅 thank you!!

Maarten Geerlings

Hi Alastair. Is there a way to detect if an ESP loses it wifi or mqtt connection to node red? It's nice to now if u puzzle is "offline". I used to have a trigger node that got retriggerd if a mqtt message was recieved. But in your update the messages from the ESP only get send upon a change that is detected. I like to implement that as it will seriously declutter the wifi. Now al sensors send every 5 seconds... But with the messages only being send upon change, my "system" for detecting if a ESP is still online won't work that way. I tried looking into Last Will And Testament but haven't been able to get a working version. Thanks!

Secret City

Hi Alastair, I'm quite excited to try this out. In the wiki it references v3.1.3 but installing as instructed on Node-red website it installs 3.0.2. The issue is it seems to not recognize the ui components in the main flow. Any ideas? Thanks!

stefano legnano

Hi Alastair, first of all thank you for the spectacular videos you post, they are really very useful and inspiring for us who want to create more and more updated escape rooms 😊 I was trying out Node Red lfor the escape room program, and it's great! Very intuitive and relatively simple as an approach, almost everything works..I still have to test the WiFi connection with ESP, but for now I'm more interested in understanding how to make "Room Display" work.. In the Dashboard part everything is fine, I can see what is being added, modified etc.. But I can't show the Room Display output page as it should.. It doesn't load any type of template, if I leave Blank without framework, I see the features working fine, but when I go to change the type of template nothing happens.. I act on the "Room Display" node and select a type of template between Vesta or other but nothing.. What is the code missing to show a simple countdown timer and background (like in your video?) Could anyone help me?