Help
Everything you can do here, in one page. For what the guild is see about; for how standing is counted see how ranks work.
Hotkeys
Hold Shift and the keys appear on everything that has one. Keep holding it and press:
- s setups
- m members
- l leaderboard
- g globe
- h home
- y your own page
- p your profile, or the sign in door when you are signed out
- t the theme picker
- ? this page
- f the search or filter field, on the members and setups pages
- j the join field
- ← back
- → forward
Nothing fires while you are typing in a field, so a capital letter stays a capital letter.
Getting your work counted
Contributions come from public sources, never from what you tell us, so
the first step is connecting GitHub.
It asks for read:user and nothing more, and it is never a way to
sign in. Until it is connected, nothing counts.
- Merged pull requests to
omacom/omarchyare found on their own. Nothing to claim. - Plugins you claim in settings, with either the GitHub repo URL or the plugins.omarchy.org listing URL. A plugin already in the catalog under your name is matched for you.
- Themes you claim with the GitHub repo URL.
- Apps, standalone programs built for Omarchy, you claim
with the GitHub repo URL once the repo carries the
omarchyGitHub topic. An admin confirms each app by hand, so give it a day.
A theme repo passes when at least two of these sit at the root:
colors.toml icons.theme neovim.lua vscode.json preview.png hyprland.conf waybar.css alacritty.toml
That is the whole check. An app repo passes on the topic and the admin's nod, nothing else.
Claims are re-checked every night, whatever they say now. A claim that was rejected and has since been fixed picks itself back up without being re-claimed, and a repo that is deleted, renamed or made private drops away the same way. Disconnecting GitHub keeps your contributions on record but stops them counting until you reconnect.
Badges
The seals on a member page. Every one below the teams is worked out from your contributions, so there is nothing to ask for.
- Founding member: one of the first through the door.
- First merged PR.
- Ten merged PRs.
- Plugin author: at least one verified plugin.
- Theme author: at least one verified theme.
- App author: at least one verified app.
Teams
The teams on omarchy.org/teams: Core team, Security team, Design team, M team, and Rangers team. This is the one badge nothing here can work out for itself, so you claim yours in settings and it is checked by hand against that page. A confirmed team is named under your handle rather than sealed among the badges.
A claim sits as pending until then and shows on nobody's page, including your own. That is it waiting, not it failing.
Setups
A setup is a machine you run Omarchy on: name it, add screenshots, and fill in as much or as little of the machine, CPU, GPU, display and theme as you feel like. The notes take proper formatting for the longer story.
Mark one as primary and it leads your page and represents you on the setups wall. The wall filters by theme, machine and GPU, which is the quick way to find somebody running what you are about to buy.
Your page
Your display name, handle, bio, picture, and your Discord and X handles. The Discord handle is the point of the whole directory: it is how people find each other back on the Discord.
Two controls worth knowing about:
- Hiding your page takes you out of the directory, the globe and the leaderboard entirely. Your work keeps counting; nobody can see it.
- The globe is opt in. Add a location and you can appear named, or as an anonymous dot that adds you to the count without saying who you are.
Themes
11 of them, on t or in settings. Your pick follows your account rather than the browser, so it is waiting for you wherever you sign in next.
Sharing
Every member page and every leaderboard board draws its own card, so a link posted anywhere unfurls as that page rather than as the site in general. The share link on your page fills in the text for you.
Your account and your data
- Signing in is a code sent to your email. There is no password to forget.
- Export everything as JSON: your profile, setups and verified contributions.
- Deleting your account removes your page, setups and contributions immediately. Your founding number is retired rather than handed to somebody else.
Anything else
There are no comments, DMs or feeds here, on purpose. Conversation belongs on the Discord, and anything else can come to [email protected].