Samuel Onoja
eb84104940
Publish the guides from this repository to the GitHub Wiki. Organize them into Usage, Configuration and Development, with 15 separate configuration topics and redirects for the former website guide URLs. Add a tabbed-windows guide covering grouping, switching tabs and taking windows out. Document the scrolling indicator's defaults and limits, and link the guide from the README, shortcuts and IPC pages. Update from main, including the latest tabbed-layout changes. Separate Activities setup, configuration and publishing documentation. Review the guide prose with the unslop skill, keeping existing examples and heading links. The wiki workflow uses GitHub's built-in token to publish documentation changes on main. Validation: - 20 documentation tests pass, including README links and Activities/tab-indicator field coverage. - The publisher builds 46 wiki pages; the site build and Python syntax checks pass. - All 115 code examples from main are preserved. - The Python suite passes: 90 tests passed and 31 opt-in integration tests skipped, with the system GI module available.
7.7 KiB
A configurable Wayland desktop
Install · Configure · Screenshots · Documentation
Ferese combines a window manager and desktop shell with one configuration.
Features
- Scrolling columns, tabbed window groups, tree tiling and floating windows with saved size and position
- Integrated shell with notifications, media controls, Settings and Control Center
- Custom panels with seven styles, editable groups and items, and top or bottom placement
- Live Activities for build status, running commands and progress from connected apps
- Workspace overview and recent-window switching
- Continuum animations: interruptible springs, gesture momentum and shared motion controls
- Live wallpapers and blur, custom KDL themes, and Light/Dark/Auto modes
- Multiple monitors, fractional scaling and lower refresh rates on low battery
- Wi-Fi, Bluetooth and audio controls
- Custom keyboard shortcuts and touchpad gestures
- Screenshot annotation, screen sharing and recording
- Lock screen and authentication dialogs
- Keep awake during fullscreen media playback or for selected apps
- Continuous corners for windows and shell
How Ferese compares
Ferese combines scrolling and tree layouts with its own desktop controls. The table compares current upstream features and names separate tools where they are needed.
| Feature | Ferese | Hyprland | niri |
|---|---|---|---|
| Tiling layouts | Scrolling columns and tree tiling; switch per workspace | Scrolling, dwindle, master and monocle; per-workspace layouts | Scrolling columns |
| Floating windows | Built in | Built in | Built in |
| Workspace overview | Built in | Plugins such as HyprExpo | Built in |
| Animations | Continuum: interruptible springs, gesture momentum; speed and reduced-motion settings shared by the compositor and shell | Bézier and spring curves | Spring and easing animations; custom shaders |
| Corner shapes | Continuous corners across windows and shell | Rounded corners and squircles | Rounded corners with optional clipping |
| Live configuration reload | Yes | Yes | Yes |
| Monitor mirroring | Built in | Built in | Separate tool, such as wl-mirror |
| Desktop controls | Included Settings and Control Center | Separate utilities or a desktop shell | Separate desktop shell or tools |
| Notifications | Included in ferese-shell | Separate notification daemon | Separate notification daemon or shell |
| Lock screen | Included ferese-lock | Separate hyprlock | Separate locker, such as swaylock or hyprlock |
| Screen-sharing backend | xdg-desktop-portal-ferese | xdg-desktop-portal-hyprland | xdg-desktop-portal-gnome |
Ferese's shell, Settings, lock screen and dialogs use a shared theme. Other desktop shells, including DankMaterialShell and Noctalia, also include desktop controls; their features depend on the shell and tools you install.
Install
Fedora and Arch package builds are covered in Packages and releases.
Start with the dependencies, then clone Ferese and build it as your normal user:
git clone https://github.com/ferese-wm/ferese.git
cd ferese
./scripts/install.sh
Once it’s installed, log out and choose Ferese at your login screen, or run
ferese-session from a TTY or a greeter that accepts a command. The installation
guide also walks you through previews, updates and recovery.
Configure
Configure Ferese through Control Center → Settings or ~/.config/ferese/config.kdl.
Changes apply live, and if an edit is invalid, the last working configuration stays
in place.
The configuration reference and example config cover appearance, window layouts, displays and startup apps.
Default shortcuts
Use Super, usually the Windows key, to move around your desktop, and open Settings →
Shortcuts whenever you want to change a shortcut or gesture.
| Control | Action |
|---|---|
| Super + Enter | Open a terminal |
Display Fn key (XF86Display) |
Choose the display mode |
| Media Play / Pause, Next, Previous | Control the selected MPRIS player |
| Super + H / J / K / L | Focus left / down / up / right |
| Super + Backspace | Return to the last focused window |
| Super + Escape | Toggle between the last two visited workspaces on this monitor |
| Alt + Tab / Alt + Shift + Tab | Preview recent windows forward / backward; release Alt to select, Escape to cancel |
| Super + F | Maximize the window |
| Super + Shift + F | Toggle fullscreen |
| Super + R | Cycle column width |
| Super + Tab | Open overview |
| Super + M | Switch scrolling / tree layout |
| Print Screen | Capture the active monitor and open Satty |
| Super + Shift + S | Select a screenshot area |
| Super + Shift + E | Ask to log out |
| Super + left-button drag | Move a floating window |
| Super + right-button drag | Resize a floating window |
| Three-finger swipe up / down | Next / previous workspace |
| Three-finger swipe left / right | Focus the window to the right / left |
See all shortcuts and mouse actions for window and workspace controls.
Documentation
The documentation index lists the desktop guides. Development instructions cover building, testing and contributing.
Ferese is written in Rust using Smithay. Development happens on GitHub. If something goes wrong, open an issue with the steps to reproduce it and any relevant logs.