aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: 9a1708f32470557b16fcfd8e07f89880850fca8a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
kj-boomer
=====

a zoomer application for linux...

takes a screenshot and lets you pan, zoom, and
shine a flashlight around it.

a zig port of the original boomer by tsoding with no frills.

this is a personal re-implementation, so don't expect much. it works on my machine.


features
--------

- fullscreen screenshot viewer with smooth zoom and pan
- flashlight effect that follows your cursor
- soft edge option for the flashlight
- configurable texture filtering
- mirror mode


default controls
----------------

esc or q      quit
0             reset camera and flashlight
f             toggle flashlight
m             mirror image horizontally
r             reload configuration
=             zoom in
-             zoom out
left mouse    pan the image
scroll wheel  zoom in/out
ctrl+scroll   change flashlight radius

you can change the controls in src/config.zig and recompile.


dependencies
------------

- zig (>= 0.16)
- X11 development libraries (libX11, libXext, libXrandr)
- OpenGL development libraries (libGL, libGLX)
- GLEW (OpenGL Extension Wrangler)


build
-----

make
./zig-out/bin/boomer

for faster screenshot capture with MIT-SHM:

make USE_XSHM=1
./zig-out/bin/boomer

for a windowed mode instead of fullscreen:

./zig-out/bin/boomer -w


install
-------

make install

this copies boomer to ~/.local/bin/ by default.

set PREFIX to change it:
    make install PREFIX=/usr


license
-------

0BSD