What you need
- Windows 10 or 11 with Stream Deck software 7.1 or newer.
- Project Zomboid Build 42 (on Steam).
- The Stream Deck Bridge mod, from the Steam Workshop or installed by the plugin (or download it below).
1. Install the plugin
On the Elgato Marketplace. Get Zomboid Deck from its Marketplace listing; the Stream Deck software installs it for you.
2. Install the mod
Project Zomboid has no way for other programs to see into the game, so Zomboid Deck comes with a small
client-side mod. While you play it writes what your survivor knows about themselves to a file in your
Zomboid\Lua folder once a second, and the plugin draws the keys from it.
From the Steam Workshop (the easy way)
Stream Deck Bridge on the Steam Workshop
Press Subscribe on the Workshop page and Steam downloads the mod and updates it for you. Then
start Project Zomboid, open Mods, switch on Stream Deck Bridge, and load a save
(for a save you already have, switch it on in that save's own mod list too). A server adds it with Workshop ID
3813743791 and mod ID StreamDeckBridge.
Or put any Zomboid Deck key on your deck, click it, and look at its settings: they show whether the mod is there
and where it came from. With the game closed, Install the mod copies the version that came with
the plugin into your Zomboid\mods folder instead.
Use one way, not both: with two copies of the mod the game may load the older one. If you have both, the key's settings say so and offer Remove the local copy, which keeps only the Workshop's.
Installing the mod by hand
Download Stream Deck Bridge 1.4.0
The mod is open source (MIT), so you can read exactly what it does: github.com/AussieH/zomboid-deck-bridge.
- Close Project Zomboid.
- Unzip it into
C:\Users\you\Zomboid\mods, so you end up with aStreamDeckBridgefolder there (with a42folder inside it, as Build 42 needs). - Start the game, switch the mod on in Mods, and load a save.
Also on the XENEON EDGE
The same mod feeds Zomboid Dashboard, our iCUE widget for the Corsair XENEON EDGE: your health, moodles, time and weather, hands and car on the touchscreen under your monitor, at the same time as your Stream Deck. It is on the Elgato Marketplace.
3. The Zomboid Deck key and its layout
Drag the Zomboid Deck key onto your own profile and press it: it opens a layout made for your deck, with the live readings on the first page and pages for your health, every moodle, your vehicle and its mechanics, your character, skills, protection and temperature, the game's controls and the hotbar. The layout follows you: get in a car and it turns to the Vehicle page, get out and it turns back; get hurt and it turns to the Health page, damage the car and it turns to the Mechanics page, then back once things are quiet. There are layouts for the Stream Deck, XL, Mini and +, where the dials show your moodles and your car on the touch strip.
Demo profiles
A ready-made page of Zomboid Deck keys for each Stream Deck, besides the layout the Zomboid Deck key opens. Every key works as soon as the game and the Stream Deck Bridge mod are running. Download the one for your deck and double-click it to import it into Stream Deck.
- Stream Deck: 15 keys: gauges, readouts and two keys that act
- Stream Deck Mini: 6 keys
- Stream Deck XL: 32 keys: six gauges, readouts and three keys that act
- Stream Deck +: 8 keys and all four dials
- Stream Deck Neo: 8 keys
4. The keys
- Health and endurance, as keys or as a bar across three or four keys.
- A Health page laid out like the game's Health tab: a body map with the hurt parts in red, the Overall Body Status, and a key for each injured part listing what the tab lists (laceration, bleeding, fracture, bandaged and the rest), in the game's own words.
- Moodles, worst first: grey turning red as hunger, panic or pain climbs, green for the good ones, with the level shown as dots. There is a key for each moodle as well.
- Time, day, date and weather, the temperature, whether you are indoors, and whether the power and water are still on. In single player it also counts down to when they shut off.
- The weapon in your hands and what is in the other: condition, how sharp, rounds left.
- Weight carried against what you can carry, zombies in sight, kills and wounds.
- The car you are in: its name, speed, fuel, the engine and the headlights.
- A Mechanics page laid out like the game's Mechanics window: a top-down car with each part shaded by its condition, the Overall Condition, and a key for every part, worst first (a blown tire shows as Missing), in the game's own words and colours.
- Character pages like the game's character window: your profession and traits, every skill with its level squares and progress (and the arrows while a skill book is working), bite and scratch protection for each body part, and the temperature bars and body views.
5. Keys that act
- Sit down on the ground or stand up (the game has no key for it).
- Light: switch the flashlight in your hand or on your belt.
- Headlights and Engine, when you are driving.
- Stop: clear what you are doing, without opening the pause menu.
- The Controls and Hotbar pages send the game's own keys, from its default bindings.
6. What it can and cannot do
- It shows what the game shows you: no hidden infection (a hidden one shows only as the moodle the game shows, and the Health page lists only what the game's Health tab lists).
- The utilities countdown is single player only. On a server the keys show only whether the power and water are on, so nobody gets an edge, and a key setting hides the countdown if you would rather be surprised.
- The mod is client-side only, has no cheats, and nothing leaves your PC.
- In multiplayer a mod has to be on the server for a client to load it, so it works where the server runs it.
Frequently asked
The keys say the game is not running.
Check the mod is switched on in the game's Mods menu, and in the save's own mod list for a save you already have.
Something is still wrong.
Email support@teatimeservers.ca and tell us what you see.