Jay 1.14.0

Fixes

As always, this release contains many bug fixes. Thanks to the following people
for reporting or fixing bugs:

• @effects3d
• @jfrob
• @khyperia
• @kotarac
• @krakow10
• @Ktrompfl
• @Nojike
• @polycatenane
• @Stoppedpuma

Every Frame is Perfect

Wayland allows compositors and clients to coordinate changes such that every
frame is perfect. For example, when resizing two tiles, the transition can be
coordinated so that each window fills its respective tile at all times.

Until now, Jay did not make use of this. When resizing a window from the left,
the right side of the window might disappear below the border or might appear
detached from the border.

bad.mp4

Jay will now try to make every frame perfect. This is accomplished by delaying
changes on screen until all affected clients have also updated themselves. A
timeout is used so that a slow client does not cause the entire system to lag.

good.mp4

The default timeout is 50 milliseconds, which is ambitious. Sway uses a timeout
of 200 milliseconds and niri uses a timeout of 300 milliseconds.

The timeout can be adjusted in the config and in the control center:

[transactions]
timeout.millis = 200

Note that transactions only affect what is displayed on screen. The cursor
interacts with the actual state, which might be newer. The timeout determines
the maximum input lag of this mechanism, so to speak. In most cases applications
will respond far sooner than the timeout and the difference will be
imperceptible.

Setting the timeout to 0 will give you the previous behavior of Jay, except that
in some rare situations a change might be delayed by one frame where it
previously wouldn't have been.

Improved Prime Handling

On multi-GPU systems, Jay will now always ensure that buffers rendered on
secondary GPUs are copied to the primary GPU before they are used by the
compositor. This ensures that such copies are not performed implicitly when
rendering, which would increase whole-system latency.

As a side effect, this means that it is now possible to seamlessly switch the
primary GPU at runtime. Previously, this often required applications to be
restarted. For example, on a gaming laptop, you might want to normally run on
the integrated GPU to save energy. But while gaming, you might want to run on
the dedicated GPU instead, to reduce latency.

For clients using version 6 of the wayland dmabuf protocol, Jay is also able to
perform the following optimization: If an application runs on a secondary GPU
and is being scanned out on a display connected to the secondary GPU, Jay will
skip the copy to the primary GPU. This can significantly improve the performance
of such applications. Note that mesa does not yet support version 6 of the
protocol.

All of this can be disabled by setting the environment variable
JAY_NO_CLIENT_PRIME=1 before starting Jay.

Repeating and Locked Shortcuts

Shortcuts can now be configured to repeat:

[complex-shortcuts]
XF86AudioRaiseVolume = {
    action.type = "exec",
    action.exec.shell = "pactl set-sink-volume 0 +10%",
    repeat = true,
}

A repeating shortcut fires according to the configured repeat rate and delay.

Setting allow-locked = true allows a shortcut to execute while the screen is
locked. Care must be taken to not apply this to shortcuts that would allow one
to circumvent the lock screen.

Thanks to @GK-Gaming for suggesting this.

Auto Floating of Fixed-Size Windows

When a client hints that a native wayland window is fixed-size, it will now
automatically be mapped floating instead of tiled. This behavior can be
overridden with window rules.

This can improve the handling of some windows such as splash screens. If you
encounter a window where this behavior is incorrect, please open an issue.

Furthermore, when mapping a floating window, the size will now be adjusted to
fall within the min/max size hinted by the client. The user can still resize the
window to any size.

Thanks to @effects3d for suggesting this.

Focused Border Color

Containers can now be configured to have borders drawn around them:

[theme]
container-borders = "full"

When this setting is active, focused windows can be given a dedicated border
color:

[theme]
focused-border-color = "#840"

This makes it possible to see which window has the focus when window titles are
disabled.

Thanks to @Stoppedpuma for suggesting this.

Scroll Methods

The libinput scroll method of pointer devices can now be configured:

[[inputs]]
match.is-pointer = true
scroll-method = "on-button-down"
scroll-button = "BTN_MIDDLE"

This does not affect scroll wheels but rather devices where pointer movements
and scroll events are generated via the same input surface. For example, if the
configuration above were applied to a touchpad, it would generate scroll events
instead of relative motion events while the middle mouse button is pressed.

In the control center, the possible scroll-button values are visible via a
dropdown menu.

Thanks to @GK-Gaming for suggesting this.

Scaling with Nearest Filtering

Outputs can now be configured to use nearest filtering instead of linear
filtering:

[[outputs]]
match.serial-number = "ETW1M02062SL0"
scale = 2.0
scaling-filter = "nearest"

This produces a clearer picture when the scaling factor is an integer.

This should only affect applications running via Xwayland. Native wayland
applications should scale themselves.

Thanks to @David-Isenah for suggesting this.

Setting Initial Workspace Outputs

When creating new workspaces implicitly, such as by executing a
move-to-workspace action, the workspace would previously always be created on
the fallback output. Workspaces can now be configured ahead of time to be
created on a specific output:

[workspaces."1"]
initial-output.name = "left"

[workspaces."2"]
initial-output.name = "right"

Thanks to @Stoppedpuma for suggesting this.

Toml Improvements

The following improvements expose existing settings via the toml config.

Applying Device Configuration Every Time

The toml config now has a setting to apply device configurations on reload:

device-config-filter = "all"

By default, configuration changes are not applied to existing devices so as not
to overwrite changes made via the command line or the control center.

Thanks to @Stoppedpuma for suggesting this.

Disabling Input Devices

Input devices can now be disabled from the toml config:

[[inputs]]
match.name = "Sony Interactive Entertainment Wireless Controller Touchpad"
detached = true

Thanks to @ArthurHeymans for suggesting this.

Configuring the Cursor Size

The cursor size can now be configured via the toml config:

cursor-size = 30

This only affects cursors rendered by the compositor.

Thanks to @GK-Gaming for suggesting this.

Visualizing Compositing

Sometimes it is useful to know if direct scanout is active or inactive, for
example, to diagnose performance issues. Jay can now display a watermark on
screen while it is compositing; the watermark disappears automatically when
direct scanout is active:

[shortcuts]
alt-x = "toggle-visualize-compositing"

Upholding the graphical-session.target

Jay will now ensure that the systemd graphical-session.target is active while
it is running. This works around a recent regression in xdg-desktop-portal that
otherwise prevents screencasts and similar features from working under most
compositors.

Thanks to @krakow10 for reporting this.

Jay Environment Variables

Jay reads a number of environment variables at startup to configure itself.
These variables are now documented in the book in the Env Variables Read by
Jay section.

dlopen() Metadata

The Jay executable now contains dlopen metadata that can be used by packagers
to determine which libraries Jay will try to load at runtime and for which
purpose:

~$ systemd-analyze dlopen-metadata $(which jay)
FEATURE DESCRIPTION                      SONAME          PRIORITY
sqlite  required for session management  libsqlite3.so.0 recommended
opengl  required for the opengl renderer libGLESv2.so.2  recommended
opengl  required for the opengl renderer libEGL.so.1     recommended
vulkan  required for the vulkan renderer libvulkan.so.1  recommended

Windows BT.2100 Color Descriptions

Jay now supports version 3 of the color management protocol and BT.2100 color
descriptions used by Wine.

Protocol Updates and Additions

This version of Jay supports the following new and improved protocols:

Global	Old	New
wl_seat	10	11
wp_color_manager_v1	2	3
zwp_linux_dmabuf_v1	5	6

Jay 1.13.0

Fixes

As always, this release contains many bug fixes. Thanks to the following people
for reporting or fixing bugs:

• @Ktrompfl
• @luvvlyjude
• @polycatenane
• @Stoppedpuma

The Jay Book

Jay now has a book that makes it easier to
get started with Jay and to discover its various features. For example, did you
know that you can toggle windows between floating and tiled by double-clicking
on their titles? Or that Jay has a window-management mode that allows you to
drag fullscreen windows between outputs? Previously there was no way to discover
these features if you didn't follow Jay development closely.

The book was written with the help of large language models. If you don't want
to consume that kind of content, the reference documentation of the toml config
and the Jay code itself remains free of AI, as far as I know.

Session Management

Jay now supports the session-management protocol that allows application windows
to be restored after a restart.

In tiling window managers, restoring the exact layout is often not possible, for
example, tiles created by other applications might no longer exist. Therefore,
restoration is limited to the following features:

• Restoring windows on the original workspace.
• Restoring windows on the original output.
• Restoring fullscreen windows fullscreen.
• Restoring floating windows with the same size and position.

Session state is stored in an SQLite database under ~/.local/share/jay/db.
This feature is only available if Jay is able to load libsqlite3.so at
runtime.

Overlay Workspaces

Jay now supports overlay workspaces, also known as special workspaces or
scratchpads in other compositors.

alt-x = { type = "toggle-overlay", name = "overlay" }

Overlays are like normal workspaces except that both a normal workspace and an
overlay can be visible on the same output at once.

Overlays are always rendered above all other surfaces including all layer-shell
surfaces and fullscreen windows.

Floating windows can be moved from a normal workspace to an overlay workspace by
dragging them onto the output showing the overlay. If the window is already on
that output, this happens as soon as the window title is clicked.

Conversely, a floating window can be moved off of the overlay workspace by
dragging it onto an output that isn't showing an overlay. If you're holding onto
the title of such a window and then hide the overlay on the output, the window
is also moved to the normal workspace below.

Of course, the normal move-to-workspace action also works for overlays.

Windows on overlays are distinguished from other windows by showing a layer icon
in their title. Similarly, if an overlay is visible on an output, it appears in
the bar with a layer icon next to its name. You can hide overlays by
middle-clicking their name in the bar.

See the Overlays chapter in the book for more details.

Thanks to @Stoppedpuma for suggesting this.

Custom config.so With Privileges

It is recommended to give the Jay executable the CAP_SYS_NICE filesystem
capability to improve responsiveness under high system load.

~$ sudo setcap cap_sys_nice=p $(which jay)

Previously, doing this fully disabled loading of custom config.so for the
following reason: Any unprivileged application could have created a config.so,
placed it in ~/.config/jay and started Jay to run arbitrary code with the
CAP_SYS_NICE capability, possibly enabling a local denial-of-service attack.

This meant that the toml config was privileged since it was the only config type
able to run with privileges. Jay's config system was designed from the start to
allow people to write arbitrary config.so's. For example, if someone wanted to
write a config that uses Lua instead of toml, they should be able to do so.

Jay will now load config.so even when running with capabilities as long as the
config.so is owned by the root user. If you want to use such a config.so, simply
sudo chown root:root config.so. If you have a config.so that was installed as
root by a package manager, you can create a symlink to it without having to
invoke sudo.

Keymap Shortcuts Group

When using non-Latin layouts, it can sometimes be troublesome to invoke keyboard
shortcuts. For example

keymap.rmlvo = {
    layout = "us,ru",
    options = "grp:ctrl_space_toggle",
}

[shortcuts]
alt-h = "focus-left"

When in the Russian layout, pressing alt-h would not invoke the shortcut
because the h key does not produce the h keysym.

Jay now supports specifying a dedicated shortcuts group for a keymap.

keymap.rmlvo = {
  layout = "us,ru",
  options = "grp:ctrl_space_toggle",
}
keymap.shortcuts-group = 0

This means that shortcuts are always evaluated against the first (starting at 0)
group in the keymap. Pressing alt-h will therefore invoke the shortcut because
the h key produces the h keysym in the US layout.

Virtual Outputs and Headless Backend

Jay now supports virtual outputs. Virtual outputs act like normal outputs as far
as applications are concerned but are not connected to any physical hardware.
They support arbitrary modes, VRR, and tearing.

Virtual outputs can be created in the control center in the virtual outputs
pane, on the command line, or in the config.

~$ jay randr virtual-output create abc

[shortcuts]
alt-x = { type = "create-virtual-output", name = "abc" }

Once created, they can be configured like any other output.

Jay now also supports a headless backend, that is, a backend that doesn't use
any physical hardware. You can interact with such a Jay instance by using
virtual outputs and any remote-desktop solution.

Warp To Focus

Jay now supports warping the cursor to the center of the focused window. This
can be done either automatically or with an action.

# automatic
unstable-mouse-follows-focus = true

# manual
[shortcuts]
alt-x = "warp-mouse-to-focus"

Due to limitations in Jay's layout algorithm, the automatic warping is still
considered unstable and its behavior might change in the future.

Thanks to @Ktrompfl for implementing this.

Config Subcommand

The Jay CLI now has a config subcommand to make it easier to initialize and find
the toml config.

~$ jay config       
Create/modify the toml config

Usage: jay config <COMMAND>

Commands:
  init      Initialize the toml config file
  path      Print the path to the config
  open-dir  Open the config directory with xdg-open
  help      Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

CLI JSON Output

Most CLI commands now support JSON output for scripting.

~$ jay --json randr | jq . | head -10
{
  "drm_devices": [
    {
      "devnode": "/dev/dri/card0",
      "syspath": "/sys/devices/pci0000:00/0000:00:08.1/0000:14:00.0",
      "vendor": 4098,
      "vendor_name": "Advanced Micro Devices, Inc. [AMD/ATI]",
      "model": 5710,
      "model_name": "Raphael",
      "gfx_api": "Vulkan",

Deleting Old Log Files

Jay stores its logs in ~/.local/share/jay/log/jay. Previously these log files
were never automatically deleted. You can now configure Jay to delete log files
whose Jay instance has already terminated.

clean-logs-older-than.days = 5

Thanks to @khyperia for implementing this.

Resizing and Moving Windows with Actions

The new resize action can be used to move or resize windows.

alt-x = { type = "resize", dx1 = -10, dx2 = -10 }

This works for both floating and tiled windows.

Thanks to @BergmannAtmet for suggesting this.

Color Management Improvements

Jay now supports the following rendering intents in addition to the perceptual
intent:

• absolute_no_adaptation
• relative
• relative_bpc

Numerical Workspace Sorting

When automatic workspace sorting is enabled, workspaces are now sorted
numerically instead of lexicographically. For example,

• 1
• 2
• 10

whereas previously 2 and 10 would be swapped.

Thanks to @llyyr for implementing this.

Vulkan Descriptor Heaps

Jay now supports the VK_EXT_descriptor_heap extension. It will be used if
available with a fallback to VK_EXT_descriptor_buffer as before.

The extension is available on the proprietary Nvidia driver and on radv if the
environment variable RADV_EXPERIMENTAL=heap is set before starting Jay.

Since drivers might still have bugs, use of descriptor heaps can be disabled by
starting jay with JAY_NO_DESCRIPTOR_HEAP=1.

Disabling Outputs

Outputs can now be disabled in the outputs array.

[[outputs]]
match.serial-number = "ETW1M02062SL0"
enabled = true

Previously this required disabling the connector via the connectors array.

Thanks to @marienz for implementing this.

Showing Workspaces Without Focusing Them

It is now possible to show a workspace on an output without moving the focus to
that workspace.

alt-x = { type = "show-workspace", name = "2", focus = false }

If this causes a workspace to be hidden that contains the focus, then the focus
is still moved to the new workspace. This is therefore primarily useful on
multi-monitor systems.

Pixel Scroll Multiplier

When using two-finger scrolling on a touchpad, you can now specify a multiplier
that applies to the scroll distance.

[[inputs]]
match.is-pointer = true
px-scroll-multiplier = 0.5

This has no effect on scroll events created by a mouse wheel.

Thanks to @luvvlyjude for suggesting this.

Topl...

Jay 1.12.0

Fixes

As always, this release contains many bug fixes. Thanks to the following people for
reporting or fixing bugs:

• @danielfrrrr
• @disluckyguy
• @effectsbot
• @flammablebunny
• @Jeff-WuYo
• @khyperia
• @kotarac
• @krakow10
• @KyunLFA
• @LeaPhant
• @llyyr
• @luvvlyjude
• @noxvail
• @Richochet1
• @rrtt217
• @sday-ssc
• @Stoppedpuma
• @uku3lig

Control Center

Jay now has a built-in control center that can be opened with the open-control-center
action. In the default config, this action is bound to alt-c.

The control center runs in the same thread as the rest of the compositor and therefore has
easy access to all compositor internals. In this version it does not make much use of this
ability and limits itself to exposing the capabilities that are already available through
the configuration and on the command line.

Since the control center runs in the same thread, it also takes away resources from the
rest of the compositor and might increase latency. You should close the control center
when you are not using it.

Support for Render-Only GPUs

Jay now supports render-only GPUs, that is, GPUs that themselves don't support driving
displays. This is useful on some embedded devices where the GPU that supports accelerated
rendering is render-only and displays are connected to a separate GPU that doesn't support
accelerated rendering. On such devices, you would want to use the render-only GPU as the
primary GPU.

You can test this via sudo modprobe vgem which will create a virtual render-only GPU.

Vulkan Improvements

• Jay now ships pre-compiled shaders. You no longer need to have shaderc installed to
  compile Jay.

• The renderer will now fall back to software rendering in virtual machines where
  accelerated rendering is not available. Previously this would fall back to software
  rendering via OpenGL.

• The blend space can now be configured. Previously the renderer always blended in linear
  space which made some transparent textures much lighter than intended. Since most
  textures are designed to be blended in sRGB space, this is the new default. If you're
  not using HDR, this is also significantly more efficient. The easiest way to temporarily
  change the blend space is in the control center in the outputs pane.

• Shared-memory buffers can now be imported directly into the renderer via the udmabuf
  mechanism. This can significantly improve the compositor-side performance by reducing
  the number of copies from 2 to 1. On integrated GPUs, the renderer will try to use such
  buffers directly as images, eliminating all copies.

• The renderer will now opportunistically use timeline semaphores as syncobjs which
  eliminates a significant number of system calls. This is known to not work with the
  Nvidia driver since it does not use syncobjs for timeline semaphores. A new vulkan
  extension for official timeline semaphore/syncobj interop is being discussed at Khronos,
  which would allow this feature to also work on Nvidia.

Toml Improvements

• exec actions now have a shell field to execute a program via the shell. For example,

  [shortcuts]
  alt-x = { type = "exec", exec.shell = "echo $WAYLAND_DISPLAY >file" }

• The config can now be reloaded automatically when the config file has changed. This is
  disabled by default and can be enabled with the top-level, boolean auto-reload field.

  Note that reloading the config has side effects such as reverting changes to the theme
  made via the command line and the control center.

  Thanks to @disluckyguy for implementing this.

Client Capabilities

Client rules can now grant clients additional capabilities. This allows more fine-grained
control over exposed globals in contrast to the existing feature that only allowed
granting all capabilities to a client. See the next section for an example.

Tagging Clients

You can now add a tag to applications launched via exec actions and on the command
line. This tag applies to the application and all of its children. For example, on the
command line

~$ jay run-tagged my-tag chromium

and in an action

[shortcuts]
alt-x = { type = "exec", exec.prog = "chromium", exec.tag = "my-tag" }

This tag can in turn be used in client rules to match clients:

[[clients]]
match.tag = "my-tag"
capabilities = ["data-control"]

Tags are incompatible with exec.privileged = true. All capabilities must be assigned via
client rules.

Pid Subcommand

The new jay pid subcommand prints the process ID of Jay and exits. This can be useful
when debugging issues and can be used as follows:

~$ cd /proc/$(jay pid)
~$ sudo strace -p $(jay pid)

Tray Applications

Jay now supports running almost all wayland-native applications as tray applications. This
can be accomplished with the
window-to-tray
tool from the wl-proxy project.

For example, to have an easily accessible volume mixer in the tray:

~$ window-to-tray pavucontrol-qt

Keymaps from RMLVO Names

In addition to XKB, keymaps can now also be specified via their RMLVO names that might be
known from other compositors:

keymap.rmlvo = {
    layout = "us,de",
    variants = "dvorak",
    options = "grp:ctrl_space_toggle",
}

Thanks to @khyperia for implementing this.

Night Light

Jay now supports night-light applications that attach gamma tables to outputs via
zwlr_gamma_control_manager_v1.

Thanks to @khyperia for implementing this.

Improved Multi-GPU Blits

On some systems, displays are connected to GPUs other than the GPU used for rendering. The
embedded scenario with render-only GPUs is one example. Another are laptops with dedicated
GPUs where the internal display is hard-wired to the iGPU and external displays are
hard-wired to the dGPU.

Jay has always supported such systems with the open-source mesa drivers. However, it did
not support using Nvidia devices as the primary GPU and the method used to copy images
from the primary GPU to the output GPU was not optimized.

This release adds several new implementations for these blits:

• direct-pull
• direct-sampling
• indirect-pull
• udmabuf
• direct-push

By default, the compositor will try to use the methods in this order. It is currently not
possible to know which method is the most optimal on a given system without trying them.
In the embedded scenario, direct-push is most likely the most efficient, but on a dual-AMD
system it is likely to crash the compositor due to bugs in the AMD driver.

You can modify the order in which these methods are attempted, and exclude methods, with
the JAY_PRIME_METHODS environment variable. For example:

~$ JAY_PRIME_METHODS=udmabuf,-direct-push jay run

This would result in the methods being attempted in this order:

• udmabuf
• direct-pull
• direct-sampling
• indirect-pull

On systems with an Nvidia primary device and mesa secondary devices, you might
need to explicitly select the udmabuf method due to bugs in the Nvidia driver.

Look & Feel Improvements

• The bar can now be moved to the bottom of the screen.

  [theme]
  bar-position = "bottom"

  Thanks to @kotarac for implementing this.

• The width of the separator between the bar and the rest of the output can now
  be configured.

  [theme]
  bar-separator-width = 2

  Thanks to @kotarac for implementing this.

• Directional commands now work across neighboring outputs.

  Thanks to @ArthurHeymans for implementing this.

• Jay can now be configured to display workspaces in alphabetical order.

  workspace-display-order = "sorted"

  Thanks to @kotarac for implementing this.

• All configurable sizes can now be reduced to 0 instead of 1.

• The bar and title heights can now be configured separately.

  [theme]
  title-height = 16
  bar-height = 17

Fallback Output Mode

By default, when opening new windows or executing actions that don't specify an output but
need an output, Jay will use the output that contains the cursor. To enable more
keyboard-centric workflows, Jay can now be configured to fall back to the output that has
the keyboard focus.

fallback-output-mode = "focus"

To allow this to work with empty outputs, it is now also possible to

• specify an output when creating a workspace

  [shortcuts]
  alt-x = { type = "show-workspace", name = "abcd", output.connector = "DP-3" }

• focus an empty workspace.

Thanks to @khyperia for implementing this.

Disabling Xwayland

If you don't need Xwayland and want to ensure that no application uses Xwayland,
you can now disable Xwayland outright:

[xwayland]
enabled = false

Thanks to @khyperia for implementing this.

Simple Input Method

If no external input method is used, Jay will now provide a built-in simple
input method. This IM can operate in two modes:

• By default, it provides completions based on ~/.XCompose.
• When the enable-unicode-input action is executed, it allows inputting
  characters by their unicode code point.

The simple input method can be disabled:

[simple-im]
enabled = false

Protocol Updates and Additions

This version of Jay supports the following new and improved protocols:

| Global | Old | New...

Jay 1.11.1

Fixes

This release fixes a bug that caused the compositor to abort on multi-GPU
systems in some situations. Thanks to @krakow10 for reporting this.

Jay 1.11.0

Fixes

As always, this release contains many bug fixes. Notably it changes the top layer in the
wlr-layer-shell-unstable-v1 protocol to be rendered below fullscreen windows. Previously
such layers were rendered on top of fullscreen windows which deviates from the behavior of
other compositors.

If this negatively affects your experience, try to configure the affected applications to
use the overlay layer instead.

Thanks to @disluckyguy for fixing this.

New and Improved Protocols

This release implements the following new protocols:

• xdg-toplevel-tag-v1

  This protocol allows clients to add a string tag to their windows. These tags can be
  used in window rules (see below).

• wlr-foreign-toplevel-management-unstable-v1

  This protocol allows task bars to display and manage application windows.

  Thanks to @disluckyguy for implementing this.

• wlr-output-management-unstable-v1

  This protocol allows applications to manage the position, mode, etc. of outputs.

  Thanks to @disluckyguy for implementing this.

• pointer-warp-v1

  This protocol allows applications to warp the cursor within their own windows.
  Previously some applications abused the pointer-constraints-unstable-v1 protocol for the
  same purpose.

• tablet-v2, version 2

  This version of the tablet protocol adds support for pad dials.

• pointer-constraints-unstable-v1, position hints

  The implementation now honors position hints set by clients.

  Thanks to @tadeokondrak for suggesting this.

Disabling the Built-In Bar

The built-in bar can now be disabled:

show-bar = true

[shortcuts]
alt-a = "show-bar"
alt-b = "hide-bar"
alt-c = "toggle-bar"

This can be useful if you want to use an external bar such as waybar.

Client & Window Rules

Jay now supports client and window rules:

[[windows]]
match.content-types = ["video"]
action = "enter-fullscreen"

These rules are described in detail in
window-and-client-rules.md.

Window Management

This release contains many improvements related to how you can manage windows with the
mouse and keyboard.

• You can now show floating windows above fullscreen windows:

  alt-a = "enable-float-above-fullscreen"
  alt-b = "disable-float-above-fullscreen"
  alt-c = "toggle-float-above-fullscreen"

• Floating windows can now be pinned to an output. A pinned floating window remains
  visible even if you switch to a different workspace on the same output.

  You can pin a floating window by right-clicking on its title or with the following actions:

  alt-a = "pin-float"
  alt-b = "unpin-float-float"
  alt-c = "toggle-float-pinned"

  A pinned window has a pin icon drawn in front of its title. You can also configure the
  compositor so that a grayed-out version of the icon is always shown even if the window
  is not pinned:

  [float]
  show-pin-icon = true

  In this case you can also toggle between pinned and unpinned by left-clicking on the
  icon.

• Floating windows are now restacked when you click, touch, or press down a tablet tool
  anywhere inside of them. Previously this only happened when clicking on the window
  title.

  Thanks to @disluckyguy for suggesting this.

• Fullscreen windows can now be moved to other workspaces and outputs without first
  leaving fullscreen. You can do this with the usual keyboard shortcuts or in
  window-management mode by dragging the window to another output. Recall that you can
  configure a key to enable window-management mode as follows:

  window-management-key = "XF86Macro1"

  This will enable window-management mode while this key is being pressed.

• In window-management mode, tiled windows can now be dragged with the mouse to move them
  around. Previously this was possible by dragging the window title, but in window
  management mode you can now click anywhere within the window.

  Note that, in window-management mode, dragging the title will actually drag the
  container containing the window.

  Thanks to @Stoppedpuma for suggesting this.

• Jay allows you to always revert the pointer to its default state by pressing the Escape
  key. For example, if you're performing a drag-and-drop operation, you can press Escape
  to abort it. Some people want to use the Escape key legitimately without having this
  side effect on the pointer.

  You can now configure which key performs this operation:

  pointer-revert-key = "Escape"

  You can disable this feature altogether by setting it to NoSymbol.

  Thanks to @kotarac for suggesting this.

• You can now assign vim-like marks to windows and later jump back to them:

  [shortcuts]
  alt-a = "create-mark"
  alt-b = "jump-to-mark"

  When these actions are executed, the next key press marks the selected window with that
  key or jumps to the window that was previously marked with that key.

  Instead of selecting the key interactively, you can also specify it in the config
  itself:

  [shortcuts]
  alt-a = { type = "create-mark", id.key = "a" }

  The key names can be found in the input-event-codes.h file in your /usr/include
  directory. The names should have the KEY_ prefix removed and must be written
  all-lowercase.

  Alternatively, you can use marks that are identified by a string name instead of a key:

  [shortcuts]
  alt-a = { type = "create-mark", id.name = "my mark name" }

  These marks live in their own namespace and cannot be accessed with the interactive key
  selection.

• Jay now maintains a focus history. The history allows you to navigate between your
  windows in the order in which you focused them:

  alt-a = "focus-prev"
  alt-b = "focus-next"

  You can customize the behavior of these actions with the following settings:

  [focus-history]
  only-visible = false
  same-workspace = true

  If only-visible is true, then actions will only move the focus to windows that are
  already visible. Otherwise it will make windows visible before focusing them, moving
  between tabs and workspaces as necessary.

  If same-workspace is true, then only windows on the same workspace will be focused.

  The defaults are false for both.

• When switching to a workspace, Jay will now put the focus on the last window that was
  previously focused on that workspace, which might be a floating window. Previously Jay
  would always put the focus on the last tiled window that was previously focused.

• You can now navigate between tiled and floating layers without using the mouse:

  [shortcuts]
  alt-a = "focus-below"
  alt-b = "focus-above"

  This should allow you to put the keyboard focus on any window without having to use the
  mouse.

  Thanks to @Stoppedpuma for suggesting this.

Toml Improvements

These improvements apply to the toml-based configuration:

• You can now assign names to actions:

  actions.xyz = [
      { type = "move-to-workspace", name = "1" },
      "enter-fullscreen",
  ]

  These actions can then be executed by prefixing their name with a $:

  [shortcuts]
  alt-a = "$xyz"

  This can be useful when the same action is used in multiple places.

  You can also re-define or un-define actions at runtime:

  [shortcuts]
  alt-a = {
    type = "define-action",
    name = "xyz",
    action = [
      { type = "move-to-workspace", name = "2" },
      "enter-fullscreen",
    ],
  }
  alt-b = { type = "undefine-action", name = "xyz" }

  These types of redefinitions can be used for a limited amount of dynamic behavior. For
  example, you can have the same key cycle between a number of workspaces.

• Jay now supports input modes:

  [shortcuts]
  alt-x = { type = "push-mode", name = "navigation" }
  
  [modes."navigation".shortcuts]
  Escape     = "pop-mode"
  w          = "focus-up"
  a          = "focus-left"
  s          = "focus-down"
  d          = "focus-right"
  q          = "focus-prev"
  e          = "focus-next"
  r          = "focus-above"
  f          = "focus-below"
  m          = "create-mark"
  apostrophe = "jump-to-mark"

  These modes allow you to define shortcuts that are overlayed on the normal shortcuts
  while the mode is active.

  If you have a foot pedal or same easy-to-reach key, you can use Jay's complex-shortcuts
  mechanism to enter the mode while you're holding the key down:

  [complex-shortcuts.XF86Macro2]
  action = { type = "push-mode", name = "navigation" } # Executes when the key is pressed
  latch = "pop-mode"                                   # Executes when the key is released

  If you prefer key chords, you can use the latch-mode action:

  [shortcuts]
  alt-x = { type = "latch-mode", name = "navigation" }

  This acts like push-mode except that the mode is automatically popped when the next
  shortcut is executed.

  By default, modes inherit from the default shortcuts, however, you can also configure
  them to inherit from another mode:

  [modes.m1.shortcuts]
  # ...
  
  [modes.m2]
  parent = "m1"
  [modes.m2.shortcuts]
  # ...

  In this case, the shortcuts that are active while the m2 mode is active are normal
  shortcuts, overwritten by the m1 shortcuts, overwritten by the m2 shortcuts.

  Note that you can explicitly unset a shortcut by assigning it the none action.

Support for cap_sys_nice

Jay now supports running with the cap_sys_nice capability:

~$ sudo setcap cap_sys_nice=+p /path/to/jay

If the co...

Jay 1.10.0

• Various bugfixes.

• Implement cursor-shape-v1 version 2.

• Implement xdg-shell version 7.

• Implement color-management-v1.

  This release adds support for color management if the vulkan renderer is used
  and the vulkan driver supports the VK_EXT_descriptor_buffer extension. Color
  management is not available with the opengl renderer.

  There are two limitations:

  • No tone mapping is performed. That is, HDR content that is brighter than
    what the framebuffer can store will be clipped.
  • No gamut mapping is performed. That is, content that is more colorful than
    what the framebuffer can store will be clipped.

  The color management protocol is disabled by default. You can enable it on the
  command line via jay color-management enable or in the config file via
  color-management.enabled = true. If you are not using an OLED display, you
  probably want to keep it disabled and instead rely on the tone mapping
  performed by applications such as mpv. Changing this setting usually requires
  applications to be restarted.

  You can use this application to test various settings:
  https://github.com/mahkoh/wayland-color-test

• Outputs can now optionally use the BT.2020/PQ color space.

  On the command line this can be controlled via
  jay randr output <OUTPUT> colors .... In the config file it can be
  controlled via the color-space and transfer-function fields in the output
  configuration.

  When using the PQ transfer function, the output should also be configured to
  use at least a 10 bpc framebuffer format.

• The reference brightness of outputs can now be configured via
  jay randr output <OUTPUT> brightness ... or in the config file via the
  brightness field in the output configuration.

  This is primarily useful when using the PQ transfer function and the display
  does not support configuring the brightness via its hardware overlay.

  This configuration has no effect unless the vulkan renderer is used and the
  vulkan driver supports the VK_EXT_descriptor_buffer extension.

• The vulkan renderer has been significantly improved to ensure high performance
  even with color management enabled:

  • VK_EXT_descriptor_buffer is used if available.
  • Only the damaged areas of the screen are rendered.
  • Draw calls are instanced so that only one draw call is required per texture
    even if there are multiple small damage areas.
  • Blending is now performed with a dedicated 16 bpc texture in linear space.
  • The blend buffer is deduplicated between outputs with the same size.
  • Areas of the screen where the topmost texture is opaque bypass the blend
    buffer and render directly to the frame buffer.

Jay 1.9.1

This release updates the kbvm crate to fix an issue that would cause applications to
interpret the AltGr key as the Alt key.

Reported by @Honkeh in #364.

Jay 1.9.0

This release replaces xkbcommon by the kbvm crate.

This is a huge change in how input is handled. The intention is that this is completely
invisible to users.

Therefore this release contains only this change. You can downgrade to the previous
release to switch back to xkbcommon without any loss in functionality. In this case please
report what is broken.

Jay 1.8.0

• Various bugfixes.
• Implement ext-data-control-v1.
• Implement wl-fixes.
• Implement ei_touchscreen v2.
• Implement idle-notification v2.
• Add an idle grace period. During the grace period, the screen goes black but is neither
  disabled nor locked. This is similar to how android handles going idle. The default is
  5 seconds.
• Implement ext-workspace-v1.

Jay 1.7.0

• Various bugfixes.
• Tiles and workspaces can now be dragged with the mouse.
• Vulkan is now the default renderer.
• Emulate vblank events on the nvidia driver.
• Allow X windows to scale themselves.
• Implement ext-image-capture-source-v1.
• Implement ext-image-copy-capture-v1.
• Implement screencast session restoration.
• Fix screen sharing in zoom.
• Implement wp-fifo-v1.
• Implement wp-commit-timing-v1.
• Implement jay-tray-v1. You can get tray icons and menus by using
  https://github.com/mahkoh/wl-tray-bridge.