Skip to content

Commit

Permalink
ecosystem: add more pages
Browse files Browse the repository at this point in the history
  • Loading branch information
vaxerski committed Oct 15, 2024
1 parent 6b155c0 commit 436bd36
Show file tree
Hide file tree
Showing 7 changed files with 90 additions and 1 deletion.
13 changes: 12 additions & 1 deletion pages/Hypr Ecosystem/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,20 @@ These docs always target latest -git branch of respective apps.
{{< /callout >}}

## Wiki pages

### Apps/utilities for the user
- **[hyprpaper](./hyprpaper)**
- **[hyprpicker](./hyprpicker)**
- **[hypridle](./hypridle)**
- **[hyprlock](./hyprlock)**
- **[hyprcursor](./hyprcursor)**
- **[xdg-desktop-portal-hyprland](./xdg-desktop-portal-hyprland)**
- **[hyprsysteminfo](./hyprsysteminfo)**
- **[hyprsunset](./hyprsunset)**

### Libraries and other utilities
- **[hyprcursor](./hyprcursor)**
- **[hyprutils](./hyprutils)**
- **[hyprlang](./hyprlang)**
- **[hyprwayland-scanner](./hyprwayland-scanner)**
- **[aquamarine](./aquamarine)**

27 changes: 27 additions & 0 deletions pages/Hypr Ecosystem/aquamarine.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
weight: 11
title: aquamarine
---

aquamarine is a very light linux rendering backend library.

It is not a replacement or competitor to any other wayland compositor library (e.g. wlroots, libweston), instead implementing only the low-level KMS/DRM/etc rendering backends.

## Configuration

Configuration options are passed via environment variables starting with `AQ_` to an app that uses aquamarine, e.g. Hyprland.

### Variables

| name | description |
| --- | --- |
| `AQ_TRACE` | Enables trace (very, very verbose) logging. |
| `AQ_DRM_DEVICES` | A colon-separated list of DRM devices (aka. GPUs) to use. The first will be used as primary. Example: `/dev/dri/card1:/dev/dri/card0`. |
| `AQ_NO_MODIFIERS` | Disables modifiers for DRM buffers. |
| `AQ_MGPU_NO_EXPLICIT` | Disables passing of explicit fences for multi-gpu scanouts |
| `AQ_NO_ATOMIC` | (HEAVILY NOT RECOMMENDED) Disable atomic modesetting. |

## Documentation

Documentation will come soon.

9 changes: 9 additions & 0 deletions pages/Hypr Ecosystem/hyprlang.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
weight: 9
title: hyprlang
---

hyprlang is a library that implements parsing for the hypr configuration language.

See the documentation at [hyprland.org/hyprlang](https://hyprland.org/hyprlang/).

19 changes: 19 additions & 0 deletions pages/Hypr Ecosystem/hyprsunset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
weight: 7
title: hyprsunset
---

hyprsunset is a small utility to provide a blue light filter
for your system.

This method is preferred to screen shaders as it will _not_ be captured via recording / screenshots.

{{< callout type=warning >}}

`hypsunset` is supported since Hyprland 0.45.0.

{{< /callout >}}

## Usage

See `hyprsunset --help`.
7 changes: 7 additions & 0 deletions pages/Hypr Ecosystem/hyprsysteminfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
weight: 8
title: hyprsysteminfo
---

hyprsysteminfo is a small GUI application to display your system information,
as well as easily copy the hyprland version or system info to your clipboard.
6 changes: 6 additions & 0 deletions pages/Hypr Ecosystem/hyprutils.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
weight: 9
title: hyprutils
---

hyprutils is a library providing shared implementations of commonly used types across the hypr* ecosystem.
10 changes: 10 additions & 0 deletions pages/Hypr Ecosystem/hyprwayland-scanner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
weight: 10
title: hyprwayland-scanner
---

hyprwayland-scanner, also called hw-s, is a utility to generate sources and headers
for wayland protocol specifications.

It is similar to wayland-scanner, but instead of C, it generates neat and safe C++ implementations.

0 comments on commit 436bd36

Please sign in to comment.