{"id":16166031,"url":"https://github.com/duckonaut/hyprload","last_synced_at":"2025-04-10T03:54:21.681Z","repository":{"id":118000223,"uuid":"607421680","full_name":"Duckonaut/hyprload","owner":"Duckonaut","description":"A Hyprland plugin manager","archived":false,"fork":false,"pushed_at":"2024-02-23T15:49:44.000Z","size":149,"stargazers_count":199,"open_issues_count":15,"forks_count":13,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-10T03:54:15.467Z","etag":null,"topics":["hyprland","hyprland-plugin","hyprload","plugin-manager"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Duckonaut.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-27T23:57:06.000Z","updated_at":"2025-04-06T12:47:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"bd9e9e74-c261-47f4-8848-5ed35fab0266","html_url":"https://github.com/Duckonaut/hyprload","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Duckonaut%2Fhyprload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Duckonaut%2Fhyprload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Duckonaut%2Fhyprload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Duckonaut%2Fhyprload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Duckonaut","download_url":"https://codeload.github.com/Duckonaut/hyprload/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248154999,"owners_count":21056542,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hyprland","hyprland-plugin","hyprload","plugin-manager"],"created_at":"2024-10-10T02:53:10.925Z","updated_at":"2025-04-10T03:54:21.656Z","avatar_url":"https://github.com/Duckonaut.png","language":"C++","readme":"![Hyprload](./assets/hyprload_header.svg)\n\n### A [Hyprland](https://github.com/hyprwm/Hyprland) plugin manager\n\n\u003e [!IMPORTANT]\n\u003e **Deprecated**\n\u003e This plugin has been all but made obsolete by Hyprland now including `hyprpm`, its own plugin manager. `hyprload` will likely not receive additional updates,\n\u003e as even I have switched over to `hyprpm`.\n\n# Features\n- [x] Loading plugins\n- [x] Reloading plugins\n- [x] Installing and updating plugins automatically\n    - [x] A unified plugin manifest format\n    - [x] Installing from git\n    - [x] Installing from local\n    - [X] Self-hosting\n- [ ] Plugin browser\n\n# Requirements\n- Hyprland \u003e= 0.31.0\n- `jq` (required for checking Hyprland version)\n- `polkit` (required to set up Hyprland plugin env)\n    - You will need an authentication agent set up. `lxsession` works for me.\n- `cpio` (required during installation for file management)\n\n# Installing\n1. Install `hyprload`\n    - `curl -sSL https://raw.githubusercontent.com/Duckonaut/hyprload/main/install.sh | bash`\n2. Add this to your config to initialize `hyprload`\n    - `exec-once=$HOME/.local/share/hyprload/hyprload.sh`\n\n# Setup\n1. To have hyprload manage your plugin installation, create a `hyprload.toml` file (by default, next to your `hyprland.conf` config: `~/.config/hypr/hyprload.toml`\n2. Fill it out with the plugins you want. It consists of one array, named plugins, in which you can provide the installation source in various ways. Example:\n```toml\nplugins = [\n    # Installs the plugin from https://github.com/Duckonaut/split-monitor-workspaces\n    \"Duckonaut/split-monitor-workspaces\",\n    # A more explicit definition of the git install\n    { git = \"https://github.com/Duckonaut/split-monitor-workspaces\", branch = \"main\", name = \"split-monitor-workspaces\" },\n    # Installs the same plugin from a local folder\n    { local = \"/home/duckonaut/repos/split-monitor-workspaces\" },\n]\n```\n3. Add keybinds to the `hyprload` dispatcher in your `hyprland.conf` for the functions you want.\n    - Possible values:\n        - `load`: Loads all the plugins\n        - `clear`: Unloads all the plugins\n        - `reload`: Unloads then reloads all the plugins\n        - `install`: Installs the required plugins from `hyprload.toml`\n        - `update`: Updates `hyprload` and the required plugins from `hyprload.toml`\n    - Example:\n```\nbind=SUPERSHIFT,R,hyprload,reload\nbind=SUPERSHIFT,U,hyprload,update\n```\n\n## Configuration\nThe configuration of hyprload behavior is done in `hyprland.conf`, like a normal plugin\n| Name                                      | Type      | Default                       | Description                                                   |\n|-------------------------------------------|-----------|-------------------------------|---------------------------------------------------------------|\n| `plugin:hyprload:quiet`                   | bool      | false                         | Whether to hide the notifications                             |\n| `plugin:hyprload:debug`                   | bool      | false                         | Whether to hide extra-special debug notifications             |\n| `plugin:hyprload:config`                  | string    | `~/.config/hypr/hyprload.toml`| The path to your plugin requirements file                     |\n| `plugin:hyprload:hyprland_headers`        | string    | `empty`                       | The path to the Hyprland source to force using as headers.    |\n\n# Plugin Development\nIf you maintain a plugin for Hyprland, to support automatic management via `hyprload.toml`, you need to create a `hyprload.toml` manifest in the root of your\nrepository. `hyprload` cannot assume the way your plugins are built.\n\n## Format\nThe plugin manifest needs to specify some information about the plugins in the repo. If you're familiar with TOML, it means specifying two dictionaries per plugin -\n`PLUGIN_NAME` and `PLUGIN_NAME.build`. The `PLUGIN_NAME` dictionary has basic information about the plugin like the version, the description and the author. These\nare not used **currently**, and can be omitted if you don't want to bother for now.\n\nThe `PLUGIN_NAME.build` dictionary is much more important, as it holds 2 important values: `output`, which is the path to the built plugin `.so` from the repo root,\nand `steps`, which holds the commands to run to build that `.so`. **`hyprload` will define `HYPRLAND_HEADERS`** while building the plugin, and guarantees the version\nof the headers matches the Hyprland version you're running.\n\nIt's important to note that the `hyprload.toml` plugin manifest can hold *multiple plugins*. This allows you to define a single manifest for a monorepo.\n\nThe full specification of a `PLUGIN_NAME` dict:\n| Name              | Type      | Description                           |\n|-------------------|-----------|---------------------------------------|\n| description       | string    | Short description                     |\n| version           | string    | Version                               |\n| author            | string    | Author                                |\n| authors           | list      | Can be defined instead of `author`    |\n| build.output      | string    | The path of the `.so` output          |\n| build.steps       | list      | List of commands to build the `.so`   |\n\n## Examples\n### Single plugin\n[split-monitor-workspaces](https://github.com/duckonaut/split-monitor-workspaces)\n```toml\n[split-monitor-workspaces]\ndescription = \"Split monitor workspaces\"\nversion = \"1.0.0\"\nauthor = \"Duckonaut\"\n\n[split-monitor-workspaces.build]\noutput = \"split-monitor-workspaces.so\"\nsteps = [\n    \"make all\",\n]\n```\n\n### Multiple plugins\nHere's what the manifest would look like for the [official plugins](https://github.com/hyprwm/hyprland-plugins).\n```toml\n[borders-plus-plus]\ndescription =\"A plugin to add more borders to windows.\"\nversion = \"1.0\"\nauthor = \"Vaxry\"\n\n[borders-plus-plus.build]\noutput = \"borders-plus-plus/borders-plus-plus.so\"\nsteps = [\n    \"make -C borders-plus-plus all\",\n]\n\n[csgo-vulkan-fix]\ndescription = \"A plugin to fix incorrect mouse offsets on csgo in Vulkan\"\nversion = \"1.0\"\nauthor = \"Vaxry\"\n\n[csgo-vulkan-fix.build]\noutput = \"csgo-vulkan-fix/csgo-vulkan-fix.so\"\nsteps = [\n    \"make -C csgo-vulkan-fix all\",\n]\n\n[hyprbars]\ndescription = \"A plugin to add title bars to windows\"\nversion = \"1.0\"\nauthor = \"Vaxry\"\n\n[hyprbars.build]\noutput = \"hyprbars/hyprbars.so\"\nsteps = [\n    \"make -C hyprbars all\",\n]\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fduckonaut%2Fhyprload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fduckonaut%2Fhyprload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fduckonaut%2Fhyprload/lists"}