Frequently asked questions
Something missing? Ask in the GitHub Discussions, or from the contact page.
What do I need to use it?
React 19 and Tailwind CSS v4, in a project set up for shadcn/ui. The examples use Next.js, but the component itself is plain React.
Where does the room get its data from?
From you: pass an array of agents with a name and a status (working, ok, late, failed…). Read it from whatever you already track: an exit code, a queue, a CI API. For GitHub Actions, githubAgents() finds your project’s workflows on its own. Or run npx pixel-openspace, which reads your launchd or systemd jobs on your own machine, or the GitHub Actions workflows of a repository with --github owner/repo.
Does it send my data anywhere?
No. The room runs in the browser and only shows what you pass it. The only outside call is the weather behind the lead’s window, from Open-Meteo, and only if you choose a place.
Can it stay open all day on a screen?
That is what it is made for. It runs at 30 frames per second and only redraws what moved; after twenty quiet seconds everything freezes until someone gets up.
What is the difference between late and asleep?
Late means a run was missed. Asleep means it was missed while the laptop was asleep: nothing is broken, so the lead leaves it alone. The local server tells the two apart on its own, on macOS and Linux.
Can I start a job from the room?
Yes: pass onRun and each agent’s card gets a “Run now” button. With the local server, add --allow-run; it is off by default.
How do I update it?
Run the shadcn command again with --overwrite. The files in components/pixel-openspace/ are replaced, so keep your own changes somewhere else. The changelog says what changed.
Can I make my own theme?
Yes. A theme is one file in components/pixel-openspace/themes/: the decor, the desks, the outfits, the break corners and the night lights. Start from an existing one; theme ideas are welcome as GitHub issues.
Read the guide: Create a theme →Which languages are there?
English and French, for everything written and said in the room.
Is it free?
Yes, under the MIT license: use it, change it, ship it. If it makes your day nicer, a coffee is welcome.