Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neg-serg/negwm
Brings a lot of unique UX features inspired by ion3/notion wm. Probably the most sophisticated example of i3ipc usage ever created
https://github.com/neg-serg/negwm
i3 i3ipc i3wm ion3 ux
Last synced: 3 months ago
JSON representation
Brings a lot of unique UX features inspired by ion3/notion wm. Probably the most sophisticated example of i3ipc usage ever created
- Host: GitHub
- URL: https://github.com/neg-serg/negwm
- Owner: neg-serg
- License: lgpl-3.0
- Created: 2018-02-15T12:54:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-30T20:50:52.000Z (7 months ago)
- Last Synced: 2024-06-10T01:36:29.886Z (5 months ago)
- Topics: i3, i3ipc, i3wm, ion3, ux
- Language: Shell
- Homepage:
- Size: 6.76 MB
- Stars: 28
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README-en.md
- License: LICENSE
Awesome Lists containing this project
README
* [Screenshots](#screenshots)
* [What is it?](#what-is-it)
* [Why](#why)
* [Help](#help)
* [Installation](#installation)
* [General](#general)
* [Modules](#modules)
* [Scratchpad](#scratchpad)
* [Circle](#circle)
* [Lastgo](#lastgo)
* [Menu](#menu)
* [Actions](#actions)
* [Fullscreen](#fullscreen)
# Screenshots
# What is it?
For now this collection of modules for i3 includes
_negwm_ : application that run all modules and handle configuration of i3 and modules on python. Also handles config updating.
# Why
It is only my attempt to port the best UX parts from ion3/notion and also improve it when possible. But if you try I may find that things,
like better scratchpad or navigation very useful.
# Help
```man
i3 negwm daemon script.
This module loads all negwm an start it via main's manager mailoop. Inotify-based watchers for all negwm S-expression-based configuration
spawned here, to use it just start it from any place without parameters. Moreover it contains pid-lock which prevents running several times.
Usage:
./negwm.py
```
# Installation
Negwm suggests that your main i3 config directory is `$XDG_CONFIG_HOME/i3`, so you need to set up your `$XDG_CONFIG_HOME` variable before
install, via `/etc/profile`, some kind of `.zshenv` or smth else depending or your environment, it is mandatory to install.
Before install make sure to backup your i3 configuration, install script should do it automatically, but it's better to do it by hand for
the reliability reasons.
The most simple way to install it for now is to use install from repo:
`curl https://raw.githubusercontent.com/neg-serg/negwm/master/bin/install | sh`
Also you can clone this to any dir and run `/bin/install`
After install check it via smth like:
```
cd $XDG_CONFIG_HOME/negwm
./bin/run
```
If everything is ok then you can use new i3 config example, where `Mod4- Shift + '`
is i3wm reloading, after reload you should get i3 with `negwm` plugins on the board.
# General
Some general notes:
`negwm` works as a server in port 15555. It splited by various modules.
You can call any function of any module with something like this:
```
echo 'scratchpad toggle ncmpcpp'|nc localhost 15555 -v -w 0
```
Where 1st argument is module, 2nd is function and another is parameters.
Most of modules supports dynamic reloading of configs as you save the file, so there is no need to manually reload them. Anyway you can
reload negwm manually, for example to reload `circle`:
```
echo 'circle reload'|nc localhost 15555 -v -w 0
```
At first you need to add something in run and add it to config:
Start it via systemd user service:
```cfg
exec_always systemctl --user restart --no-block negwm.service
```
To restart negwm after i3 reload, `negwm.py` should close file automatically, after i3 reload/restart so you can simply run it after
restart.
# Modules
## Scratchpad
Named ion3-like scratchpads with a whistles and fakes.
Named scratchpad is something like tabs for windows. You can create scratchpad with several rules like `im`, `player`, etc and attach
windows to it. Then it make some magic to support some kind of "next tab" for this group, etc.
Look at `cfg/scratchpad.py` for the more info.
Possible matching rules are:
"class", "instance", "role", "class_r", "instance_r", "name_r", "role_r"
It supports both strings and regexes and also need geom to create virtual placeholder for this windows, where all matched windows are
attached to.
Some interesting commands:
```cfg
dialog: toggle dialogs
hide_current: hide current scratchpad despite of type
hide: hide scratchpad
next: go to the next window in scratchpad
show: show scratchpad
subtag: you can create groups inside groups.
toggle: show/hide this named scratchpad, very useful
```
Interesting parts here:
Use `toggle` to toggle this specific scratchpad on / off. It saves current selected window after hiding.
Use `next` to go to the next of opened named scratchpad window for the current scratchpad. for example with im case you will iterate over
`telegram` and `skype` windows if they are opened
Use `hide_current` to hide any scratchpad with one hotkey.
Use `subtag` if you want to iterate over subset of named scratchpad or run command for a subset of scratchpad. For example use `subtag im
tel` if you want to run telegram or go to the window of telegram if it's opened despite of another im windows like skype opened or not.
Use `dialog` to show dialog window. I have placed it in the separated scratchpad for convenience.
## Circle
Better run-or-raise, with jump in a circle, subtags, priorities and more. Run-or-raise is the following:
If there is no window with such rules then start `prog` Otherwise go to the window.
More of simple going to window you can **iterate** over them. So it's something like workspaces, where workspace is not about view, but
about semantics. This works despite of current monitor / workspace and you can iterate over them with ease.
Possible matching rules are:
"class", "instance", "role", "class_r", "instance_r", "name_r", "role_r"
circle config example:
```python3
Δ = dict
class circle(Enum):
web = Δ(
classw = ['firefox', 'firefoxdeveloperedition', 'Tor Browser', 'Chromium'],
keybind_default_next = ['Mod4+w'],
prog = 'firefox',
firefox = Δ(
classw = ['firefox'],
keybind_spec_subtag = ['f'],
prog = 'firefox'
),
tor = Δ(
classw = ['Tor Browser'],
keybind_spec_subtag = ['5'],
prog = 'tor-browser rutracker.org'
),
ws = 'web'
)
```
For this example if you press `mod4+w` then `firefox` starts if it's not started, otherwise you jump to it, because of priority. Let's
consider then that `tor-browser` is opened, then you can iterate over two of them with `mod4+w`. Also you can use subtags, for example
`mod1+e -> 5` to run / goto window of tor-browser.
Some useful commands:
```cfg
next: go to the next window
subtag: go to the next subtag window
```
## Lastgo
Goto to the previous window, not the workspace. Default i3 alt-tab cannot to remember from what window alt-tab have been done, this mod fix
at by storing history of last selected windows.
config_example:
```cfg
class lastgo(Enum):
autoback = ['pic', 'gfx', 'vm']
```
lastgo commands:
```cfg
switch: go to previous window
focus_next: focus next window
focus_prev: focus previous window
focus_next_visible: focus next visible window
focus_prev_visible: focus previous visible window
```
## Actions
Various stuff to emulate some 2bwm UX. I do not use it actively for now, so too lazy to write good documentation for it but if you are
interested you are free to look at `lib/actions.py` source code.
## Fullscreen
Fullscreen panel hacking.
## Support
If you like my stuff, you can [buy me a coffee](https://www.buymeacoffee.com/negserg).