Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

xflash

Forgot to pay your electricity bills? No problem xflash is here to help you see, also just a simple cursor finder! :)

preview preview2

Installation

Deps

On arch linux type this command to install everything you will need

sudo pacman -S libx11 libxext

Install

After you installed the required packages, run this command to build xflash (with sudo if nesessary)

make install

Uninstall

If you want to uninstall xflash from your system run this command(with sudo if nesesarry)

make uninstall

Usage

To use xflash with default configuration, just use

xflash

Check out xflash configuration with

xflash --help

Using the colors might be tricky, you will need to also set the alpha in hex, example below

000000F0 // 50% transparent black, default color for flashlight, alpha is the last 2 numbers in hex

But the best way to use xflash wouldnt be to call it manually via terminal, just put it into your keybindings!
It will be diffrent on all window managers but here are few examples

Fluorite(github.com/l0wigh/Fluorite) example:

bind "Mod4+exclam"  { action = "exec" arg = "xflash -r 100 --cursor-color '4169e130' --bg-color '00000000' -t 3"}

meow(github.com/wdkaza/meow) example:

static char *xflash[] = {"xflash", "-t 3", "-r 100", NULL};
{MOD, KeyL,      spawn,                   {.v = xflash}},

A few color combos for you to try out!

(Small note, its better to turn off smooth_edges if you have performance/transparancy problems with bright colors, if not going for the flashlight look
and instead trying to go for a small circle where they wont be even visible it would be better without smooth_edges, sorry for bad performance with smooth_edges for now, they will be improved later on)

Royal Blue circle with no background:

xflash --cursor-color '4169e130' --bg-color '00000000' -r=100

Nord filter for your screen

xflash --bg-color=#00000000 --cursor-color=#2E344003 -r=10000

Red filter for reading at night

xflash --bg-color=#00000000 --cursor-color=#55000003 -r=10000

And a flashlight ofcourse :)

xflash -s=on --cursor-color=#000000F0

Keybindings

(WIP)Keep in mind CTRL is the default Modkey, you can change it with '--modkey'(WIP)

Keybind Action
CTRL+Q Quit xflash
CTRL+F Turn on/off xflash
CTRL+Up Increase size
CTRL+Down Decrease size

Compositor issues

You NEED to have some sort of compositor running for xflash to work

Note from xflash(real note btw): "Please clean my lens regularly, i dont like being blurry, i cant see! :("
To avoid issues exclude xflash from the blur in your favorite compositor!

# Picom example
blur-background-exclude = [
    "name = 'xflash'",
];

Also make sure to exclude xflash from opacity in your favorite compositor

# Picom example
opacity-rule = [
  "100:name= 'xflash'"
]

About

Flashlight, in other words a cursor finder for X11

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages