maomaowm/README.md
2026-05-11 14:32:37 +08:00

102 lines
4.3 KiB
Markdown

<div align="center">
<img src="https://github.com/mangowm/mango/blob/main/assets/mango-transparency-256.png" alt="Mango Logo" width="120"/>
<h1>Mango Wayland Compositor</h1>
<p>A fast, feature-rich Wayland compositor built on <a href="https://codeberg.org/dwl/dwl">dwl</a></p>
<a href="https://github.com/mangowm/mango/stargazers"><img src="https://img.shields.io/github/stars/mangowm/mango?style=flat&color=orange" alt="Stars"/></a>
<a href="https://github.com/mangowm/mango/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-GPL--3.0-blue?style=flat" alt="License"/></a>
<a href="https://repology.org/project/mangowm/versions"><img src="https://repology.org/badge/tiny-repos/mangowm.svg" alt="Packaged in"/></a>
<a href="https://discord.gg/CPjbDxesh5"><img src="https://img.shields.io/discord/1430889676264177687?style=flat&logo=discord&label=discord" alt="Discord"/></a>
</div>
---
https://github.com/user-attachments/assets/bb83004a-0563-4b48-ad89-6461a9b78b1f
> See all layouts in action at [mangowm.github.io](https://mangowm.github.io/)
## Why Mango?
Mango starts where dwl ends. It keeps the lightweight, fast-build philosophy while adding the features that make a compositor actually usable day-to-day — without the bloat.
- **Lightweight & fast** — as lean as dwl, builds in seconds, no functionality compromised
- **Excellent xwayland support** — run X11 apps without friction
- **Tags, not workspaces** — each tag maintains its own independent window layout
- **Smooth animations** — window open/move/close, tag transitions, layer surfaces
- **Flexible layouts** — scroller, master-stack, monocle, dwindle, grid, and more
- **Rich window states** — swallow, minimize, maximize, global, overlay, fakefullscreen
- **Window effects** — blur, shadow, corner radius, opacity (via scenefx)
- **Excellent input method support** — text-input v2/v3
- **Sway-like scratchpad** — named scratchpad support included
- **Hycov-style overview** — see all windows at a glance
- **IPC** — send/receive messages from external programs
- **Hot-reload config** — no restart needed for keybinding changes
- **Zero flickering** — every frame is correct
## Vision
**Stability first.** After months of testing, Mango is solid enough for daily use. Breaking changes will be minimal.
**Practicality over novelty.** Features get added when they genuinely improve daily workflows — not for the sake of completeness.
**Focused scope.** Niche requests are evaluated by community interest. Significant upvotes move things forward.
## Installation
[![Packaging status](https://repology.org/badge/vertical-allrepos/mangowm.svg)](https://repology.org/project/mangowm/versions)
### Arch Linux
```bash
yay -S mangowm-git
```
### Other distributions
See the [Installation Guide](https://mangowm.github.io/docs/installation) for Fedora, Gentoo, Guix, NixOS, openSUSE, PikaOS, AerynOS, and building from source.
## Documentation
- **[mangowm.github.io](https://mangowm.github.io/)** — website docs with configuration reference, keybindings, layouts, IPC, and more
- **[GitHub Wiki](https://github.com/mangowm/mango/wiki/)** — community-maintained wiki
## Community
Join us on **[Discord](https://discord.gg/CPjbDxesh5)**
## Acknowledgements
- [wlroots](https://gitlab.freedesktop.org/wlroots/wlroots) — Wayland protocol implementation
- [dwl](https://codeberg.org/dwl/dwl) — the foundation Mango builds on
- [scenefx](https://github.com/wlrfx/scenefx) — window effects library
- [owl](https://github.com/dqrk0jeste/owl) — animation groundwork
- [sway](https://github.com/swaywm/sway) — protocol reference
## Sponsor
If Mango makes your desktop better, consider supporting its development.
Thanks to everyone who has sponsored this project:
<table>
<tr>
<!-- add new sponsors here: copy the <td>...</td> block below -->
<td align="center">
<a href="https://github.com/tonybanters">
<img src="https://unavatar.io/github/tonybanters" width="48" style="border-radius:50%"/><br/>
<sub>tonybanters</sub>
</a>
</td>
</tr>
</table>
Crypto donations accepted — scan the QR code or send to the address shown:
<details>
<summary>Show QR code</summary>
<br/>
<img width="300" alt="sponsor QR" src="https://github.com/user-attachments/assets/8c860317-90d2-4071-971d-f1a92b674469" />
</details>