Skip to content

izlatin/boomer

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

303 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wayland

  1. Added some support for Wayland, including key control, since X11 has a completely different event loop for that. Many other forks try to make Boomer work on wayland, but I have tested several of them and none of them worked by me as good as original (probably depends on the desktop environment). The screenshot functionality extension is taken from this fork, so you can install a screenshot helper that works with your compositor (one of the following is enough):
  • grim (wlroots compositors; requires xdg-desktop-portal-wlr)
  • gnome-screenshot (GNOME)
  • spectacle (KDE Plasma)   [I have tested only this one so far]
  1. Added offset parameters to the Boomer config for such cases like having a kDE Plasma side panel that sometimes places a new window with an offset to not overlap with itself.
  2. Updated the installation config for Nix

Challenges

Wayland protocol does not give as much freedom as provided by X11, so the following problems are still not solved:

  • Multiple monitors: fullscreen mode (default) opens properly only when launched from the top left monitor
  • System scaling: if some of your displays have a system scale ($\neq$ 100%) set up, then the overlay might have an incorrect size

Tsoding Build Status

Boomer

Zoomer application for Linux.

Dependencies

Debian

$ sudo apt-get install libgl1-mesa-dev libx11-dev libxext-dev libxrandr-dev

Quick Start

$ nimble build
$ ./boomer --help
$ ./boomer          # to just start using

Developer Capabilities

For additional Developer Capabilities compile the application with the following flags:

$ nimble build -d:developer

This will enable reloading the shaders with Ctrl+R. The shader files (frag.glsl and vert.glsl) should be located in the same folder as boomer.nim for this feature to work. If the shader files not found the program won't even start.

Keep in mind that the developer build is not suitable for day-to-day usage because it creates the external dependency on the shader files. Compiling the program without -d:developer "bakes" the shaders into the executable and eliminates the dependency.

Controls

Control Description
0 Reset the application state (position, scale, velocity, etc).
q or ESC Quit the application.
r Reload configuration.
m Mirror the image.
Ctrl + r Reload the shaders (only for Developer mode)
f Toggle flashlight effect.
Drag with left mouse button Move the image around.
Scroll wheel or =/- Zoom in/out.
Ctrl + Scroll wheel Change the radious of the flaslight.

Configuration

Configuration file is located at $HOME/.config/boomer/config and has roughly the following format:

<param-1> = <value-1>
<param-2> = <value-2>
# comment
<param-3> = <value-3>

You can generate a new config at $HOME/.config/boomer/config with $ boomer --new-config.

Supported parameters:

Name Description
min_scale The smallest it can get when zooming out
scroll_speed How quickly you can zoom in/out by scrolling
drag_friction How quickly the movement slows down after dragging
scale_friction How quickly the zoom slows down after scrolling
offset_x Offset for the screenshot (pixels on the right)
offset_y Offset for the screenshot (pixels on top)

If you have a KDE Plasma panel that places all windows with an offset by default, you can find its thickness in pixels and put it into the Boomer config, so that it shifts the overlay properly.

Experimental Features Compilation Flags

Experimental or unstable features can be enabled by passing the following flags to nimble build command:

Flag Description
-d:live Live image update. See issue #26.
-d:mitshm Enables faster Live image update using MIT-SHM X11 extension. Should be used along with -d:live to have an effect
-d:select Application lets the user to click on te window to "track" and it will track that specific window instead of the whole screen.

NixOS Overlay

$ git clone git://github.com/tsoding/boomer.git /path/to/boomer
$ mkdir -p ~/.config/nixpkgs/overlays
$ cd ~/.config/nixpkgs/overlays
$ ln -s /path/to/boomer/overlay/ boomer
$ nix-env -iA nixos.boomer

References

Support

You can support my work via

About

Zoomer application for Linux

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Nim 92.2%
  • Nix 5.1%
  • GLSL 2.7%