Skip to content

Repository files navigation

TsodingBuild 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

ControlDescription
0Reset the application state (position, scale, velocity, etc).
q or ESCQuit the application.
rReload configuration.
mMirror the image.
Ctrl + rReload the shaders (only for Developer mode)
fToggle flashlight effect.
Drag with left mouse buttonMove the image around.
Scroll wheel or =/-Zoom in/out.
Ctrl + Scroll wheelChange 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:

NameDescription
min_scaleThe smallest it can get when zooming out
scroll_speedHow quickly you can zoom in/out by scrolling
drag_frictionHow quickly the movement slows down after dragging
scale_frictionHow quickly the zoom slows down after scrolling

Experimental Features Compilation Flags

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

FlagDescription
-d:liveLive image update. See issue #26.
-d:mitshmEnables faster Live image update using MIT-SHM X11 extension. Should be used along with -d:live to have an effect
-d:selectApplication 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

Topics

Resources

Stars

833 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages