-
Notifications
You must be signed in to change notification settings - Fork 1
Home
This is the deep-dive documentation for tuicc — the README covers what tuicc is and how to try it; this wiki is for going further, whether you're trying to understand the architecture, tune your config, or build something new on top of it.
-
[Getting Started](Getting Started) — If you just thought "this is cool, and I wanna try it, but I'm new to all of this / dont really understand what's going on.." Don't worry, I care and wanna help you to use tuicc <3, the page for you is here
-
Architecture — how the core (provider layer, layout engine, input routing) fits together, the RenderContext pattern, and why certain design decisions (floating window handling, spatial vs. linear navigation) ended up the way they did.
-
Config Reference — every section of
config.toml, every accepted value, with examples. If you're customizing tuicc and the inline config comments aren't enough, this is the next stop. -
Writing a WM Provider — a deeper walkthrough than the README's version, including a step-by-step look at building one against a real WM's IPC, and how to handle window layouts that don't map cleanly onto sway's model.
-
Writing a Module — how modules plug into tuicc's core without the core ever needing to know they exist, using the sidebar/preview/quick_actions modules as worked examples.
-
Keybindings — every key name tuicc understands, how Tab/Shift+Tab/arrow-key navigation actually decides where to go, and how to remap everything.
tuicc is early and actively changing — pages here reflect the project as of late July 2026. If something here doesn't match what you see in the code, the code is right; open an issue and I'll fix the page.
- Main README — quick start, status, architecture overview
- Issues — bugs, questions, provider requests