i3-compatible Wayland compositor
Go to file
Tony Crisci d071ff08ae remove the rest of cmake 2017-12-01 05:21:03 -05:00
assets Recompressed PNG files 2017-01-05 21:49:28 -05:00
common remove relevant CMakeLists.txt 2017-11-30 11:54:01 -05:00
completions/zsh remove relevant CMakeLists.txt 2017-11-30 11:54:01 -05:00
contrib Move awesome config to contrib/ 2017-01-14 16:03:41 -05:00
include Handle view destruction properly 2017-11-25 16:30:15 -05:00
protocols remove the rest of cmake 2017-12-01 05:21:03 -05:00
security.d add meson install files 2017-11-30 08:31:13 -05:00
sway remove relevant CMakeLists.txt 2017-11-30 11:54:01 -05:00
swaybar remove the rest of cmake 2017-12-01 05:21:03 -05:00
swaybg remove the rest of cmake 2017-12-01 05:21:03 -05:00
swaygrab remove the rest of cmake 2017-12-01 05:21:03 -05:00
swaylock remove the rest of cmake 2017-12-01 05:21:03 -05:00
swaymsg remove relevant CMakeLists.txt 2017-11-30 11:54:01 -05:00
wayland remove the rest of cmake 2017-12-01 05:21:03 -05:00
.build.yml Also need meson 2017-11-11 09:09:17 -05:00
.clang-format Update .clang-format - not entirely usable yet 2017-01-10 23:30:34 -05:00
.editorconfig Create .editorconfig 2016-07-04 14:12:32 +02:00
.gitignore remove the rest of cmake 2017-12-01 05:21:03 -05:00
.travis.yml Also need meson 2017-11-11 09:09:17 -05:00
CONTRIBUTING.md Update README et al with new links 2017-10-02 22:26:37 -04:00
HACKING.md Add HACKING.md 2017-04-29 10:54:08 -04:00
LICENSE MIT license 2017-01-06 13:45:48 -05:00
README.de.md Update README.md 2017-11-02 17:35:57 +01:00
README.el.md Update README.el.md 2017-11-01 12:08:23 +02:00
README.fr.md Update README.md 2017-11-02 17:35:57 +01:00
README.it.md Update README.md 2017-11-02 17:35:57 +01:00
README.ja.md Update README.md 2017-11-02 17:35:57 +01:00
README.md remove the rest of cmake 2017-12-01 05:21:03 -05:00
README.pt.md Update README.md 2017-11-02 17:35:57 +01:00
README.ru.md Update README.md 2017-11-02 17:35:57 +01:00
README.uk.md Update README.md 2017-11-02 17:35:57 +01:00
config.in add meson install files 2017-11-30 08:31:13 -05:00
meson.build meson zsh completions install 2017-11-30 11:51:58 -05:00
meson_options.txt meson zsh completions install 2017-11-30 11:51:58 -05:00
sway.desktop Add Wayland and Xorg session files 2015-08-20 23:12:34 +02:00

README.md

sway Donate with fosspay

English - 日本語 - Deutsch - Ελληνικά - Français - Українська - Italiano - Português - Русский

"SirCmpwn's Wayland compositor" is a work in progress i3-compatible Wayland compositor. Read the FAQ. Join the IRC channel (#sway on irc.freenode.net).

Notice: Sway is currently frozen and no new features are being shipped until we finish integrating Sway and wlroots. Bug fixes are still going out. for more information, see this article. To follow wlroots integration status, see this ticket.

If you'd like to support Sway development, you can contribute to SirCmpwn's Patreon page or you can contribute to bounties for specific features. Anyone is welcome to claim a bounty and you can make a bounty for any feature you wish, and Patreon is more useful for supporting the overall health and maintenance of Sway.

Release Signatures

Releases are signed with B22DA89A and published on GitHub.

Status

Installation

From Packages

Sway is available in many distributions. Try installing the "sway" package for yours. If it's not available, check out this wiki page for information on installation for your distributions.

If you're interested in packaging Sway for your distribution, stop by the IRC channel or shoot an email to sir@cmpwn.com for advice.

Compiling from Source

Install dependencies:

  • meson
  • wlroots
  • wayland
  • xwayland
  • libinput >= 1.6.0
  • libcap
  • asciidoc
  • pcre
  • json-c <= 0.12.1
  • pango
  • cairo
  • gdk-pixbuf2 *
  • pam **
  • dbus >= 1.10 ***
  • imagemagick (required for image capture with swaygrab)
  • ffmpeg (required for video capture with swaygrab)

*Only required for swaybar, swaybg, and swaylock

**Only required for swaylock

***Only required for tray support

Run these commands:

meson build
ninja -C build
sudo ninja -C build install

On systems with logind, you need to set a few caps on the binary:

sudo setcap "cap_sys_ptrace,cap_sys_tty_config=eip" /usr/local/bin/sway

On systems without logind, you need to suid the sway binary:

sudo chmod a+s /usr/local/bin/sway

Configuration

If you already use i3, then copy your i3 config to ~/.config/sway/config and it'll work out of the box. Otherwise, copy the sample configuration file to ~/.config/sway/config. It is usually located at /etc/sway/config. Run man 5 sway for information on the configuration.

Running

Run sway from a TTY. Some display managers may work but are not supported by Sway (gdm is known to work fairly well).