Skip to content

Adding your own theme

NotAShelf edited this page Jan 12, 2023 · 1 revision

We welcome all contributions that help us create an archive of community-made themes. To submit your theme to this repository, follow the instructions below.

Creating a repository

We use git submodules to store themes. In order to submit your theme, you will want to upload your theme directory to git first. Initialize a git project with git init and the files that are a part of your theme (configs, wallpapers, scripts, etc.) with git add. After you add your files to git, add a README to your repository that explains the key features of your theme, and ideally include a demo image/video. Add your README to git, and push your changes to Github with git push.

Previously, in Theming 101, we have created a fresh directory where our theme resides. For healthier theme structures, you are advised against turning your dotfiles (~/.config) into a theme repository. Submissions that include personal dotfiles (e.g config settings such as keybinds) will most likely be denied

Making a submission

Open a new issue in this repository with the "Add Theme" template and insert the url to your theme repository. Github actions will do the rest after we approve or deny a theme submission.

And that is all! You have successfully made and submitted a theme, unless something goes very wrong (like a piano falling on each maintainer) we will review and hopefully approve your theme and after the approval process everyone will be able to use your theme!

Hyprtheme Wiki

Clone this wiki locally