Noctalia

https://docs.noctalia.dev
Admin
Noctalia is a beautiful, minimal desktop shell for Wayland with advanced theming, multi-compositor...
Tokens:493,274
Snippets:7,937
Trust Score:5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Installation Layouts

Source: https://docs.noctalia.dev/noctalia/getting-started/installation?section=alternative-build-from-source-using-xbps-src

Examples of standard and portable installation directory structures.

```text
/usr/local/bin/noctalia
/usr/local/share/noctalia/assets/...
```

```text
bundle/
  noctalia
  assets/
```

```text
bundle/
  bin/noctalia
  share/noctalia/assets/
```

--------------------------------

### Default installation layout

Source: https://docs.noctalia.dev/noctalia/getting-started/installation

The standard file structure after installation.

```text
/usr/local/bin/noctalia
/usr/local/share/noctalia/assets/...
```

--------------------------------

### Configure NixOS Module

Source: https://docs.noctalia.dev/noctalia/getting-started/nixos?section=binary-cache

Examples for system-wide installation of Noctalia on NixOS.

```nix
{ inputs, ... }:
{
  imports = [
    inputs.noctalia.nixosModules.default
  ];


  programs.noctalia = {
    enable = true;


    # Enables NetworkManager, Bluetooth, UPower, and a power profile service.
    recommendedServices.enable = true;
  };
}
```

```nix
let
  # see adding the input above
in {
  imports = [
    noctalia.nixosModule
  ];


  programs.noctalia = {
    enable = true;


    # Enables NetworkManager, Bluetooth, UPower, and a power profile service.
    recommendedServices.enable = true;
  };
}
```

--------------------------------

### Install Required Packages

Source: https://docs.noctalia.dev/noctalia/templates/official/gtk-qt

Install the necessary theme and configuration tools for your distribution.

```bash
# Arch Linux / Manjaro
paru -S adw-gtk-theme nwg-look


# Other distributions
# Install adw-gtk-theme and nwg-look from your package manager
```

--------------------------------

### Install base16-nvim with Lazy

Source: https://docs.noctalia.dev/noctalia/templates/community/neovim

Use this configuration snippet with the Lazy package manager to install the base16 colorscheme and initialize the matugen setup.

```lua

return { 'RRethy/base16-nvim',
  config = function()
    require('matugen').setup()
  end,
}

```

--------------------------------

### Noctalia Theme Configuration Examples

Source: https://docs.noctalia.dev/noctalia/templates/official/emacs?section=configuration-example

Examples for loading the theme directly or via an initialization hook.

```elisp
;; Load Noctalia theme
(load-theme 'noctalia t)
```

```elisp
;; Load Noctalia theme after startup
(add-hook 'after-init-hook (lambda () (load-theme 'noctalia t)))
```

--------------------------------

### Example plugin commands

Source: https://docs.noctalia.dev/noctalia/plugins/official-plugins

Commands to interact with the reference example plugin's widgets and panels.

```bash
plugin noctalia/example:hello focused set "New label"
```

```bash
plugin noctalia/example:hello focused fetch "https://example.com"
```

```bash
panel-toggle noctalia/example:panel
```

--------------------------------

### Inline Expression Examples

Source: https://docs.noctalia.dev/noctalia/theming/templates?section=blocks

Examples of accessing theme token map values.

```text
{{ colors.primary.default.hex }}
{{ colors.surface.dark.rgb }}
{{ mode }}
{{ image }}
```

--------------------------------

### Control Block Examples

Source: https://docs.noctalia.dev/noctalia/theming/templates?section=blocks

Examples of loop and conditional logic within templates.

```text
<* for name, value in colors *>
{{ name }}={{ value.default.hex }}
<* endfor *>
```

```text
<* if {{ loop.first }} *>
first
<* else *>
not first
<* endif *>
```

--------------------------------

### Template Configuration Example

Source: https://docs.noctalia.dev/noctalia/theming/app-theming?section=built-in-templates

A comprehensive example of template configuration within a dotfile-managed TOML file.

```toml
[theme.templates]
enable_builtin_templates   = true
enable_community_templates = true
builtin_ids                = []
community_ids              = []


[theme.templates.user.my_app]
input_path  = "$XDG_CONFIG_HOME/noctalia/templates/my-app.css"
output_path = "$XDG_CONFIG_HOME/my-app/theme.css"
```

--------------------------------

### For Loop Example

Source: https://docs.noctalia.dev/noctalia/theming/templates?section=conditionals

Iterating over a collection of colors using the for block.

```text
<* for name, value in colors *>
{{ name }}={{ value.default.hex }}
<* endfor *>
```

--------------------------------

### Apply string filters

Source: https://docs.noctalia.dev/noctalia/theming/templates?section=blocks

Examples of string manipulation filters for case conversion and replacement.

```liquid
{{ mode | replace: "dark", "night" }}
{{ "surface container high" | snake_case }}
```

--------------------------------

### Apply string filters

Source: https://docs.noctalia.dev/noctalia/theming/templates?section=available-color-tokens

Examples of string manipulation filters for text formatting.

```liquid

{{ mode | replace: "dark", "night" }}
{{ "surface container high" | snake_case }}

```

--------------------------------

### Apply color-argument filters

Source: https://docs.noctalia.dev/noctalia/theming/templates?section=blocks

Examples of filters that accept another color as an argument or convert strings to colors.

```liquid
{{ colors.primary.default.hex | blend: "#ff0000", 0.5 }}
{{ colors.primary.default.hex | harmonize: "#00ff88" }}
{{ "#ffaa00" | to_color | darken 10 }}
```

--------------------------------

### Conditional If-Else Example

Source: https://docs.noctalia.dev/noctalia/theming/templates?section=conditionals

Using if and else blocks to conditionally render content based on loop state.

```text
<* if {{ loop.first }} *>
first
<* else *>
not first
<* endif *>
```

--------------------------------

### Generate Numeric Ranges

Source: https://docs.noctalia.dev/noctalia/theming/templates?section=blocks

Create integer sequences using start..end syntax.

```text

<* for i in 0..16 *>
color{{ i }}=...
<* endfor *>

```

```text

<* for i in -2..3 *>
offset={{ i }}
<* endfor *>

```

--------------------------------

### Palette Color Examples

Source: https://docs.noctalia.dev/noctalia/theming/templates?section=blocks

Common usage patterns for retrieving hex, HSL, and stripped hex color values.

```jinja2
{{ colors.primary.default.hex }}
{{ colors.surface.light.hsl }}
{{ colors.terminal_foreground.default.hex_stripped }}
```

--------------------------------

### Initialize matugen in init.lua

Source: https://docs.noctalia.dev/noctalia/templates/community/neovim

Call the setup function in your init.lua to apply the theme upon Neovim startup.

```lua

 require('matugen').setup()

```

--------------------------------

### Install wlopm for DPMS

Source: https://docs.noctalia.dev/noctalia/compositor-settings/labwc

Command to install wlopm on Arch Linux.

```bash
sudo pacman -S wlopm
```

--------------------------------

### Taskbar Configuration Example

Source: https://docs.noctalia.dev/noctalia/bar/widgets/taskbar

A complete configuration block for the taskbar widget, demonstrating both flat and workspace-grouped settings.

```toml
[widget.taskbar]
pinned = ["firefox", "code", "kitty"]
pinned_opacity = 0.5
icon_scale = 1.0
item_spacing = 4  # Flat taskbar only; ignored when workspace grouping is enabled
group_by_workspace = true
show_all_outputs = true
only_active_workspace = true
show_workspace_label = true
workspace_label_placement = "corner"
hide_empty_workspaces = true
workspace_group_capsule = true
workspace_group_content = "icons"
group_single_icon_per_app = true
show_active_indicator = true
active_indicator_color = "primary"
active_opacity = 1.0
inactive_opacity = 1.0
focused_color = "primary"
occupied_color = "secondary"
empty_color = "secondary"
urgent_color = "error"
focused_output_only = false  # true = only the focused monitor highlights its active workspace
```

--------------------------------

### Setup Greeter Log Directory

Source: https://docs.noctalia.dev/greeter?section=nixos

Ensure the required state directory exists for the greeter logs.

```bash
just setup-log-dir
```

--------------------------------

### Build and Install Noctalia

Source: https://docs.noctalia.dev/noctalia/getting-started/installation?section=alternative-build-from-source-using-xbps-src

Commands for building and installing Noctalia in release mode.

```bash
# Optimized release build in build-release/
just configure release
just build release


# Install the selected build mode. This does not build or reconfigure.
sudo just install release
```
Tokens:
Raw