In testing. Colony Dashboard and the Colony Deck Bridge mod are built, against the current game, and are going through their first run in the game and on the XENEON EDGE. This page will link to the widget, and the mod will be posted, once that run has checked them.
What it shows
The Overview
The colony's name, the hour, date and season, the speed (or Paused), the weather and temperature in your game's unit; your colonists with a dot for how they are, their health, a mood bar marked at their own break thresholds and their job; the alerts, worst first; and, where there is room, resources, research, letters and threats.
The pages
- Colonists: every colonist with mood, health, food, rest and joy, and their job. On the wider sizes a Mood panel beside them gives the average mood and health, the lowest mood, break risk, and how many are drafted and downed.
- Alerts and letters: the alerts worst first with how many things each points at, and the letters newest first with their kind and how long ago.
- Resources and research: days of food, silver, medicine, components, steel and wood, the research project, threats and the weather.
The tabs get a dot when something needs you: Colonists when someone is downed or breaking, Alerts for a critical alert, Resources when food is under four days, the medicine is gone, or raiders arrive.
When something is missing
The widget says what is missing instead of going blank, and comes back by itself once the colony is up again.
- Waiting for the colony: the mod has not written its file yet. It says to add Colony Deck Bridge and tick it in the game's Mods list. After a minute it says Still waiting, and what to try (see the FAQ).
- At the main menu and Loading the colony.
- RimWorld is not running: the mod has not written for a while, with when it last did.
- Update the widget: the mod writes a newer file than this widget reads.
- Not in this file, in one panel: the mod could not read that part; the rest still comes through.
What you need
- A Corsair XENEON EDGE, on Windows.
- iCUE 5.51 or newer. Earlier versions cannot let a widget read a file.
- RimWorld 1.5 or 1.6 with our Colony Deck Bridge mod ticked in its Mods list. The mod is coming to the Steam Workshop and GitHub.
- No Stream Deck. If you have one, Colony Deck reads the same file at the same time.
Feeding it
RimWorld does not share its state with other programs, so the Colony Deck Bridge mod does: about once a second,
paused too, it writes the colony's state to one small file, %APPDATA%\.
The widget draws from that file.
Start RimWorld with the mod once (or Stream Deck with Colony Deck) before you add the widget in iCUE. Either makes the folder the widget reads, and iCUE only watches a folder that existed when the widget was added. If you placed the widget first, remove it and add it again, or restart iCUE.
What it reads
The widget reads one folder, %APPDATA%\, and only the mod's state.json in
it. That is all: no other folder, no address on the internet, and it only reads. It cannot pause the game or send
anything to it: the keys that do are on Colony Deck.
Sizes and settings
You choose the size in iCUE when you place the widget: Small, Medium, Large or Extra Large, across or upright. Every page is laid out for every size; the Small sizes show the colony and the alerts, and the least needed lines go first instead of the type shrinking.
In the widget's settings in iCUE you can:
- Show the dashboard (the Overview with touch tabs), or one page per widget (Colonists, Alerts and letters, or Resources and research), so you can place several Colony Dashboard widgets side by side;
- turn the page tabs on the dashboard off;
- pick a 12-hour or 24-hour clock;
- set the text, accent and background colours, and the background transparency.
Tap a tab to turn the page, and tap a long list for its next rows.
What it can and cannot do
- It reads one file on your PC. It sends nothing, stores nothing and writes nothing. Nothing about your colony leaves your PC from the widget.
- It changes nothing in the game. Taps only change what the widget shows.
Frequently asked
Do I need a Stream Deck?
No. The widget needs only the Colony Deck Bridge mod in RimWorld.
It says Still waiting for the colony.
Check that Colony Deck Bridge is ticked in the game's Mods list and load a colony. iCUE can only watch a folder that already exists, so if you added the widget before the mod had ever run, remove the widget and add it again, or restart iCUE.
Can I pause or draft from the widget?
No. The widget only shows. Pause, speed and draft keys are on Colony Deck.
Is this made by Ludeon Studios or Corsair?
No. Colony Dashboard is an unofficial project made by TeaTime, not affiliated with or endorsed by Ludeon Studios or Corsair. RimWorld is a trademark of Ludeon Studios, and XENEON EDGE and iCUE are trademarks of Corsair. No game logo, artwork, font or screenshot is used: every picture is drawn in code, with panels, bars, dots and text.
Something is still wrong.
Email support@teatimeservers.ca and tell us what the widget says.