{"id":31828281,"url":"https://github.com/aylur/marble-shell","last_synced_at":"2025-10-11T19:27:45.427Z","repository":{"id":316648181,"uuid":"1062134353","full_name":"Aylur/marble-shell","owner":"Aylur","description":"My personal Wayland Desktop Shell","archived":false,"fork":false,"pushed_at":"2025-10-04T12:51:33.000Z","size":96,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-04T14:38:05.296Z","etag":null,"topics":["ags","gnim","gtk-layer-shell","gtk4","gtk4-layer-shell","layer-shell","unixporn","wayland"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Aylur.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-22T21:14:32.000Z","updated_at":"2025-10-04T12:51:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"89af8624-413b-4777-af97-d43a2cddc5d7","html_url":"https://github.com/Aylur/marble-shell","commit_stats":null,"previous_names":["aylur/marble-shell"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Aylur/marble-shell","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aylur%2Fmarble-shell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aylur%2Fmarble-shell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aylur%2Fmarble-shell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aylur%2Fmarble-shell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Aylur","download_url":"https://codeload.github.com/Aylur/marble-shell/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aylur%2Fmarble-shell/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279008421,"owners_count":26084460,"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","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["ags","gnim","gtk-layer-shell","gtk4","gtk4-layer-shell","layer-shell","unixporn","wayland"],"created_at":"2025-10-11T19:27:43.047Z","updated_at":"2025-10-11T19:27:45.420Z","avatar_url":"https://github.com/Aylur.png","language":"TypeScript","funding_links":["https://github.com/sponsors/Aylur"],"categories":[],"sub_categories":[],"readme":"# Marble Shell\n\nA Wayland Desktop Shell.\n\n![Desktop](https://marble-shell.pages.dev/full.png)\n\n\u003e [!IMPORTANT]\n\u003e\n\u003e ## Sponsorware Notice\n\u003e\n\u003e Although _this repository_ is open source, it depends on\n\u003e [Marble Kit](https://marble-shell.pages.dev/), which is a paid project. To run\n\u003e this project, you will need access to Marble, which you can obtain by becoming\n\u003e a [sponsor](https://github.com/sponsors/Aylur). Make sure to read the\n\u003e [license](https://marble-shell.pages.dev/license) and\n\u003e [prerequisites](https://marble-shell.pages.dev/guide#prerequisites) before\n\u003e sponsoring.\n\n## Supported Compositors\n\nSupported Compositors\n\nCurrently, it primarily targets Hyprland but works on any compositor that\nsupports the layer shell protocol.\n\nSome bar components only support Hyprland, namely: the workspace indicator,\nclient list, and keyboard layout indicator. Support for Niri is a work in\nprogress.\n\n## Installation\n\nArch-based distributions and Nix are supported out of the box. On other\ndistributions, you may need to compile some dependencies from source.\n\n\u003e [!NOTE]\n\u003e\n\u003e Currently some components are only supported on **Hyprland**. Support for\n\u003e other compositors are **WIP**.\n\n### Arch\n\n1. Install dependencies\n\n   ```sh\n   yay -S aylurs-gtk-shell-git libastal-meta fzf brightnessctl pnpm \\\n     libadwaita gtk4-layer-shell glycin glycin-gtk4 evolution-data-server\n   ```\n\n2. Clone this repository\n\n   ```sh\n   git clone https://github.com/aylur/marble-shell\n   cd marble-shell\n   ```\n\n3. Install npm dependencies\n\n   ```sh\n   pnpm install\n   ```\n\n4. Run with `ags`\n\n   ```sh\n   ags run app.ts\n   ```\n\nOptionally, you can bundle it and install system/user wide:\n\n```sh\nout=\"$HOME/.local\"\n\nmkdir -p $out/bin\nmkdir -p $out/share\ncp -r data/* $out/share\nags bundle app.ts $out/bin/marble -d \"import.meta.PKG_DATADIR='$out/share'\"\n\n# make sure \"$HOME/.local/bin\" is in $PATH\nmarble --help\n```\n\nTo install system wide you can set `$out` to `/usr`. This is generally not\nrecommended though, as you should let your package manager to manage system wide\npackages. Instead install to `/usr/local` and make sure `/usr/local/bin` is in\n`$PATH`.\n\n\u003e [!IMPORTANT]\n\u003e\n\u003e ## Marble License Reminder\n\u003e\n\u003e Don't publish bundles and don't publish the `node_modules/marble` directory.\n\n### Nix\n\n1. Include this repo as an input to your flake.\n\n   ```nix\n   # flake.nix\n   {\n     inputs = {\n       marble-shell.url = \"git+ssh://git@github.com/Aylur/marble-shell\";\n     };\n   }\n   ```\n\n2. Override the package and include your ssh key.\n\n   ```nix\n   inputs: let\n   { pkgs, inputs, ... }: let\n     marble = inputs.marble-shell.packages.${pkgs.system}.default;\n     marble-shell = marble.overrideAttrs (prev: {\n       pnpmDeps = prev.pnpmDeps.overrideAttrs {\n         sshKey = ./path/to/sshkey;\n       };\n     });\n   in {\n     # using home-manager\n     home.packages = [marble-shell];\n\n     # using configuration.nix\n     environment.systemPackages = [marble-shell];\n   }\n   ```\n\n\u003e [!TIP]\n\u003e\n\u003e If your flake is in a public repo, you can hide your ssh key by pushing it\n\u003e into a private repo and having it as another input to your public flake.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faylur%2Fmarble-shell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faylur%2Fmarble-shell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faylur%2Fmarble-shell/lists"}