{"id":18478959,"url":"https://github.com/wayfirewm/wayfire-sample-plugin","last_synced_at":"2025-07-06T16:05:48.463Z","repository":{"id":218078455,"uuid":"733996260","full_name":"WayfireWM/wayfire-sample-plugin","owner":"WayfireWM","description":"This repo aims to be a demonstration of some of the common Wayfire APIs for plugins and how they are to be used.","archived":false,"fork":false,"pushed_at":"2024-01-19T14:59:37.000Z","size":12,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-13T18:48:34.876Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WayfireWM.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,"zenodo":null}},"created_at":"2023-12-20T16:02:53.000Z","updated_at":"2024-07-05T13:43:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"ee6d5e0d-c0d1-47c0-b72b-fedf3a1d72ca","html_url":"https://github.com/WayfireWM/wayfire-sample-plugin","commit_stats":null,"previous_names":["wayfirewm/wayfire-sample-plugin"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/WayfireWM/wayfire-sample-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WayfireWM%2Fwayfire-sample-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WayfireWM%2Fwayfire-sample-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WayfireWM%2Fwayfire-sample-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WayfireWM%2Fwayfire-sample-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WayfireWM","download_url":"https://codeload.github.com/WayfireWM/wayfire-sample-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WayfireWM%2Fwayfire-sample-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263932017,"owners_count":23531707,"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":[],"created_at":"2024-11-06T12:12:43.919Z","updated_at":"2025-07-06T16:05:48.456Z","avatar_url":"https://github.com/WayfireWM.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"**THIS IS STILL WIP!!!**\n\n# wayfire-plugin-template\n\nThis repository contains a basic skeleton of a Wayfire plugin, together with a few examples of common operations\nand features plugins typically use. The aim is to provide a good starting point when writing a custom plugin.\n\nGenerally, a plugin will consist of at least the following:\n\n- `meson.build`: the plugin's build system.\n- `metadata/\u003cyour plugin name\u003e.xml`: contains descriptions of all options of your plugin.\n- `src/\u003cyour plugin name\u003e.cpp`: contains the code of your plugin\n\nTake a look at the various files in this repository, they have been commented rather thoroughly to guide you through the API.\n\n# Building\n\n```\nmeson build\nninja -C build\nsudo ninja -C build install\n```\n\nKeep in mind that if you have installed Wayfire to a non-standard location (for example `/opt/wayfire`) you will need\nto adjust `PKG_CONFIG_PATH` so that meson can find the Wayfire installation\n(`PKG_CONFIG_PATH=/opt/wayfire/lib64/pkgconfig` before `meson build`, adjust for your distro and installation prefix).\n\n# Installing a plugin\n\nThe build system is set up by default so that plugins are installed at the same location\nwhere Wayfire's main plugins are installed.\nIf you want to change that, you can edit `src/meson.build` and override where the plugin is installed.\nAlternatively, you can compile your plugin and not install it at all: simply use the full plugin path\nin your config file, and set `WAYFIRE_PLUGIN_XML_PATH` (before starting Wayfire) to contain the directory\nwhere your plugin's XML file is located.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwayfirewm%2Fwayfire-sample-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwayfirewm%2Fwayfire-sample-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwayfirewm%2Fwayfire-sample-plugin/lists"}