Installation

WARNING

This project is closed source. You have to be a GitHub Sponsor to gain access to the source code.

Currently Astal libraries are packaged for the AUR and Nix. If you don't have access to these you will have to install dependencies from source.

License Notice

The project currently uses a no-permission license which basically means you cannot distribute it in any form. You are only allowed to use it locally for personal use. In the future, I plan to switch to a more permissive license similar to Tailwind's personal license so that you can share your custom configuration.

GitHub sponsorship

In order to get access to the source code you have to be a GitHub sponsor.

Make sure you select the correct monthly tier and not a custom amount if you wish to get access.

Gaining access is an automatic process when becoming a sponsor. You will have access as long as you are a sponsor.

How to become a sponsor

Go to my dashboard and select the monthly tier.

Arch guide

Install the following dependencies

# install dependencies
yay -S gjs gtk4 gtk4-layer-shell libadwaita pnpm esbuild libastal-meta

# clone the repo
git clone https://github.com/marble-shell/shell.git
cd shell

# install js dependencies
pnpm install

# build and install
meson setup build
meson install -C build

# it should be installed
marble --help

Nix guide

Add marble as an input

{ # flake.nix
  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
    marble = {
      url = "github:marble-shell/shell";
      inputs.nixpkgs.follows = "nixpkgs";
    };
  };
}

Install it in your system configuration or home-manager configuration

{pkgs,inputs,...}: {
  home.packages = [
    inputs.marble.packages.${pkgs.system}.default
  ];
}

After a rebuild it should be installed

marble --help