altermo/nwm

github github
split-and-window
stars 294
issues 0
subscribers 7
forks 6
CREATED

2023-12-15

UPDATED

19 days ago


NXWM

Neovim X11 Window Manager allows you to use x11 windows as if they were buffers. When entering a x-window-buffer, you'll need to start insert-mode to focus the x-window (unless some configurations are set to do this automatically).

Requirements

  • libx11
  • libxfixes (almost always installed if libx11 is installed)
  • glibc (or most other standard C libraries)
  • Terminal supporting TIOCGWINSZ
    • Recommended terminal is kitty
    • Run :lua= require'nxwm'.term_supported() to check
      • NOTE: some terminals may support TIOCGWINSZ while still not working (like neovim-qt)

Installation

Use whichever package manager you like.
It is recommended to lock/pin the plugin to one version/branch because of changes.

  • lazy
{'altermo/nwm',branch='x11'},
  • packer
use {'altermo/nwm',branch='x11'},

Configuration

Using require("nxwm").setup({}) is not required, it is only there if you want to change the default config.

{
    --What happens when a new x-window is created
    on_win_open=function (buf,xwin)
        vim.cmd.vsplit()
        vim.api.nvim_set_current_buf(buf)
    end,
    --Configuration to pass to window
    --`conf` is global config
    on_win_get_conf=function (conf,xwin) return conf end,
    --How to handle when multiple windows in the same tabpage has the x-window-buffer open
    on_multiple_win_open=function (vwins,buf,xwin)
        for k,vwin in ipairs(vwins) do
            if k~=1 then
                local scratchbuf=vim.api.nvim_create_buf(false,true)
                vim.bo[scratchbuf].bufhidden='wipe'
                vim.api.nvim_win_set_buf(vwin,scratchbuf)
            end
        end
    end,
    --Whether to be more verbose
    verbal=false,
    --Whether to show float windows above x-windows (depending on z-index)
    floatover=true,
    --Map to unfocus a window (multiple key mappings is not (yet) supported)
    unfocus_map='<A-F4>',
    --Create your own mappings
    --IMPORTANT: the x-window needs to be focused for such mappings to work
    maps={
        --{'<C-A-del>',function () vim.cmd'quitall!' end},
        --Or you could also have lhs as a table
        --{{mods={'control','mod1'},key='Delete'},function () vim.cmd'quitall!' end},
    },
    --Window-opt: auto focus x-window when entering x-window-buffer
    autofocus=false,
    --Window-opt: try-delete x-window if no vim-window shows buffer (similar to `bufhidden=wipe`)
    delhidden=true,
    --Window-opt: when click on x-window, goto that buffer (may not focus x-window)
    clickgoto=true,
    --Window-opt: offset the window this many x pixels (useful if terminal has padding)
    xoffset=0,
    --Window-opt: offset the window this many y pixels (useful if terminal has padding)
    yoffset=0,
}

Usage

Start

Create an executable file with the following contents (or run directly in bash):
(click triangle to expand)

Install sx (most distros don't have it as a package so you may need to install from source)

#!/bin/bash
sx alacritty --config-file /dev/null -e nvim -c 'lua require("nxwm").start()'
#!/bin/bash
sx kitty -c NONE -o placement_strategy=top-left -e nvim -c 'lua require("nxwm").start()'
#!/bin/bash
sx wezterm -n --config enable_tab_bar=false --config window_padding='{left=0,right=0,top=0,bottom=0}' start nvim -c 'lua require"nxwm".start()'

Install Xwayland (may have the package name xwayland, xorg-xwayland or xorg-x11-server-Xwayland)

#!/bin/bash
Xwayland :99 -noreset&
env -u WAYLAND_DISPLAY DISPLAY=:99 alacritty --config-file /dev/null -e nvim -c 'lua require("nxwm").start()'
jobs -p | xargs kill
#!/bin/bash
Xwayland :99 -noreset&
env -u WAYLAND_DISPLAY DISPLAY=:99 kitty -c NONE -o placement_strategy=top-left -e nvim -c 'lua require("nxwm").start()'
jobs -p | xargs kill
#!/bin/bash
Xwayland :99 -noreset&
env -u WAYLAND_DISPLAY DISPLAY=:99 wezterm -n --config enable_tab_bar=false --config window_padding='{left=0,right=0,top=0,bottom=0}' start nvim -c 'lua require"nxwm".start()'
jobs -p | xargs kill

Install Xephyr (may be installed together with xorg-sever or have the package name xorg-server-xephyr)

#!/bin/bash
Xephyr -ac -br -noreset :99&
env DISPLAY=:99 alacritty --config-file /dev/null -e nvim -c 'lua require("nxwm").start()'
jobs -p | xargs kill
#!/bin/bash
Xephyr -ac -br -noreset :99&
env DISPLAY=:99 kitty -c NONE -o placement_strategy=top-left -e nvim -c 'lua require("nxwm").start()'
jobs -p | xargs kill
#!/bin/bash
Xephyr -ac -br -noreset :99&
env DISPLAY=:99 wezterm -n --config enable_tab_bar=false --config window_padding='{left=0,right=0,top=0,bottom=0}' start nvim -c 'lua require"nxwm".start()'
jobs -p | xargs kill

Use

Open up a terminal (with :term) and run your wanted GUI. NOTE: x-windows aren't auto focused by default, so start insert (by pressing i or similar) and then you'll focus the window. To unfocus an x-window, either click into another buffer, or press alt-F4(unless the default config has been changed).

Donate

If you want to donate then you need to find the correct link (hint: No Break Here):