Skip to content

Commit

Permalink
update readme and metadata to reflect new version
Browse files Browse the repository at this point in the history
  • Loading branch information
lingtjien committed Dec 24, 2020
1 parent 210944c commit 7f6af23
Showing 1 changed file with 7 additions and 11 deletions.
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,13 @@ ln -s *path*/metadata.desktop kwin-script-grid-tiling.desktop
Delete the linked or copied files that you created during installation. To remove installed scripts by `kpackagetool5`, run the same command again but this time with `-r` instead of `-i` to remove (see manual of `kpackagetool5` for more info)

## Functionality
- automatically tile clients, up to any grid size of clients per desktop
- automatically tile clients, up to any custom grid size per desktop and per screen
- new clients are first attempted to be added the current desktop and screen, to the column with the most amount of space left
- the size of the grid (row & column) is supplied in the UI per screen and separated by a comma (first element in row & column are for your first screen and so forth...)
- you **must** supply a grid for every screens that you have connected (and plan to connect)
- the size of the grid (row & column) is supplied in the UI seperated by a comma for every virtual desktop and every screen has it's own list
- you **must** supply a grid for every virtual desktop and screen, that you have and plan to have (`20` virtual desktops and `10` screens max)
- restriction of minimum space a client can occupy on a virtual desktop, as in the amount of clients this client can share a virtual desktop with
- a list of comma seperated numbers, larger or equal to `1`
- defaults to the maximum which is the number of rows multiplied by columns (of the largest grid)
- a size of `1` is the largest which means that it can only ever exist alone on a virtual desktop, size of `2` means that it can exist with one other client together on a virtual desktop and so forth...
- a size of `1` is the largest and fully takes up a whole virtual desktop, size of `2` means that it takes up at least half of the virtual desktop and so forth...
- matching is done by regex and it defaults to the maximum which is the number of rows multiplied by columns of the largest grid
- move clients between virtual desktops (supports the default KWin shortcuts). `Grid-Tiling: Move *Next/Previous* Desktop/Screen` moves the client to the next desktop or screen that has space, prioritizes screen over desktop.
- swap clients within a virtual desktop by dragging them on top with most overlap
- move clients within a virtual desktop, first attempts to move the client if that fails it will fallback to switching.
Expand All @@ -62,7 +61,7 @@ Delete the linked or copied files that you created during installation. To remov
- toggle new clients start as tile or float `Grid-Tiling: Toggle Tile`
- close all clients on the current virtual desktop `Grid-Tiling: Close Desktop`
- set margins, gap size, default gap state, default tile state, default border state
- add ignored clients to `ignoredNames` and `ignoredCaptions` regex, these clients are completely ignored and can't be tiled.
- ignore clients by `name` or `caption` regex, these clients are completely ignored and can't be tiled.

*Note: ignored client names do not have to match the whole string, whereas ignored captions do.*

Expand Down Expand Up @@ -101,10 +100,7 @@ Delete the linked or copied files that you created during installation. To remov
- After installing a KWin script you can activate it in the system settings, here you'll also find the configuration button.
- When you adjust the settings in the menu, this script needs to be restarted before the settings are applied. You can do this by turning the script off, apply, turn it back on and apply again or a complete KWin restart (re-log/reboot).
- If you have KWin shortcuts added by the script that you no longer need or use (because they got renamed to something else for example), then you can delete the old unused shortcuts by first selecting KWin in the global shortcuts menu and then pressing the `remove the selected component` button (hover mouse over the button to see the text). This action does require you to not have the KWin script active.
- Some applications do not always render correctly on startup, this is due to them overwriting the geometry with their own. They sometimes provide settings to disable setting their own geometry. If it still happens, than you can use the global refresh shortcut to let the script set all geometries again.
- Moving clients between desktops using the action menu can sometimes result in wrong placement, just use the global refresh shortcut.
- Spotify can sometimes not be defined as full or half client, because both the client name and class of spotify are blank at startup.
- Dynamically resizing clients with the mouse can result in weird visual artifacts when dragged outside of the bounds, just use the global shortcut that refreshes the layout.
- Resizing clients with the mouse can result in weird visual artifacts when dragged outside of the bounds, just use the global shortcut that refreshes the layout.
- This was made with the intended use of using a set amount of virtual desktops. For the best result make sure you have more virtual desktops than you have clients normally. The script can handle more clients but once all desktops are full, all new clients will start as floating instead of tiling until there is space again to tile new clients.
- I don't use dynamic virtual desktops, but it should be able to deal with it as long as the clients are closed when the virtual desktop is removed.

Expand Down

0 comments on commit 7f6af23

Please sign in to comment.