commit c3002d4d114710321566bdb0e606d33f1fa39145 Author: ClovertaTheTrilobita Date: Sun Jan 11 19:21:27 2026 +0000 inital commit diff --git a/.config/cava/cava_option_config b/.config/cava/cava_option_config new file mode 100644 index 0000000..c0eab05 --- /dev/null +++ b/.config/cava/cava_option_config @@ -0,0 +1,213 @@ + +## Configuration file for CAVA. Default values are commented out. Use either ';' or '#' for commenting. + + +[general] + + +bars = 10 +framerate = 240 + + +# Smoothing mode. Can be 'normal', 'scientific' or 'waves'. DEPRECATED as of 0.6.0 +; mode = scientific + +# Accepts only non-negative values. +; framerate = 30 + +# 'autosens' will attempt to decrease sensitivity if the bars peak. 1 = on, 0 = active +# new as of 0.6.0 autosens of low values (dynamic range) +# 'overshoot' allows bars to overshoot (in % of terminal height) without initiating autosens. DEPRECATED as of 0.6.0 +; autosens = 1 +; overshoot = 20 + +# Manual sensitivity in %. If autosens is enabled, this will only be the initial value. +# 200 means double height. Accepts only non-negative values. +; sensitivity = 120 + +# The number of bars (0-200). 0 sets it to auto (fill up console). +# Bars' width and space between bars in number of characters. +; bars = 10 +; bar_width = 1 +; bar_spacing = 100 +# bar_height is only used for output in "noritake" format +; bar_height = 32 + +# For SDL width and space between bars is in pixels, defaults are: +; bar_width = 20 +; bar_spacing = 5 + + +# Lower and higher cutactive frequencies for lowest and highest bars +# the bandwidth of the visualizer. +# Note: there is a minimum total bandwidth of 43Mhz x number of bars. +# Cava will automatically increase the higher cutactive if a too low band is specified. +; lower_cutactive_freq = 50 +; higher_cutactive_freq = 10000 + + +# Seconds with no input before cava goes to sleep mode. Cava will not perform FFT or drawing and +# only check for input once per second. Cava will wake up once input is detected. 0 = disable. +sleep_timer = 10 + + +[input] + +# Audio capturing method. Possible methods are: 'pulse', 'alsa', 'fifo', 'sndio' or 'shmem' +# Defaults to 'pulse', 'alsa' or 'fifo', in that order, dependent on what support cava was built with. +# +# All input methods uses the same config variable 'source' +# to define where it should get the audio. +# +# For pulseaudio 'source' will be the source. Default: 'auto', which uses the monitor source of the default sink +# (all pulseaudio sinks(outputs) have 'monitor' sources(inputs) associated with them). +# +# For alsa 'source' will be the capture device. +# For fifo 'source' will be the path to fifo-file. +# For shmem 'source' will be /squeezelite-AA:BB:CC:DD:EE:FF where 'AA:BB:CC:DD:EE:FF' will be squeezelite's MAC address +; method = pulse +; source = auto + +; method = alsa +; source = hw:Loopback,1 + +; method = fifo +; source = /tmp/mpd.fifo +; sample_rate = 44100 +; sample_bits = 16 + +; method = shmem +; source = /squeezelite-AA:BB:CC:DD:EE:FF + +; method = portaudio +; source = auto + + +[output] + +# Output method. Can be 'ncurses', 'noncurses', 'raw', 'noritake' or 'sdl'. +# 'noncurses' uses a custom framebuffer technique and prints only changes +# from frame to frame in the terminal. 'ncurses' is default if supported. +# +# 'raw' is an 8 or 16 bit (configurable via the 'bit_format' option) data +# stream of the bar heights that can be used to send to other playerlications. +# 'raw' defaults to 200 bars, which can be adjusted in the 'bars' option above. +# +# 'noritake' outputs a bitmap in the format expected by a Noritake VFD display +# in graphic mode. It only support the 3000 series graphical VFDs for now. +# +# 'sdl' uses the Simple DirectMedia Layer to render in a graphical context. +method = raw + +# Visual channels. Can be 'stereo' or 'mono'. +# 'stereo' mirrors both channels with low frequencies in center. +# 'mono' outputs left to right lowest to highest frequencies. +# 'mono_option' set mono to either take input from 'left', 'right' or 'average'. +# set 'reverse' to 1 to display frequencies the other way around. +; channels = stereo +; mono_option = average +; reverse = 0 + +# Raw output target. A fifo will be created if target does not exist. +; raw_target = /dev/stdout + +# Raw data format. Can be 'binary' or 'ascii'. +data_format = ascii + +# Binary bit format, can be '8bit' (0-255) or '16bit' (0-65530). +; bit_format = 16bit + +# Ascii max value. In 'ascii' mode range will run from 0 to value specified here +ascii_max_range = 7 + +# Ascii delimiters. In ascii format each bar and frame is separated by a delimiters. +# Use decimal value in ascii table (i.e. 59 = ';' and 10 = '\n' (line feed)). +; bar_delimiter = 59 +; frame_delimiter = 10 + +# sdl window size and position. -1,-1 is centered. +; sdl_width = 1000 +; sdl_height = 500 +; sdl_x = -1 +; sdl_y= -1 + +# set label on bars on the x-axis. Can be 'frequency' or 'none'. Default: 'none' +# 'frequency' displays the lower cut active frequency of the bar above. +# Only supported on ncurses and noncurses output. +; xaxis = none + +# enable alacritty synchronized updates. 1 = on, 0 = active +# removes flickering in alacritty terminal emeulator. +# defaults to active since the behaviour in other terminal emulators is unknown +; alacritty_sync = 1 + +[color] + +# Colors can be one of seven predefined: black, blue, cyan, green, magenta, red, white, yellow. +# Or defined by hex code '#xxxxxx' (hex code must be within ''). User defined colors requires +# ncurses output method and a terminal that can change color definitions such as Gnome-terminal or rxvt. +# if supported, ncurses mode will be forced on if user defined colors are used. +# default is to keep current terminal color +; background = default +; foreground = default + +# SDL only support hex code colors, these are the default: +; background = '#111111' +; foreground = '#33cccc' + + +# Gradient mode, only hex defined colors (and thereby ncurses mode) are supported, +# background must also be defined in hex or remain commented out. 1 = on, 0 = active. +# You can define as many as 8 different colors. They range from bottom to top of screen +; gradient = 0 +; gradient_count = 8 +; gradient_color_1 = '#59cc33' +; gradient_color_2 = '#80cc33' +; gradient_color_3 = '#a6cc33' +; gradient_color_4 = '#cccc33' +; gradient_color_5 = '#cca633' +; gradient_color_6 = '#cc8033' +; gradient_color_7 = '#cc5933' +; gradient_color_8 = '#cc3333' + + + +[smoothing] + +# Percentage value for integral smoothing. Takes values from 0 - 100. +# Higher values means smoother, but less precise. 0 to disable. +# DEPRECATED as of 0.8.0, use noise_reduction instead +; integral = 77 + +# Disables or enables the so-called "Monstercat smoothing" with or without "waves". Set to 0 to disable. +; monstercat = 0 +; waves = 0 + +# Set gravity percentage for "drop active". Higher values means bars will drop faster. +# Accepts only non-negative values. 50 means half gravity, 200 means double. Set to 0 to disable "drop active". +# DEPRECATED as of 0.8.0, use noise_reduction instead +; gravity = 100 + + +# In bar height, bars that would have been lower that this will not be drawn. +# DEPRECATED as of 0.8.0 +; ignore = 0 + +# Noise reduction, float 0 - 1. default 0.77 +# the raw visualization is very noisy, this factor adjusts the integral and gravity filters to keep the signal smooth +# 1 will be very slow and smooth, 0 will be fast but noisy. +; noise_reduction = 0.77 + + +[eq] + +# This one is tricky. You can have as much keys as you want. +# Remember to uncomment more then one key! More keys = more precision. +# Look at readme.md on github for further explanations and examples. +# DEPRECATED as of 0.8.0 can be brought back by popular request, open issue at: +# https://github.com/karlstav/cava +; 1 = 1 # bass +; 2 = 1 +; 3 = 1 # midtone +; 4 = 1 +; 5 = 1 # treble diff --git a/.config/cava/config b/.config/cava/config new file mode 100644 index 0000000..ff28de1 --- /dev/null +++ b/.config/cava/config @@ -0,0 +1,321 @@ +## Configuration file for CAVA. +# Remove the ; to change parameters. + + +[general] + +# Smoothing mode. Can be 'normal', 'scientific' or 'waves'. DEPRECATED as of 0.6.0 +; mode = normal + +# Accepts only non-negative values. +; framerate = 60 + +# 'autosens' will attempt to decrease sensitivity if the bars peak. 1 = on, 0 = off +# new as of 0.6.0 autosens of low values (dynamic range) +# 'overshoot' allows bars to overshoot (in % of terminal height) without initiating autosens. DEPRECATED as of 0.6.0 +; autosens = 1 +; overshoot = 20 + +# Manual sensitivity in %. If autosens is enabled, this will only be the initial value. +# 200 means double height. Accepts only non-negative values. +; sensitivity = 100 + +# The number of bars (0-512). 0 sets it to auto (fill up console). +# Bars' width and space between bars in number of characters. +; bars = 0 +; bar_width = 2 +; bar_spacing = 1 +# bar_height is only used for output in "noritake" format +; bar_height = 32 + +# For SDL width and space between bars is in pixels, defaults are: +; bar_width = 20 +; bar_spacing = 5 + +# sdl_glsl have these default values, they are only used to calculate max number of bars. +; bar_width = 1 +; bar_spacing = 0 + +# ceter bars in terminal, if there is space. +; center_align = 1 + +# max height of bars in terminal, in percent of terminal height. +; max_height = 100 + + +# Lower and higher cutoff frequencies for lowest and highest bars +# the bandwidth of the visualizer. +# Note: there is a minimum total bandwidth of 43Mhz x number of bars. +# Cava will automatically increase the higher cutoff if a too low band is specified. +; lower_cutoff_freq = 50 +; higher_cutoff_freq = 10000 + + +# Seconds with no input before cava goes to sleep mode. Cava will not perform FFT or drawing and +# only check for input once per second. Cava will wake up once input is detected. 0 = disable. +; sleep_timer = 0 + + +[input] + +# Audio capturing method. Possible methods are: 'fifo', 'portaudio', 'pipewire', 'alsa', 'pulse', 'sndio', 'oss', 'jack' or 'shmem' +# Defaults to 'oss', 'pipewire', 'sndio', 'jack', 'pulse', 'alsa', 'portaudio' or 'fifo', in that order, dependent on what support cava was built with. +# On Mac it defaults to 'portaudio' or 'fifo' +# On windows this is automatic and no input settings are needed. +# +# All input methods uses the same config variable 'source' +# to define where it should get the audio. +# +# For pulseaudio and pipewire 'source' will be the source. Default: 'auto', which uses the monitor source of the default sink +# (all pulseaudio sinks(outputs) have 'monitor' sources(inputs) associated with them). +# +# For pipewire 'source' will be the object name or object.serial of the device to capture from. +# Both input and output devices are supported. To capture the monitor source of a sink node, append '.monitor' to the sink's object name. +# +# For alsa 'source' will be the capture device. +# For fifo 'source' will be the path to fifo-file. +# For shmem 'source' will be /squeezelite-AA:BB:CC:DD:EE:FF where 'AA:BB:CC:DD:EE:FF' will be squeezelite's MAC address +# +# For sndio 'source' will be a raw recording audio descriptor or a monitoring sub-device, e.g. 'rsnd/2' or 'snd/1'. Default: 'default'. +# README.md contains further information on how to setup CAVA for sndio. +# +# For oss 'source' will be the path to a audio device, e.g. '/dev/dsp2'. Default: '/dev/dsp', i.e. the default audio device. +# README.md contains further information on how to setup CAVA for OSS on FreeBSD. +# +# For jack 'source' will be the name of the JACK server to connect to, e.g. 'foobar'. Default: 'default'. +# README.md contains further information on how to setup CAVA for JACK. +# +; method = pulse +; source = auto + +; method = pipewire +; source = auto + +; method = alsa +; source = hw:Loopback,1 + +; method = fifo +; source = /tmp/mpd.fifo + +; method = shmem +; source = /squeezelite-AA:BB:CC:DD:EE:FF + +; method = portaudio +; source = auto + +; method = sndio +; source = default + +; method = oss +; source = /dev/dsp + +; method = jack +; source = default + +# The options 'sample_rate', 'sample_bits', 'channels' and 'autoconnect' can be configured for some input methods: +# sample_rate: fifo, pipewire, sndio, oss +# sample_bits: fifo, pipewire, sndio, oss +# channels: sndio, oss, jack +# autoconnect: jack +# Other methods ignore these settings. +# For pipewire, sample_rate will default to 48000, for all other input methods, sample_rate will default to 44100. +# +# For 'sndio' and 'oss' they are only preferred values, i.e. if the values are not supported +# by the chosen audio device, the device will use other supported values instead. +# Example: 48000, 32 and 2, but the device only supports 44100, 16 and 1, then it +# will use 44100, 16 and 1. +# +# +# The 'pipewire' input method has three options to control linking and mixing: +# active: Force the node to always process. Useful for monitoring sources when no other application is active. +# remix: Allow pipewire to remix audio channels to match cava's channel count. Useful for surround sound. +# virtual: Set the node to virtual, to avoid recording notifications from the DE. +# +; sample_rate = 44100 +; sample_bits = 16 +; channels = 2 +; autoconnect = 2 +; active = 0 +; remix = 1 +; virtual = 1 + + +[output] + +# Output method. Can be 'ncurses', 'noncurses', 'raw', 'noritake', 'sdl' +# or 'sdl_glsl'. +# 'noncurses' (default) uses a buffer and cursor movements to only print +# changes from frame to frame in the terminal. Uses less resources and is less +# prone to tearing (vsync issues) than 'ncurses'. +# +# 'raw' is an 8 or 16 bit (configurable via the 'bit_format' option) data +# stream of the bar heights that can be used to send to other applications. +# 'raw' defaults to 1024 bars stereo (512 bars mono), which can be adjusted in the 'bars' option above. +# +# 'noritake' outputs a bitmap in the format expected by a Noritake VFD display +# in graphic mode. It only support the 3000 series graphical VFDs for now. +# +# 'sdl' uses the Simple DirectMedia Layer to render in a graphical context. +# 'sdl_glsl' uses SDL to create an OpenGL context. Write your own shaders or +# use one of the predefined ones. +; method = noncurses + +# Orientation of the visualization. Can be 'bottom', 'top', 'left', 'right' or +# 'horizontal'. Default is 'bottom'. 'left and 'right' are only supported on sdl +# and ncruses output. 'horizontal' (bars go up and down from center) is only supported +# on noncurses output. +# Note: many fonts have weird or missing glyphs for characters used in orientations +# other than 'bottom', which can make output not look right. +; orientation = bottom + +# Visual channels. Can be 'stereo' or 'mono'. +# 'stereo' mirrors both channels with low frequencies in center. +# 'mono' outputs left to right lowest to highest frequencies. +# 'mono_option' set mono to either take input from 'left', 'right' or 'average'. +# set 'reverse' to 1 to display frequencies the other way around. +; channels = stereo +; mono_option = average +; reverse = 0 + +# Raw output target. +# On Linux, a fifo will be created if target does not exist. +# On Windows, a named pipe will be created if target does not exist. +; raw_target = /dev/stdout + +# Raw data format. Can be 'binary' or 'ascii'. +; data_format = binary + +# Binary bit format, can be '8bit' (0-255) or '16bit' (0-65530). +; bit_format = 16bit + +# Ascii max value. In 'ascii' mode range will run from 0 to value specified here +; ascii_max_range = 1000 + +# Ascii delimiters. In ascii format each bar and frame is separated by a delimiters. +# Use decimal value in ascii table (i.e. 59 = ';' and 10 = '\n' (line feed)). +; bar_delimiter = 59 +; frame_delimiter = 10 + +# sdl window size and position. -1,-1 is centered. +; sdl_width = 1024 +; sdl_height = 512 +; sdl_x = -1 +; sdl_y= -1 +; sdl_full_screen = 0 + +# set label on bars on the x-axis. Can be 'frequency' or 'none'. Default: 'none' +# 'frequency' displays the lower cut off frequency of the bar above. +# Only supported on ncurses and noncurses output. +; xaxis = none + +# enable synchronized sync. 1 = on, 0 = off +# removes flickering in alacritty terminal emulator. +# defaults to off since the behaviour in other terminal emulators is unknown +; synchronized_sync = 0 + +# Shaders for sdl_glsl, located in $HOME/.config/cava/shaders +; vertex_shader = pass_through.vert +; fragment_shader = bar_spectrum.frag + +; for glsl output mode, keep rendering even if no audio +; continuous_rendering = 0 + +# disable console blank (screen saver) in tty +# (Not supported on FreeBSD) +; disable_blanking = 0 + +# show a flat bar at the bottom of the screen when idle, 1 = on, 0 = off +; show_idle_bar_heads = 1 + +# show waveform instead of frequency spectrum, 1 = on, 0 = off +; waveform = 0 + +[color] + +# Colors can be one of seven predefined: black, blue, cyan, green, magenta, red, white, yellow. +# Or defined by hex code '#xxxxxx' (hex code must be within ''). User defined colors requires +# a terminal that can change color definitions such as Gnome-terminal or rxvt. +# default is to keep current terminal color +; background = default +; foreground = default + +# SDL and sdl_glsl only support hex code colors, these are the default: +; background = '#111111' +; foreground = '#33ffff' + + +# Gradient mode, only hex defined colors are supported, +# background must also be defined in hex or remain commented out. 1 = on, 0 = off. +# You can define as many as 8 different colors. They range from bottom to top of screen +; gradient = 0 +; gradient_color_1 = '#59cc33' +; gradient_color_2 = '#80cc33' +; gradient_color_3 = '#a6cc33' +; gradient_color_4 = '#cccc33' +; gradient_color_5 = '#cca633' +; gradient_color_6 = '#cc8033' +; gradient_color_7 = '#cc5933' +; gradient_color_8 = '#cc3333' + + +# Horizontal is only supported on noncurses output. +# Only one color will be calculated per bar. +; horizontal_gradient = 0 +; horizontal_gradient_color_1 = '#c45161' +; horizontal_gradient_color_2 = '#e094a0' +; horizontal_gradient_color_3 = '#f2b6c0' +; horizontal_gradient_color_4 = '#f2dde1' +; horizontal_gradient_color_5 = '#cbc7d8' +; horizontal_gradient_color_6 = '#8db7d2' +; horizontal_gradient_color_7 = '#5e62a9' +; horizontal_gradient_color_8 = '#434279' + + +# If both vertical and horizontal gradient is enabled, vertical will be blended in this direction. +# Can be 'up', 'down', 'left' or 'right'. 'up' means the vertical gradient will be blended in from +# bottom to top. I.e. the bottom will be only the horizontal +# and top will be only the color of the vertical gradient. +; blend_direction = 'up' + +# use theme file instead of defining colors in this file +# themes are located in $HOME/.config/cava/themes +; theme = 'none' + + +[smoothing] + +# Percentage value for integral smoothing. Takes values from 0 - 100. +# Higher values means smoother, but less precise. 0 to disable. +# DEPRECATED as of 0.8.0, use noise_reduction instead +; integral = 77 + +# Disables or enables the so-called "Monstercat smoothing" with or without "waves". Set to 0 to disable. +; monstercat = 0 +; waves = 0 + +# Set gravity percentage for "drop off". Higher values means bars will drop faster. +# Accepts only non-negative values. 50 means half gravity, 200 means double. Set to 0 to disable "drop off". +# DEPRECATED as of 0.8.0, use noise_reduction instead +; gravity = 100 + + +# In bar height, bars that would have been lower that this will not be drawn. +# DEPRECATED as of 0.8.0 +; ignore = 0 + +# Noise reduction, int 0 - 100. default 77 +# the raw visualization is very noisy, this factor adjusts the integral and gravity filters to keep the signal smooth +# 100 will be very slow and smooth, 0 will be fast but noisy. +; noise_reduction = 77 + + +[eq] + +# This one is tricky. You can have as much keys as you want. +# Remember to uncomment more than one key! More keys = more precision. +# Look at readme.md on github for further explanations and examples. +; 1 = 1 # bass +; 2 = 1 +; 3 = 1 # midtone +; 4 = 1 +; 5 = 1 # treble diff --git a/.config/cava/config.bak b/.config/cava/config.bak new file mode 100644 index 0000000..42f012d --- /dev/null +++ b/.config/cava/config.bak @@ -0,0 +1,11 @@ +[color] +gradient = 1 + +gradient_color_1 = '#81c8be' +gradient_color_2 = '#99d1db' +gradient_color_3 = '#85c1dc' +gradient_color_4 = '#8caaee' +gradient_color_5 = '#ca9ee6' +gradient_color_6 = '#f4b8e4' +gradient_color_7 = '#ea999c' +gradient_color_8 = '#e78284' diff --git a/.config/cava/shaders/bar_spectrum.frag b/.config/cava/shaders/bar_spectrum.frag new file mode 100644 index 0000000..e594618 --- /dev/null +++ b/.config/cava/shaders/bar_spectrum.frag @@ -0,0 +1,73 @@ +#version 330 + +in vec2 fragCoord; +out vec4 fragColor; + +// bar values. defaults to left channels first (low to high), then right (high to low). +uniform float bars[512]; + +uniform int bars_count; // number of bars (left + right) (configurable) +uniform int bar_width; // bar width (configurable), not used here +uniform int bar_spacing; // space bewteen bars (configurable) + +uniform vec3 u_resolution; // window resolution + +// colors, configurable in cava config file (r,g,b) (0.0 - 1.0) +uniform vec3 bg_color; // background color +uniform vec3 fg_color; // foreground color + +uniform int gradient_count; +uniform vec3 gradient_colors[8]; // gradient colors + +uniform float shader_time; // shader execution time s (not used here) + +uniform sampler2D inputTexture; // Texture from the last render pass (not used here) + +vec3 normalize_C(float y, vec3 col_1, vec3 col_2, float y_min, float y_max) { + // create color based on fraction of this color and next color + float yr = (y - y_min) / (y_max - y_min); + return col_1 * (1.0 - yr) + col_2 * yr; +} + +void main() { + // find which bar to use based on where we are on the x axis + float x = u_resolution.x * fragCoord.x; + int bar = int(bars_count * fragCoord.x); + + // calculate a bar size + float bar_size = u_resolution.x / bars_count; + + // the y coordinate and bar values are the same + float y = bars[bar]; + + // make sure there is a thin line at bottom + if (y * u_resolution.y < 1.0) { + y = 1.0 / u_resolution.y; + } + + // draw the bar up to current height + if (y > fragCoord.y) { + // make some space between bars basen on settings + if (x > (bar + 1) * (bar_size)-bar_spacing) { + fragColor = vec4(bg_color, 1.0); + } else { + if (gradient_count == 0) { + fragColor = vec4(fg_color, 1.0); + } else { + // find which color in the configured gradient we are at + int color = int((gradient_count - 1) * fragCoord.y); + + // find where on y this and next color is supposed to be + float y_min = color / (gradient_count - 1.0); + float y_max = (color + 1.0) / (gradient_count - 1.0); + + // make color + fragColor = vec4(normalize_C(fragCoord.y, gradient_colors[color], + gradient_colors[color + 1], y_min, y_max), + 1.0); + } + } + } else { + fragColor = vec4(bg_color, 1.0); + } +} \ No newline at end of file diff --git a/.config/cava/shaders/eye_of_phi.frag b/.config/cava/shaders/eye_of_phi.frag new file mode 100644 index 0000000..e499ee7 --- /dev/null +++ b/.config/cava/shaders/eye_of_phi.frag @@ -0,0 +1,117 @@ +#version 330 + +// this shader was stolen from shadertoy user ChunderFPV + +#define SCALE 8.0 +#define PI radians(180.0) +#define TAU (PI * 2.0) +#define CS(a) vec2(cos(a), sin(a)) +#define PT(u, r) smoothstep(0.0, r, r - length(u)) + +in vec2 fragCoord; +out vec4 fragColor; + +uniform float bars[512]; + +uniform int bars_count; // number of bars (left + right) (configurable) +uniform float shader_time; // shader execution time s +uniform int bar_width; // bar width (configurable), not used here +uniform int bar_spacing; // space bewteen bars (configurable) + +uniform vec3 u_resolution; // window resolution + +// colors, configurable in cava config file (r,g,b) (0.0 - 1.0) +uniform vec3 bg_color; // background color +uniform vec3 fg_color; // foreground color + +uniform int gradient_count; +uniform vec3 gradient_colors[8]; // gradient colors + +// gradient map ( color, equation, time, width, shadow, reciprocal ) +vec3 gm(vec3 c, float n, float t, float w, float d, bool i) { + float g = min(abs(n), 1.0 / abs(n)); + float s = abs(sin(n * PI - t)); + if (i) + s = min(s, abs(sin(PI / n + t))); + return (1.0 - pow(abs(s), w)) * c * pow(g, d) * 6.0; +} + +// denominator spiral, use 1/n for numerator +// ( screen xy, spiral exponent, decimal, line width, hardness, rotation ) +float ds(vec2 u, float e, float n, float w, float h, float ro) { + float ur = length(u); // unit radius + float sr = pow(ur, e); // spiral radius + float a = round(sr) * n * TAU; // arc + vec2 xy = CS(a + ro) * ur; // xy coords + float l = PT(u - xy, w); // line + float s = mod(sr + 0.5, 1.0); // gradient smooth + s = min(s, 1.0 - s); // darken filter + return l * s * h; +} + +void main() { + float t = shader_time / PI * 2.0; + vec4 m = vec4(0, 0, 0, 0); // iMouse; + m.xy = m.xy * 2.0 / u_resolution.xy - 1.0; // ±1x, ±1y + if (m.z > 0.0) + t += m.y * SCALE; // move time with mouse y + float z = (m.z > 0.0) ? pow(1.0 - abs(m.y), sign(m.y)) : 1.0; // zoom (+) + float e = (m.z > 0.0) ? pow(1.0 - abs(m.x), -sign(m.x)) + : 1.0; // screen exponent (+) + float se = (m.z > 0.0) ? e * -sign(m.y) : 1.0; // spiral exponent + vec3 bg = vec3(0); // black background + + float aa = 3.0; // anti-aliasing + + for (float j = 0.0; j < aa; j++) + for (float k = 0.0; k < aa; k++) { + vec3 c = vec3(0); + vec2 o = vec2(j, k) / aa; + vec2 uv = (fragCoord * u_resolution.xy - 0.5 * u_resolution.xy + o) / + u_resolution.y * SCALE * z; // apply cartesian, scale and zoom + if (m.z > 0.0) + uv = + exp(log(abs(uv)) * e) * sign(uv); // warp screen space with exponent + + float px = length(fwidth(uv)); // pixel width + float x = uv.x; // every pixel on x + float y = uv.y; // every pixel on y + float l = length(uv); // hypot of xy: sqrt(x*x+y*y) + + float mc = (x * x + y * y - 1.0) / y; // metallic circle at xy + float g = min(abs(mc), 1.0 / abs(mc)); // gradient + vec3 gold = vec3(1.0, 0.6, 0.0) * g * l; + vec3 blue = vec3(0.3, 0.5, 0.9) * (1.0 - g); + vec3 rgb = max(gold, blue); + + float w = 0.1; // line width + float d = 0.4; // shadow depth + c = max(c, gm(rgb, mc, -t, w * bars[0], d, false)); // metallic + c = max(c, gm(rgb, abs(y / x) * sign(y), -t, w * bars[1], d, + false)); // tangent + c = max(c, gm(rgb, (x * x) / (y * y) * sign(y), -t, w * bars[2], d, + false)); // sqrt cotangent + c = max(c, gm(rgb, (x * x) + (y * y), t, w * bars[3], d, + true)); // sqrt circles + + c += rgb * ds(uv, se, t / TAU, px * 2.0 * bars[4], 2.0, 0.0); // spiral 1a + c += rgb * ds(uv, se, t / TAU, px * 2.0 * bars[5], 2.0, PI); // spiral 1b + c += + rgb * ds(uv, -se, t / TAU, px * 2.0 * bars[6], 2.0, 0.0); // spiral 2a + c += rgb * ds(uv, -se, t / TAU, px * 2.0 * bars[7], 2.0, PI); // spiral 2b + c = max(c, 0.0); // clear negative color + + c += pow(max(1.0 - l, 0.0), 3.0 / z); // center glow + + if (m.z > 0.0) // display grid on click + { + vec2 xyg = abs(fract(uv + 0.5) - 0.5) / px; // xy grid + c.gb += 0.2 * (1.0 - min(min(xyg.x, xyg.y), 1.0)); + } + bg += c; + } + bg /= aa * aa; + bg *= sqrt(bg) * 1.5; + + fragColor = vec4(bg, 1.0); +} \ No newline at end of file diff --git a/.config/cava/shaders/northern_lights.frag b/.config/cava/shaders/northern_lights.frag new file mode 100644 index 0000000..ecd859a --- /dev/null +++ b/.config/cava/shaders/northern_lights.frag @@ -0,0 +1,34 @@ +#version 330 + +in vec2 fragCoord; +out vec4 fragColor; + +// bar values. defaults to left channels first (low to high), then right (high to low). +uniform float bars[512]; + +uniform int bars_count; // number of bars (left + right) (configurable) + +uniform vec3 u_resolution; // window resolution, not used here + +//colors, configurable in cava config file +uniform vec3 bg_color; // background color(r,g,b) (0.0 - 1.0), not used here +uniform vec3 fg_color; // foreground color, not used here + +void main() +{ + // find which bar to use based on where we are on the x axis + int bar = int(bars_count * fragCoord.x); + + float bar_y = 1.0 - abs((fragCoord.y - 0.5)) * 2.0; + float y = (bars[bar]) * bar_y; + + float bar_x = (fragCoord.x - float(bar) / float(bars_count)) * bars_count; + float bar_r = 1.0 - abs((bar_x - 0.5)) * 2; + + bar_r = bar_r * bar_r * 2; + + // set color + fragColor.r = fg_color.x * y * bar_r; + fragColor.g = fg_color.y * y * bar_r; + fragColor.b = fg_color.z * y * bar_r; +} diff --git a/.config/cava/shaders/pass_through.vert b/.config/cava/shaders/pass_through.vert new file mode 100644 index 0000000..a4f20e5 --- /dev/null +++ b/.config/cava/shaders/pass_through.vert @@ -0,0 +1,14 @@ +#version 330 + + +// Input vertex data, different for all executions of this shader. +layout(location = 0) in vec3 vertexPosition_modelspace; + +// Output data ; will be interpolated for each fragment. +out vec2 fragCoord; + +void main() +{ + gl_Position = vec4(vertexPosition_modelspace,1); + fragCoord = (vertexPosition_modelspace.xy+vec2(1,1))/2.0; +} diff --git a/.config/cava/shaders/spectrogram.frag b/.config/cava/shaders/spectrogram.frag new file mode 100644 index 0000000..adce70a --- /dev/null +++ b/.config/cava/shaders/spectrogram.frag @@ -0,0 +1,53 @@ +#version 330 + +in vec2 fragCoord; +out vec4 fragColor; + +// bar values. defaults to left channels first (low to high), then right (high +// to low). +uniform float bars[512]; + +uniform int bars_count; // number of bars (left + right) (configurable) +uniform int bar_width; // bar width (configurable), not used here +uniform int bar_spacing; // space bewteen bars (configurable) + +uniform vec3 u_resolution; // window resolution + +// colors, configurable in cava config file (r,g,b) (0.0 - 1.0) +uniform vec3 bg_color; // background color +uniform vec3 fg_color; // foreground color + +uniform int gradient_count; +uniform vec3 gradient_colors[8]; // gradient colors + +uniform sampler2D inputTexture; // Texture from the last render pass + +vec3 normalize_C(float y, vec3 col_1, vec3 col_2, float y_min, float y_max) { + // create color based on fraction of this color and next color + float yr = (y - y_min) / (y_max - y_min); + return col_1 * (1.0 - yr) + col_2 * yr; +} + +void main() { + // find which bar to use based on where we are on the y axis + int bar = int(bars_count * fragCoord.y); + float y = bars[bar]; + float band_size = 1.0 / float(bars_count); + float current_band_min = bar * band_size; + float current_band_max = (bar + 1) * band_size; + + int hist_length = 512; + float win_size = 1.0 / hist_length; + + if (fragCoord.x > 1.0 - win_size) { + + if (fragCoord.y > current_band_min && fragCoord.y < current_band_max) { + + fragColor = vec4(fg_color * y, 1.0); + } + } else { + vec2 offsetCoord = fragCoord; + offsetCoord.x += float(win_size); + fragColor = texture(inputTexture, offsetCoord); + } +} \ No newline at end of file diff --git a/.config/cava/shaders/winamp_line_style_spectrum.frag b/.config/cava/shaders/winamp_line_style_spectrum.frag new file mode 100644 index 0000000..375ff27 --- /dev/null +++ b/.config/cava/shaders/winamp_line_style_spectrum.frag @@ -0,0 +1,112 @@ +#version 330 + +// Emulate the "line style" spectrum analyzer from Winamp 2. +// Try this config for a demonstration: + +/* +[general] +bar_width = 2 +bar_spacing = 0 +higher_cutoff_freq = 22000 + +[output] +method = sdl_glsl +channels = mono +fragment_shader = winamp_line_style_spectrum.frag + +[color] +background = '#000000' +gradient = 1 +gradient_color_1 = '#319C08' +gradient_color_2 = '#29CE10' +gradient_color_3 = '#BDDE29' +gradient_color_4 = '#DEA518' +gradient_color_5 = '#D66600' +gradient_color_6 = '#CE2910' + +[smoothing] +noise_reduction = 10 +*/ + +in vec2 fragCoord; +out vec4 fragColor; + +// bar values. defaults to left channels first (low to high), then right (high to low). +uniform float bars[512]; + +uniform int bars_count; // number of bars (left + right) (configurable) +uniform int bar_width; // bar width (configurable), not used here +uniform int bar_spacing; // space bewteen bars (configurable) + +uniform vec3 u_resolution; // window resolution + +//colors, configurable in cava config file (r,g,b) (0.0 - 1.0) +uniform vec3 bg_color; // background color +uniform vec3 fg_color; // foreground color + +uniform int gradient_count; +uniform vec3 gradient_colors[8]; // gradient colors + +vec3 normalize_C(float y,vec3 col_1, vec3 col_2, float y_min, float y_max) +{ + //create color based on fraction of this color and next color + float yr = (y - y_min) / (y_max - y_min); + return col_1 * (1.0 - yr) + col_2 * yr; +} + +void main() +{ + // find which bar to use based on where we are on the x axis + float x = u_resolution.x * fragCoord.x; + int bar = int(bars_count * fragCoord.x); + + //calculate a bar size + float bar_size = u_resolution.x / bars_count; + + //the y coordinate is stretched by 4X to resemble Winamp + float y = min(bars[bar] * 4.0, 1.0); + + // make sure there is a thin line at bottom + if (y * u_resolution.y < 1.0) + { + y = 1.0 / u_resolution.y; + } + + vec4 bar_color; + + if (gradient_count == 0) + { + bar_color = vec4(fg_color,1.0); + } + else + { + //find color in the configured gradient for the top of the bar + int color = int((gradient_count - 1) * y); + + //find where on y this and next color is supposed to be + float y_min = float(color) / (gradient_count - 1.0); + float y_max = float(color + 1) / (gradient_count - 1.0); + + //make a solid color for the entire bar + bar_color = vec4(normalize_C(y, gradient_colors[color], gradient_colors[color + 1], y_min, y_max), 1.0); + } + + + //draw the bar up to current height + if (y > fragCoord.y) + { + //make some space between bars based on settings + if (x > (bar + 1) * (bar_size) - bar_spacing) + { + fragColor = vec4(bg_color,1.0); + } + else + { + fragColor = bar_color; + } + } + else + { + fragColor = vec4(bg_color,1.0); + } +} \ No newline at end of file diff --git a/.config/cava/themes/solarized_dark b/.config/cava/themes/solarized_dark new file mode 100644 index 0000000..200057c --- /dev/null +++ b/.config/cava/themes/solarized_dark @@ -0,0 +1,15 @@ +[color] +background = '#001e26' +foreground = '#708183' + +gradient = 1 +gradient_color_1 = '#268bd2' +gradient_color_2 = '#6c71c4' +gradient_color_3 = '#cb4b16' + +horizontal_gradient = 1 +horizontal_gradient_color_1 = '#586e75' +horizontal_gradient_color_2 = '#b58900' +horizontal_gradient_color_3 = '#839496' + +blend_direction = 'up' \ No newline at end of file diff --git a/.config/cava/themes/tricolor b/.config/cava/themes/tricolor new file mode 100644 index 0000000..b908137 --- /dev/null +++ b/.config/cava/themes/tricolor @@ -0,0 +1,10 @@ +[color] +horizontal_gradient = 1 +horizontal_gradient_color_1 = '#c45161' +horizontal_gradient_color_2 = '#e094a0' +horizontal_gradient_color_3 = '#f2b6c0' +horizontal_gradient_color_4 = '#f2dde1' +horizontal_gradient_color_5 = '#cbc7d8' +horizontal_gradient_color_6 = '#8db7d2' +horizontal_gradient_color_7 = '#5e62a9' +horizontal_gradient_color_8 = '#434279' \ No newline at end of file diff --git a/.config/fastfetch b/.config/fastfetch new file mode 160000 index 0000000..5125578 --- /dev/null +++ b/.config/fastfetch @@ -0,0 +1 @@ +Subproject commit 5125578d9ceb787b923a91f4416f4b49f18806f3 diff --git a/.config/fuzzel/fuzzel.ini b/.config/fuzzel/fuzzel.ini new file mode 100644 index 0000000..b129ee4 --- /dev/null +++ b/.config/fuzzel/fuzzel.ini @@ -0,0 +1,12 @@ +[colors] +background=eff1f5ff +text=4c4f69ff +prompt=5c5f77ff +placeholder=8c8fa1ff +input=4c4f69ff +match=1e66f5ff +selection=acb0beff +selection-text=4c4f69ff +selection-match=1e66f5ff +counter=8c8fa1ff +border=1e66f5ff diff --git a/.config/kitty/current-theme.conf b/.config/kitty/current-theme.conf new file mode 100644 index 0000000..19d2e40 --- /dev/null +++ b/.config/kitty/current-theme.conf @@ -0,0 +1,21 @@ +background #212733 +foreground #d9d7ce +cursor #ffcc66 +selection_background #343f4c +color0 #191e2a +color8 #686868 +color1 #ed8274 +color9 #f28779 +color2 #a6cc70 +color10 #bae67e +color3 #fad07b +color11 #ffd580 +color4 #6dcbfa +color12 #73d0ff +color5 #cfbafa +color13 #d4bfff +color6 #90e1c6 +color14 #95e6cb +color7 #c7c7c7 +color15 #ffffff +selection_foreground #212733 diff --git a/.config/kitty/kitty.conf b/.config/kitty/kitty.conf new file mode 100644 index 0000000..ce3ceee --- /dev/null +++ b/.config/kitty/kitty.conf @@ -0,0 +1,2801 @@ +# vim:fileencoding=utf-8:foldmethod=marker + +# BEGIN_KITTY_THEME +# Ayu Mirage +include current-theme.conf +# END_KITTY_THEME + +# 启动时执行 fastfetch +shell zsh -l -c "fastfetch; exec zsh" + +#: Fonts {{{ + +#: kitty has very powerful font management. You can configure +#: individual font faces and even specify special fonts for particular +#: characters. + +font_family hack +bold_font auto +italic_font auto +bold_italic_font auto + +#: You can specify different fonts for the bold/italic/bold-italic +#: variants. The easiest way to select fonts is to run the `kitten +#: choose-fonts` command which will present a nice UI for you to +#: select the fonts you want with previews and support for selecting +#: variable fonts and font features. If you want to learn to select +#: fonts manually, read the font specification syntax +#: . + +font_size 14.0 + +#: Font size (in pts). + +# force_ltr no + +#: kitty does not support BIDI (bidirectional text), however, for RTL +#: scripts, words are automatically displayed in RTL. That is to say, +#: in an RTL script, the words "HELLO WORLD" display in kitty as +#: "WORLD HELLO", and if you try to select a substring of an RTL- +#: shaped string, you will get the character that would be there had +#: the string been LTR. For example, assuming the Hebrew word ירושלים, +#: selecting the character that on the screen appears to be ם actually +#: writes into the selection buffer the character י. kitty's default +#: behavior is useful in conjunction with a filter to reverse the word +#: order, however, if you wish to manipulate RTL glyphs, it can be +#: very challenging to work with, so this option is provided to turn +#: it off. Furthermore, this option can be used with the command line +#: program GNU FriBidi +#: to get BIDI support, because it will force kitty to always treat +#: the text as LTR, which FriBidi expects for terminals. + +# symbol_map + +#: E.g. symbol_map U+E0A0-U+E0A3,U+E0C0-U+E0C7 PowerlineSymbols + +#: Map the specified Unicode codepoints to a particular font. Useful +#: if you need special rendering for some symbols, such as for +#: Powerline. Avoids the need for patched fonts. Each Unicode code +#: point is specified in the form `U+`. You +#: can specify multiple code points, separated by commas and ranges +#: separated by hyphens. This option can be specified multiple times. +#: The syntax is:: + +#: symbol_map codepoints Font Family Name + +# narrow_symbols + +#: E.g. narrow_symbols U+E0A0-U+E0A3,U+E0C0-U+E0C7 1 + +#: Usually, for Private Use Unicode characters and some symbol/dingbat +#: characters, if the character is followed by one or more spaces, +#: kitty will use those extra cells to render the character larger, if +#: the character in the font has a wide aspect ratio. Using this +#: option you can force kitty to restrict the specified code points to +#: render in the specified number of cells (defaulting to one cell). +#: This option can be specified multiple times. The syntax is:: + +#: narrow_symbols codepoints [optionally the number of cells] + +# disable_ligatures never + +#: Choose how you want to handle multi-character ligatures. The +#: default is to always render them. You can tell kitty to not render +#: them when the cursor is over them by using cursor to make editing +#: easier, or have kitty never render them at all by using always, if +#: you don't like them. The ligature strategy can be set per-window +#: either using the kitty remote control facility or by defining +#: shortcuts for it in kitty.conf, for example:: + +#: map alt+1 disable_ligatures_in active always +#: map alt+2 disable_ligatures_in all never +#: map alt+3 disable_ligatures_in tab cursor + +#: Note that this refers to programming ligatures, typically +#: implemented using the calt OpenType feature. For disabling general +#: ligatures, use the font_features option. + +# font_features + +#: E.g. font_features none + +#: Choose exactly which OpenType features to enable or disable. Note +#: that for the main fonts, features can be specified when selecting +#: the font using the choose-fonts kitten. This setting is useful for +#: fallback fonts. + +#: Some fonts might have features worthwhile in a terminal. For +#: example, Fira Code includes a discretionary feature, zero, which in +#: that font changes the appearance of the zero (0), to make it more +#: easily distinguishable from Ø. Fira Code also includes other +#: discretionary features known as Stylistic Sets which have the tags +#: ss01 through ss20. + +#: For the exact syntax to use for individual features, see the +#: HarfBuzz documentation . + +#: Note that this code is indexed by PostScript name, and not the font +#: family. This allows you to define very precise feature settings; +#: e.g. you can disable a feature in the italic font but not in the +#: regular font. + +#: On Linux, font features are first read from the FontConfig database +#: and then this option is applied, so they can be configured in a +#: single, central place. + +#: To get the PostScript name for a font, use the `fc-scan file.ttf` +#: command on Linux or the `Font Book tool on macOS +#: `__. + +#: Enable alternate zero and oldstyle numerals:: + +#: font_features FiraCode-Retina +zero +onum + +#: Enable only alternate zero in the bold font:: + +#: font_features FiraCode-Bold +zero + +#: Disable the normal ligatures, but keep the calt feature which (in +#: this font) breaks up monotony:: + +#: font_features TT2020StyleB-Regular -liga +calt + +#: In conjunction with force_ltr, you may want to disable Arabic +#: shaping entirely, and only look at their isolated forms if they +#: show up in a document. You can do this with e.g.:: + +#: font_features UnifontMedium +isol -medi -fina -init + +# modify_font + +#: Modify font characteristics such as the position or thickness of +#: the underline and strikethrough. The modifications can have the +#: suffix px for pixels or % for percentage of original value. No +#: suffix means use pts. For example:: + +#: modify_font underline_position -2 +#: modify_font underline_thickness 150% +#: modify_font strikethrough_position 2px + +#: Additionally, you can modify the size of the cell in which each +#: font glyph is rendered and the baseline at which the glyph is +#: placed in the cell. For example:: + +#: modify_font cell_width 80% +#: modify_font cell_height -2px +#: modify_font baseline 3 + +#: Note that modifying the baseline will automatically adjust the +#: underline and strikethrough positions by the same amount. +#: Increasing the baseline raises glyphs inside the cell and +#: decreasing it lowers them. Decreasing the cell size might cause +#: rendering artifacts, so use with care. + +# box_drawing_scale 0.001, 1, 1.5, 2 + +#: The sizes of the lines used for the box drawing Unicode characters. +#: These values are in pts. They will be scaled by the monitor DPI to +#: arrive at a pixel value. There must be four values corresponding to +#: thin, normal, thick, and very thick lines. + +# undercurl_style thin-sparse + +#: The style with which undercurls are rendered. This option takes the +#: form (thin|thick)-(sparse|dense). Thin and thick control the +#: thickness of the undercurl. Sparse and dense control how often the +#: curl oscillates. With sparse the curl will peak once per character, +#: with dense twice. Changing this option dynamically via reloading +#: the config or remote control is undefined. + +# underline_exclusion 1 + +#: By default kitty renders gaps in underlines when they overlap with +#: descenders (the parts of letters below the baseline, such as for y, +#: q, p etc.). This option controls the thickness of the gaps. It can +#: be either a unitless number in which case it is a fraction of the +#: underline thickness as specified in the font or it can have a +#: suffix of px for pixels or pt for points. Set to zero to disable +#: the gaps. Changing this option dynamically via reloading the config +#: or remote control is undefined. + +# text_composition_strategy platform + +#: Control how kitty composites text glyphs onto the background color. +#: The default value of platform tries for text rendering as close to +#: "native" for the platform kitty is running on as possible. + +#: A value of legacy uses the old (pre kitty 0.28) strategy for how +#: glyphs are composited. This will make dark text on light +#: backgrounds look thicker and light text on dark backgrounds +#: thinner. It might also make some text appear like the strokes are +#: uneven. + +#: You can fine tune the actual contrast curve used for glyph +#: composition by specifying up to two space-separated numbers for +#: this setting. + +#: The first number is the gamma adjustment, which controls the +#: thickness of dark text on light backgrounds. Increasing the value +#: will make text appear thicker. The default value for this is 1.0 on +#: Linux and 1.7 on macOS. Valid values are 0.01 and above. The result +#: is scaled based on the luminance difference between the background +#: and the foreground. Dark text on light backgrounds receives the +#: full impact of the curve while light text on dark backgrounds is +#: affected very little. + +#: The second number is an additional multiplicative contrast. It is +#: percentage ranging from 0 to 100. The default value is 0 on Linux +#: and 30 on macOS. + +#: If you wish to achieve similar looking thickness in light and dark +#: themes, a good way to experiment is start by setting the value to +#: 1.0 0 and use a dark theme. Then adjust the second parameter until +#: it looks good. Then switch to a light theme and adjust the first +#: parameter until the perceived thickness matches the dark theme. + +# text_fg_override_threshold 0 + +#: A setting to prevent low contrast between foreground and background +#: colors. Useful when working with applications that use colors that +#: do not contrast well with your preferred color scheme. The default +#: value is 0, which means no color overriding is performed. There are +#: two modes of operation: + +#: A value with the suffix ratio represents the minimum accepted +#: contrast ratio between the foreground and background color. +#: Possible values range from 0.0 ratio to 21.0 ratio. For example, to +#: meet WCAG level AA +#: +#: a value of 4.5 ratio can be provided. The algorithm is implemented +#: using HSLuv which enables it to change the +#: perceived lightness of a color just as much as needed without +#: really changing its hue and saturation. + +#: A value with the suffix % represents the minimum accepted +#: difference in luminance between the foreground and background +#: color, below which kitty will override the foreground color. It is +#: percentage ranging from 0 % to 100 %. If the difference in +#: luminance of the foreground and background is below this threshold, +#: the foreground color will be set to white if the background is dark +#: or black if the background is light. + +#: WARNING: Some programs use characters (such as block characters) +#: for graphics display and may expect to be able to set the +#: foreground and background to the same color (or similar colors). If +#: you see unexpected stripes, dots, lines, incorrect color, no color +#: where you expect color, or any kind of graphic display problem try +#: setting text_fg_override_threshold to 0 to see if this is the cause +#: of the problem or consider using the ratio mode of operation +#: described above instead of the % mode of operation. + +#: }}} + +#: Text cursor customization {{{ + +# cursor #cccccc + +#: Default text cursor color. If set to the special value none the +#: cursor will be rendered with a "reverse video" effect. Its color +#: will be the color of the text in the cell it is over and the text +#: will be rendered with the background color of the cell. Note that +#: if the program running in the terminal sets a cursor color, this +#: takes precedence. Also, the cursor colors are modified if the cell +#: background and foreground colors have very low contrast. Note that +#: some themes set this value, so if you want to override it, place +#: your value after the lines where the theme file is included. + +# cursor_text_color #111111 + +#: The color of text under the cursor. If you want it rendered with +#: the background color of the cell underneath instead, use the +#: special keyword: `background`. Note that if cursor is set to none +#: then this option is ignored. Note that some themes set this value, +#: so if you want to override it, place your value after the lines +#: where the theme file is included. + +# cursor_shape block + +#: The cursor shape can be one of block, beam, underline. Note that +#: when reloading the config this will be changed only if the cursor +#: shape has not been set by the program running in the terminal. This +#: sets the default cursor shape, applications running in the terminal +#: can override it. In particular, shell integration +#: in kitty sets +#: the cursor shape to beam at shell prompts. You can avoid this by +#: setting shell_integration to no-cursor. + +# cursor_shape_unfocused hollow + +#: Defines the text cursor shape when the OS window is not focused. +#: The unfocused cursor shape can be one of block, beam, underline, +#: hollow and unchanged (leave the cursor shape as it is). + +# cursor_beam_thickness 1.5 + +#: The thickness of the beam cursor (in pts). + +# cursor_underline_thickness 2.0 + +#: The thickness of the underline cursor (in pts). + +# cursor_blink_interval -1 + +#: The interval to blink the cursor (in seconds). Set to zero to +#: disable blinking. Negative values mean use system default. Note +#: that the minimum interval will be limited to repaint_delay. You can +#: also animate the cursor blink by specifying an easing function. For +#: example, setting this to option to 0.5 ease-in-out will cause the +#: cursor blink to be animated over a second, in the first half of the +#: second it will go from opaque to transparent and then back again +#: over the next half. You can specify different easing functions for +#: the two halves, for example: -1 linear ease-out. kitty supports all +#: the CSS easing functions . Note that turning on animations +#: uses extra power as it means the screen is redrawn multiple times +#: per blink interval. See also, cursor_stop_blinking_after. + +# cursor_stop_blinking_after 15.0 + +#: Stop blinking cursor after the specified number of seconds of +#: keyboard inactivity. Set to zero to never stop blinking. + +cursor_trail 1 + +#: Set this to a value larger than zero to enable a "cursor trail" +#: animation. This is an animation that shows a "trail" following the +#: movement of the text cursor. It makes it easy to follow large +#: cursor jumps and makes for a cool visual effect of the cursor +#: zooming around the screen. The actual value of this option controls +#: when the animation is triggered. It is a number of milliseconds. +#: The trail animation only follows cursors that have stayed in their +#: position for longer than the specified number of milliseconds. This +#: prevents trails from appearing for cursors that rapidly change +#: their positions during UI updates in complex applications. See +#: cursor_trail_decay to control the animation speed and +#: cursor_trail_start_threshold to control when a cursor trail is +#: started. + +cursor_trail_decay 0.1 0.4 + +#: Controls the decay times for the cursor trail effect when the +#: cursor_trail is enabled. This option accepts two positive float +#: values specifying the fastest and slowest decay times in seconds. +#: The first value corresponds to the fastest decay time (minimum), +#: and the second value corresponds to the slowest decay time +#: (maximum). The second value must be equal to or greater than the +#: first value. Smaller values result in a faster decay of the cursor +#: trail. Adjust these values to control how quickly the cursor trail +#: fades away. + +# cursor_trail_start_threshold 2 + +#: Set the distance threshold for starting the cursor trail. This +#: option accepts a positive integer value that represents the minimum +#: number of cells the cursor must move before the trail is started. +#: When the cursor moves less than this threshold, the trail is +#: skipped, reducing unnecessary cursor trail animation. + +#: }}} + +#: Scrollback {{{ + +# scrollback_lines 2000 + +#: Number of lines of history to keep in memory for scrolling back. +#: Memory is allocated on demand. Negative numbers are (effectively) +#: infinite scrollback. Note that using very large scrollback is not +#: recommended as it can slow down performance of the terminal and +#: also use large amounts of RAM. Instead, consider using +#: scrollback_pager_history_size. Note that on config reload if this +#: is changed it will only affect newly created windows, not existing +#: ones. + +# scrollback_indicator_opacity 1.0 + +#: The opacity of the scrollback indicator which is a small colored +#: rectangle that moves along the right hand side of the window as you +#: scroll, indicating what fraction you have scrolled. The default is +#: one which means fully opaque, aka visible. Set to a value between +#: zero and one to make the indicator less visible. + +# scrollback_pager less --chop-long-lines --RAW-CONTROL-CHARS +INPUT_LINE_NUMBER + +#: Program with which to view scrollback in a new window. The +#: scrollback buffer is passed as STDIN to this program. If you change +#: it, make sure the program you use can handle ANSI escape sequences +#: for colors and text formatting. INPUT_LINE_NUMBER in the command +#: line above will be replaced by an integer representing which line +#: should be at the top of the screen. Similarly CURSOR_LINE and +#: CURSOR_COLUMN will be replaced by the current cursor position or +#: set to 0 if there is no cursor, for example, when showing the last +#: command output. + +# scrollback_pager_history_size 0 + +#: Separate scrollback history size (in MB), used only for browsing +#: the scrollback buffer with pager. This separate buffer is not +#: available for interactive scrolling but will be piped to the pager +#: program when viewing scrollback buffer in a separate window. The +#: current implementation stores the data in UTF-8, so approximately +#: 10000 lines per megabyte at 100 chars per line, for pure ASCII, +#: unformatted text. A value of zero or less disables this feature. +#: The maximum allowed size is 4GB. Note that on config reload if this +#: is changed it will only affect newly created windows, not existing +#: ones. + +# scrollback_fill_enlarged_window no + +#: Fill new space with lines from the scrollback buffer after +#: enlarging a window. + +# wheel_scroll_multiplier 5.0 + +#: Multiplier for the number of lines scrolled by the mouse wheel. +#: Note that this is only used for low precision scrolling devices, +#: not for high precision scrolling devices on platforms such as macOS +#: and Wayland. Use negative numbers to change scroll direction. See +#: also wheel_scroll_min_lines. + +# wheel_scroll_min_lines 1 + +#: The minimum number of lines scrolled by the mouse wheel. The scroll +#: multiplier wheel_scroll_multiplier only takes effect after it +#: reaches this number. Note that this is only used for low precision +#: scrolling devices like wheel mice that scroll by very small amounts +#: when using the wheel. With a negative number, the minimum number of +#: lines will always be added. + +# touch_scroll_multiplier 1.0 + +#: Multiplier for the number of lines scrolled by a touchpad. Note +#: that this is only used for high precision scrolling devices on +#: platforms such as macOS and Wayland. Use negative numbers to change +#: scroll direction. + +#: }}} + +#: Mouse {{{ + +# mouse_hide_wait 3.0 + +#: Hide mouse cursor after the specified number of seconds of the +#: mouse not being used. Set to zero to disable mouse cursor hiding. +#: Set to a negative value to hide the mouse cursor immediately when +#: typing text. Disabled by default on macOS as getting it to work +#: robustly with the ever-changing sea of bugs that is Cocoa is too +#: much effort. + +#: By default, once the cursor is hidden, it is immediately unhidden +#: on any further mouse events. + +#: Two formats are supported: +#: - +#: - + +#: To change the unhide behavior, the optional parameters , , and may be set. + +#: +#: Waits for the specified number of seconds after mouse events before unhiding the +#: mouse cursor. Set to zero to unhide mouse cursor immediately on mouse activity. +#: This is useful to prevent the mouse cursor from unhiding on accidental swipes on +#: the trackpad. + +#: +#: Sets the threshold of mouse activity required to unhide the mouse cursor, when +#: the option is non-zero. When is zero, this has no +#: effect. + +#: For example, if is 40 and is 2.5, when kitty +#: detects a mouse event, it records the number of mouse events in the next 2.5 +#: seconds, and checks if that exceeds 40 * 2.5 = 100. If it does, then the mouse +#: cursor is unhidden, otherwise nothing happens. + +#: +#: Controls what mouse events may unhide the mouse cursor. If enabled, both scroll +#: and movement events may unhide the cursor. If disabled, only mouse movements can +#: unhide the cursor. + +#: Examples of valid values: +#: - 0.0 +#: - 1.0 +#: - -1.0 +#: - 0.1 3.0 40 yes + +# url_color #0087bd +# url_style curly + +#: The color and style for highlighting URLs on mouse-over. url_style +#: can be one of: none, straight, double, curly, dotted, dashed. + +# open_url_with default + +#: The program to open clicked URLs. The special value default will +#: first look for any URL handlers defined via the open_actions +#: facility and if non +#: are found, it will use the Operating System's default URL handler +#: (open on macOS and xdg-open on Linux). + +# url_prefixes file ftp ftps gemini git gopher http https irc ircs kitty mailto news sftp ssh + +#: The set of URL prefixes to look for when detecting a URL under the +#: mouse cursor. + +# detect_urls yes + +#: Detect URLs under the mouse. Detected URLs are highlighted with an +#: underline and the mouse cursor becomes a hand over them. Even if +#: this option is disabled, URLs are still clickable. See also the +#: underline_hyperlinks option to control how hyperlinks (as opposed +#: to plain text URLs) are displayed. + +# url_excluded_characters + +#: Additional characters to be disallowed from URLs, when detecting +#: URLs under the mouse cursor. By default, all characters that are +#: legal in URLs are allowed. Additionally, newlines are allowed (but +#: stripped). This is to accommodate programs such as mutt that add +#: hard line breaks even for continued lines. \n can be added to this +#: option to disable this behavior. Special characters can be +#: specified using backslash escapes, to specify a backslash use a +#: double backslash. + +# show_hyperlink_targets no + +#: When the mouse hovers over a terminal hyperlink, show the actual +#: URL that will be activated when the hyperlink is clicked. + +# underline_hyperlinks hover + +#: Control how hyperlinks are underlined. They can either be +#: underlined on mouse hover, always (i.e. permanently underlined) or +#: never which means that kitty will not apply any underline styling +#: to hyperlinks. Note that the value of always only applies to real +#: (OSC 8) hyperlinks not text that is detected to be a URL on mouse +#: hover. Uses the url_style and url_color settings for the underline +#: style. Note that reloading the config and changing this value +#: to/from always will only affect text subsequently received by +#: kitty. + +copy_on_select yes + +#: Copy to clipboard or a private buffer on select. With this set to +#: clipboard, selecting text with the mouse will cause the text to be +#: copied to clipboard. Useful on platforms such as macOS that do not +#: have the concept of primary selection. You can instead specify a +#: name such as a1 to copy to a private kitty buffer. Map a shortcut +#: with the paste_from_buffer action to paste from this private +#: buffer. For example:: + +#: copy_on_select a1 +#: map shift+cmd+v paste_from_buffer a1 + +#: Note that copying to the clipboard is a security risk, as all +#: programs, including websites open in your browser can read the +#: contents of the system clipboard. + +# clear_selection_on_clipboard_loss no + +#: When the contents of the clipboard no longer reflect the current +#: selection, clear it. This is primarily useful on platforms such as +#: Linux where selecting text automatically copies it to a special +#: "primary selection" clipboard or if you have copy_on_select set to +#: clipboard. + +#: Note that on macOS the system does not provide notifications when +#: the clipboard owner is changed, so there, copying to clipboard in a +#: non-kitty application will not clear selections even if +#: copy_on_select is enabled. + +# paste_actions quote-urls-at-prompt,confirm + +#: A comma separated list of actions to take when pasting text into +#: the terminal. The supported paste actions are: + +#: quote-urls-at-prompt: +#: If the text being pasted is a URL and the cursor is at a shell prompt, +#: automatically quote the URL (needs shell_integration). +#: replace-dangerous-control-codes +#: Replace dangerous control codes from pasted text, without confirmation. +#: replace-newline +#: Replace the newline character from pasted text, without confirmation. +#: confirm: +#: Confirm the paste if the text to be pasted contains any terminal control codes +#: as this can be dangerous, leading to code execution if the shell/program running +#: in the terminal does not properly handle these. +#: confirm-if-large +#: Confirm the paste if it is very large (larger than 16KB) as pasting +#: large amounts of text into shells can be very slow. +#: filter: +#: Run the filter_paste() function from the file paste-actions.py in +#: the kitty config directory on the pasted text. The text returned by the +#: function will be actually pasted. +#: no-op: +#: Has no effect. + +# strip_trailing_spaces never + +#: Remove spaces at the end of lines when copying to clipboard. A +#: value of smart will do it when using normal selections, but not +#: rectangle selections. A value of always will always do it. + +# select_by_word_characters @-./_~?&=%+# + +#: Characters considered part of a word when double clicking. In +#: addition to these characters any character that is marked as an +#: alphanumeric character in the Unicode database will be matched. + +# select_by_word_characters_forward + +#: Characters considered part of a word when extending the selection +#: forward on double clicking. In addition to these characters any +#: character that is marked as an alphanumeric character in the +#: Unicode database will be matched. + +#: If empty (default) select_by_word_characters will be used for both +#: directions. + +# click_interval -1.0 + +#: The interval between successive clicks to detect double/triple +#: clicks (in seconds). Negative numbers will use the system default +#: instead, if available, or fallback to 0.5. + +# focus_follows_mouse no + +#: Set the active window to the window under the mouse when moving the +#: mouse around. On macOS, this will also cause the OS Window under +#: the mouse to be focused automatically when the mouse enters it. + +# pointer_shape_when_grabbed arrow + +#: The shape of the mouse pointer when the program running in the +#: terminal grabs the mouse. + +# default_pointer_shape beam + +#: The default shape of the mouse pointer. + +# pointer_shape_when_dragging beam crosshair + +#: The default shape of the mouse pointer when dragging across text. +#: The optional second value sets the shape when dragging in +#: rectangular selection mode. + +#: Mouse actions {{{ + +#: Mouse buttons can be mapped to perform arbitrary actions. The +#: syntax is: + +#: .. code-block:: none + +#: mouse_map button-name event-type modes action + +#: Where button-name is one of left, middle, right, b1 ... b8 with +#: added keyboard modifiers. For example: ctrl+shift+left refers to +#: holding the Ctrl+Shift keys while clicking with the left mouse +#: button. The value b1 ... b8 can be used to refer to up to eight +#: buttons on a mouse. + +#: event-type is one of press, release, doublepress, triplepress, +#: click, doubleclick. modes indicates whether the action is performed +#: when the mouse is grabbed by the program running in the terminal, +#: or not. The values are grabbed or ungrabbed or a comma separated +#: combination of them. grabbed refers to when the program running in +#: the terminal has requested mouse events. Note that the click and +#: double click events have a delay of click_interval to disambiguate +#: from double and triple presses. + +#: You can run kitty with the kitty --debug-input command line option +#: to see mouse events. See the builtin actions below to get a sense +#: of what is possible. + +#: If you want to unmap a button, map it to nothing. For example, to +#: disable opening of URLs with a plain click:: + +#: mouse_map left click ungrabbed + +#: See all the mappable actions including mouse actions here +#: . + +#: .. note:: +#: Once a selection is started, releasing the button that started it will +#: automatically end it and no release event will be dispatched. + +# clear_all_mouse_actions no + +#: Remove all mouse action definitions up to this point. Useful, for +#: instance, to remove the default mouse actions. + +#: Click the link under the mouse or move the cursor + +# mouse_map left click ungrabbed mouse_handle_click selection link prompt + +#:: First check for a selection and if one exists do nothing. Then +#:: check for a link under the mouse cursor and if one exists, click +#:: it. Finally check if the click happened at the current shell +#:: prompt and if so, move the cursor to the click location. Note +#:: that this requires shell integration +#:: to work. + +#: Click the link under the mouse or move the cursor even when grabbed + +# mouse_map shift+left click grabbed,ungrabbed mouse_handle_click selection link prompt + +#:: Same as above, except that the action is performed even when the +#:: mouse is grabbed by the program running in the terminal. + +#: Click the link under the mouse cursor + +# mouse_map ctrl+shift+left release grabbed,ungrabbed mouse_handle_click link + +#:: Variant with Ctrl+Shift is present because the simple click based +#:: version has an unavoidable delay of click_interval, to +#:: disambiguate clicks from double clicks. + +#: Discard press event for link click + +# mouse_map ctrl+shift+left press grabbed discard_event + +#:: Prevent this press event from being sent to the program that has +#:: grabbed the mouse, as the corresponding release event is used to +#:: open a URL. + +#: Paste from the primary selection + +# mouse_map middle release ungrabbed paste_from_selection + +#: Start selecting text + +# mouse_map left press ungrabbed mouse_selection normal + +#: Start selecting text in a rectangle + +# mouse_map ctrl+alt+left press ungrabbed mouse_selection rectangle + +#: Select a word + +# mouse_map left doublepress ungrabbed mouse_selection word + +#: Select a line + +# mouse_map left triplepress ungrabbed mouse_selection line + +#: Select line from point + +# mouse_map ctrl+alt+left triplepress ungrabbed mouse_selection line_from_point + +#:: Select from the clicked point to the end of the line. If you +#:: would like to select the word at the point and then extend to the +#:: rest of the line, change `line_from_point` to +#:: `word_and_line_from_point`. + +#: Extend the current selection + +# mouse_map right press ungrabbed mouse_selection extend + +#:: If you want only the end of the selection to be moved instead of +#:: the nearest boundary, use move-end instead of extend. + +#: Paste from the primary selection even when grabbed + +# mouse_map shift+middle release ungrabbed,grabbed paste_selection +# mouse_map shift+middle press grabbed discard_event + +#: Start selecting text even when grabbed + +# mouse_map shift+left press ungrabbed,grabbed mouse_selection normal + +#: Start selecting text in a rectangle even when grabbed + +# mouse_map ctrl+shift+alt+left press ungrabbed,grabbed mouse_selection rectangle + +#: Select a word even when grabbed + +# mouse_map shift+left doublepress ungrabbed,grabbed mouse_selection word + +#: Select a line even when grabbed + +# mouse_map shift+left triplepress ungrabbed,grabbed mouse_selection line + +#: Select line from point even when grabbed + +# mouse_map ctrl+shift+alt+left triplepress ungrabbed,grabbed mouse_selection line_from_point + +#:: Select from the clicked point to the end of the line even when +#:: grabbed. If you would like to select the word at the point and +#:: then extend to the rest of the line, change `line_from_point` to +#:: `word_and_line_from_point`. + +#: Extend the current selection even when grabbed + +# mouse_map shift+right press ungrabbed,grabbed mouse_selection extend + +#: Show clicked command output in pager + +# mouse_map ctrl+shift+right press ungrabbed mouse_show_command_output + +#:: Requires shell integration +#:: to work. + +#: }}} + +#: }}} + +#: Performance tuning {{{ + +# repaint_delay 10 + +#: Delay between screen updates (in milliseconds). Decreasing it, +#: increases frames-per-second (FPS) at the cost of more CPU usage. +#: The default value yields ~100 FPS which is more than sufficient for +#: most uses. Note that to actually achieve 100 FPS, you have to +#: either set sync_to_monitor to no or use a monitor with a high +#: refresh rate. Also, to minimize latency when there is pending input +#: to be processed, this option is ignored. + +# input_delay 3 + +#: Delay before input from the program running in the terminal is +#: processed (in milliseconds). Note that decreasing it will increase +#: responsiveness, but also increase CPU usage and might cause flicker +#: in full screen programs that redraw the entire screen on each loop, +#: because kitty is so fast that partial screen updates will be drawn. +#: This setting is ignored when the input buffer is almost full. + +# sync_to_monitor yes + +#: Sync screen updates to the refresh rate of the monitor. This +#: prevents screen tearing +#: when scrolling. +#: However, it limits the rendering speed to the refresh rate of your +#: monitor. With a very high speed mouse/high keyboard repeat rate, +#: you may notice some slight input latency. If so, set this to no. + +#: }}} + +#: Terminal bell {{{ + +# enable_audio_bell yes + +#: The audio bell. Useful to disable it in environments that require +#: silence. + +# visual_bell_duration 0.0 + +#: The visual bell duration (in seconds). Flash the screen when a bell +#: occurs for the specified number of seconds. Set to zero to disable. +#: The flash is animated, fading in and out over the specified +#: duration. The easing function used for the fading can be +#: controlled. For example, 2.0 linear will casuse the flash to fade +#: in and out linearly. The default if unspecified is to use ease-in- +#: out which fades slowly at the start, middle and end. You can +#: specify different easing functions for the fade-in and fade-out +#: parts, like this: 2.0 ease-in linear. kitty supports all the CSS +#: easing functions . + +# visual_bell_color none + +#: The color used by visual bell. Set to none will fall back to +#: selection background color. If you feel that the visual bell is too +#: bright, you can set it to a darker color. + +# window_alert_on_bell yes + +#: Request window attention on bell. Makes the dock icon bounce on +#: macOS or the taskbar flash on Linux. + +# bell_on_tab "🔔 " + +#: Some text or a Unicode symbol to show on the tab if a window in the +#: tab that does not have focus has a bell. If you want to use leading +#: or trailing spaces, surround the text with quotes. See +#: tab_title_template for how this is rendered. + +#: For backwards compatibility, values of yes, y and true are +#: converted to the default bell symbol and no, n, false and none are +#: converted to the empty string. + +# command_on_bell none + +#: Program to run when a bell occurs. The environment variable +#: KITTY_CHILD_CMDLINE can be used to get the program running in the +#: window in which the bell occurred. + +# bell_path none + +#: Path to a sound file to play as the bell sound. If set to none, the +#: system default bell sound is used. Must be in a format supported by +#: the operating systems sound API, such as WAV or OGA on Linux +#: (libcanberra) or AIFF, MP3 or WAV on macOS (NSSound). + +# linux_bell_theme __custom + +#: The XDG Sound Theme kitty will use to play the bell sound. On +#: Wayland, when the compositor supports it, it is asked to play the +#: system default bell sound, and this setting has no effect. +#: Otherwise, defaults to the custom theme name specified in the XDG +#: Sound theme specification +#: , falling back to the default +#: freedesktop theme if it does not exist. To change your sound theme +#: desktop wide, create +#: :file:~/.local/share/sounds/__custom/index.theme` with the +#: contents: + +#: [Sound Theme] + +#: Inherits=name-of-the-sound-theme-you-want-to-use + +#: Replace name-of-the-sound-theme-you-want-to-use with the actual +#: theme name. Now all compliant applications should use sounds from +#: this theme. + +#: }}} + +#: Window layout {{{ + +# remember_window_size yes +# initial_window_width 640 +# initial_window_height 400 + +#: If enabled, the OS Window size will be remembered so that new +#: instances of kitty will have the same size as the previous +#: instance. If disabled, the OS Window will initially have size +#: configured by initial_window_width/height, in pixels. You can use a +#: suffix of "c" on the width/height values to have them interpreted +#: as number of cells instead of pixels. + +# remember_window_position no + +#: If enabled, the OS Window position will be remembered so that new +#: instances of kitty will have the same position as the previous +#: instance. If disabled, the OS Window will be placed by the window +#: manager. Note that remembering of position only works if the +#: underlying desktop environment/window manager supports it. It never +#: works on Wayland. See also kitty --position to specify the position +#: when launching kitty. + +# enabled_layouts * + +#: The enabled window layouts. A comma separated list of layout names. +#: The special value all means all layouts. The first listed layout +#: will be used as the startup layout. Default configuration is all +#: layouts in alphabetical order. For a list of available layouts, see +#: the layouts . + +# window_resize_step_cells 2 +# window_resize_step_lines 2 + +#: The step size (in units of cell width/cell height) to use when +#: resizing kitty windows in a layout with the shortcut +#: start_resizing_window. The cells value is used for horizontal +#: resizing, and the lines value is used for vertical resizing. + +# window_border_width 0.5pt + +#: The width of window borders. Can be either in pixels (px) or pts +#: (pt). Values in pts will be rounded to the nearest number of pixels +#: based on screen resolution. If not specified, the unit is assumed +#: to be pts. Note that borders are displayed only when more than one +#: window is visible. They are meant to separate multiple windows. + +# draw_minimal_borders yes + +#: Draw only the minimum borders needed. This means that only the +#: borders that separate the window from a neighbor are drawn. Note +#: that setting a non-zero window_margin_width overrides this and +#: causes all borders to be drawn. + +# window_margin_width 0 + +#: The window margin (in pts) (blank area outside the border). A +#: single value sets all four sides. Two values set the vertical and +#: horizontal sides. Three values set top, horizontal and bottom. Four +#: values set top, right, bottom and left. + +# single_window_margin_width -1 + +#: The window margin to use when only a single window is visible (in +#: pts). Negative values will cause the value of window_margin_width +#: to be used instead. A single value sets all four sides. Two values +#: set the vertical and horizontal sides. Three values set top, +#: horizontal and bottom. Four values set top, right, bottom and left. + +# window_padding_width 0 + +#: The window padding (in pts) (blank area between the text and the +#: window border). A single value sets all four sides. Two values set +#: the vertical and horizontal sides. Three values set top, horizontal +#: and bottom. Four values set top, right, bottom and left. + +# single_window_padding_width -1 + +#: The window padding to use when only a single window is visible (in +#: pts). Negative values will cause the value of window_padding_width +#: to be used instead. A single value sets all four sides. Two values +#: set the vertical and horizontal sides. Three values set top, +#: horizontal and bottom. Four values set top, right, bottom and left. + +# placement_strategy center + +#: When the window size is not an exact multiple of the cell size, the +#: cell area of the terminal window will have some extra padding on +#: the sides. You can control how that padding is distributed with +#: this option. Using a value of center means the cell area will be +#: placed centrally. A value of top-left means the padding will be +#: only at the bottom and right edges. The value can be one of: top- +#: left, top, top-right, left, center, right, bottom-left, bottom, +#: bottom-right. + +# active_border_color #00ff00 + +#: The color for the border of the active window. Set this to none to +#: not draw borders around the active window. + +# inactive_border_color #cccccc + +#: The color for the border of inactive windows. + +# bell_border_color #ff5a00 + +#: The color for the border of inactive windows in which a bell has +#: occurred. + +# inactive_text_alpha 1.0 + +#: Fade the text in inactive windows by the specified amount (a number +#: between zero and one, with zero being fully faded). + +hide_window_decorations yes + +#: Hide the window decorations (title-bar and window borders) with +#: yes. On macOS, titlebar-only and titlebar-and-corners can be used +#: to only hide the titlebar and the rounded corners. Whether this +#: works and exactly what effect it has depends on the window +#: manager/operating system. Note that the effects of changing this +#: option when reloading config are undefined. When using titlebar- +#: only, it is useful to also set window_margin_width and +#: placement_strategy to prevent the rounded corners from clipping +#: text. Or use titlebar-and-corners. + +# window_logo_path none + +#: Path to a logo image. Must be in PNG/JPEG/WEBP/GIF/TIFF/BMP format. +#: Relative paths are interpreted relative to the kitty config +#: directory. The logo is displayed in a corner of every kitty window. +#: The position is controlled by window_logo_position. Individual +#: windows can be configured to have different logos either using the +#: launch action or the remote control +#: facility. + +# window_logo_position bottom-right + +#: Where to position the window logo in the window. The value can be +#: one of: top-left, top, top-right, left, center, right, bottom-left, +#: bottom, bottom-right. + +# window_logo_alpha 0.5 + +#: The amount the logo should be faded into the background. With zero +#: being fully faded and one being fully opaque. + +# window_logo_scale 0 + +#: The percentage (0-100] of the window size to which the logo should +#: scale. Using a single number means the logo is scaled to that +#: percentage of the shortest window dimension, while preserving +#: aspect ratio of the logo image. + +#: Using two numbers means the width and height of the logo are scaled +#: to the respective percentage of the window's width and height. + +#: Using zero as the percentage disables scaling in that dimension. A +#: single zero (the default) disables all scaling of the window logo. + +# resize_debounce_time 0.1 0.5 + +#: The time to wait (in seconds) before asking the program running in +#: kitty to resize and redraw the screen during a live resize of the +#: OS window, when no new resize events have been received, i.e. when +#: resizing is either paused or finished. On platforms such as macOS, +#: where the operating system sends events corresponding to the start +#: and end of a live resize, the second number is used for redraw- +#: after-pause since kitty can distinguish between a pause and end of +#: resizing. On such systems the first number is ignored and redraw is +#: immediate after end of resize. On other systems only the first +#: number is used so that kitty is "ready" quickly after the end of +#: resizing, while not also continuously redrawing, to save energy. + +resize_in_steps no + +#: Resize the OS window in steps as large as the cells, instead of +#: with the usual pixel accuracy. Combined with initial_window_width +#: and initial_window_height in number of cells, this option can be +#: used to keep the margins as small as possible when resizing the OS +#: window. Note that this does not currently work on Wayland. + +# visual_window_select_characters 1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ + +#: The list of characters for visual window selection. For example, +#: for selecting a window to focus on with focus_visible_window. The +#: value should be a series of unique numbers or alphabets, case +#: insensitive, from the set 0-9A-Z\-=[];',./\\`. Specify your +#: preference as a string of characters. + +# confirm_os_window_close -1 + +#: Ask for confirmation when closing an OS window or a tab with at +#: least this number of kitty windows in it by window manager (e.g. +#: clicking the window close button or pressing the operating system +#: shortcut to close windows) or by the close_tab action. A value of +#: zero disables confirmation. This confirmation also applies to +#: requests to quit the entire application (all OS windows, via the +#: quit action). Negative values are converted to positive ones, +#: however, with shell_integration enabled, using negative values +#: means windows sitting at a shell prompt are not counted, only +#: windows where some command is currently running. You can also have +#: backgrounded jobs prevent closing, by adding count-background to +#: the setting, for example: -1 count-background. Note that if you +#: want confirmation when closing individual windows, you can map the +#: close_window_with_confirmation action. + +#: }}} + +#: Tab bar {{{ + +# tab_bar_edge bottom + +#: The edge to show the tab bar on, top or bottom. + +# tab_bar_margin_width 0.0 + +#: The margin to the left and right of the tab bar (in pts). + +# tab_bar_margin_height 0.0 0.0 + +#: The margin above and below the tab bar (in pts). The first number +#: is the margin between the edge of the OS Window and the tab bar. +#: The second number is the margin between the tab bar and the +#: contents of the current tab. + +# tab_bar_style fade + +#: The tab bar style, can be one of: + +#: fade +#: Each tab's edges fade into the background color. (See also tab_fade) +#: slant +#: Tabs look like the tabs in a physical file. +#: separator +#: Tabs are separated by a configurable separator. (See also +#: tab_separator) +#: powerline +#: Tabs are shown as a continuous line with "fancy" separators. +#: (See also tab_powerline_style) +#: custom +#: A user-supplied Python function called draw_tab is loaded from the file +#: tab_bar.py in the kitty config directory. For examples of how to +#: write such a function, see the functions named draw_tab_with_* in +#: kitty's source code: kitty/tab_bar.py. See also +#: this discussion +#: for examples from kitty users. +#: hidden +#: The tab bar is hidden. If you use this, you might want to create +#: a mapping for the select_tab action which presents you with a list of +#: tabs and allows for easy switching to a tab. + +# tab_bar_align left + +#: The horizontal alignment of the tab bar, can be one of: left, +#: center, right. + +# tab_bar_min_tabs 2 + +#: The minimum number of tabs that must exist before the tab bar is +#: shown. + +# tab_switch_strategy previous + +#: The algorithm to use when switching to a tab when the current tab +#: is closed. The default of previous will switch to the last used +#: tab. A value of left will switch to the tab to the left of the +#: closed tab. A value of right will switch to the tab to the right of +#: the closed tab. A value of last will switch to the right-most tab. + +# tab_fade 0.25 0.5 0.75 1 + +#: Control how each tab fades into the background when using fade for +#: the tab_bar_style. Each number is an alpha (between zero and one) +#: that controls how much the corresponding cell fades into the +#: background, with zero being no fade and one being full fade. You +#: can change the number of cells used by adding/removing entries to +#: this list. + +# tab_separator " ┇" + +#: The separator between tabs in the tab bar when using separator as +#: the tab_bar_style. + +# tab_powerline_style angled + +#: The powerline separator style between tabs in the tab bar when +#: using powerline as the tab_bar_style, can be one of: angled, +#: slanted, round. + +# tab_activity_symbol none + +#: Some text or a Unicode symbol to show on the tab if a window in the +#: tab that does not have focus has some activity. If you want to use +#: leading or trailing spaces, surround the text with quotes. See +#: tab_title_template for how this is rendered. + +# tab_title_max_length 0 + +#: The maximum number of cells that can be used to render the text in +#: a tab. A value of zero means that no limit is applied. + +# tab_title_template "{fmt.fg.red}{bell_symbol}{activity_symbol}{fmt.fg.tab}{tab.last_focused_progress_percent}{title}" + +#: A template to render the tab title. The default just renders the +#: title with optional symbols for bell and activity. If you wish to +#: include the tab-index as well, use something like: {index}:{title}. +#: Useful if you have shortcuts mapped for goto_tab N. If you prefer +#: to see the index as a superscript, use {sup.index}. All data +#: available is: + +#: title +#: The current tab title. +#: index +#: The tab index usable with goto_tab N goto_tab shortcuts. +#: layout_name +#: The current layout name. +#: num_windows +#: The number of windows in the tab. +#: num_window_groups +#: The number of window groups (a window group is a window and all of its overlay windows) in the tab. +#: tab.active_wd +#: The working directory of the currently active window in the tab +#: (expensive, requires syscall). Use tab.active_oldest_wd to get +#: the directory of the oldest foreground process rather than the newest. +#: tab.active_exe +#: The name of the executable running in the foreground of the currently +#: active window in the tab (expensive, requires syscall). Use +#: tab.active_oldest_exe for the oldest foreground process. +#: max_title_length +#: The maximum title length available. +#: keyboard_mode +#: The name of the current keyboard mode or the empty string if no keyboard mode is active. +#: tab.last_focused_progress_percent +#: If a command running in a window reports the progress for a task, show this progress as a percentage +#: from the most recently focused window in the tab. Empty string if no progress is reported. +#: tab.progress_percent +#: If a command running in a window reports the progress for a task, show this progress as a percentage +#: from all windows in the tab, averaged. Empty string is no progress is reported. + +#: Note that formatting is done by Python's string formatting +#: machinery, so you can use, for instance, {layout_name[:2].upper()} +#: to show only the first two letters of the layout name, upper-cased. +#: If you want to style the text, you can use styling directives, for +#: example: +#: `{fmt.fg.red}red{fmt.fg.tab}normal{fmt.bg._00FF00}greenbg{fmt.bg.tab}`. +#: Similarly, for bold and italic: +#: `{fmt.bold}bold{fmt.nobold}normal{fmt.italic}italic{fmt.noitalic}`. +#: The 256 eight terminal colors can be used as `fmt.fg.color0` +#: through `fmt.fg.color255`. Note that for backward compatibility, if +#: {bell_symbol} or {activity_symbol} are not present in the template, +#: they are prepended to it. + +# active_tab_title_template none + +#: Template to use for active tabs. If not specified falls back to +#: tab_title_template. + +# active_tab_foreground #000 +# active_tab_background #eee +# active_tab_font_style bold-italic +# inactive_tab_foreground #444 +# inactive_tab_background #999 +# inactive_tab_font_style normal + +#: Tab bar colors and styles. + +# tab_bar_background none + +#: Background color for the tab bar. Defaults to using the terminal +#: background color. + +# tab_bar_margin_color none + +#: Color for the tab bar margin area. Defaults to using the terminal +#: background color for margins above and below the tab bar. For side +#: margins the default color is chosen to match the background color +#: of the neighboring tab. + +#: }}} + +#: Color scheme {{{ + +# foreground #dddddd +# background #000000 + +#: The foreground and background colors. + +background_opacity 1 + +#: The opacity of the background. A number between zero and one, where +#: one is opaque and zero is fully transparent. This will only work if +#: supported by the OS (for instance, when using a compositor under +#: X11). Note that it only sets the background color's opacity in +#: cells that have the same background color as the default terminal +#: background, so that things like the status bar in vim, powerline +#: prompts, etc. still look good. But it means that if you use a color +#: theme with a background color in your editor, it will not be +#: rendered as transparent. Instead you should change the default +#: background color in your kitty config and not use a background +#: color in the editor color scheme. Or use the escape codes to set +#: the terminals default colors in a shell script to launch your +#: editor. See also transparent_background_colors. Be aware that using +#: a value less than 1.0 is a (possibly significant) performance hit. +#: When using a low value for this setting, it is desirable that you +#: set the background color to a color the matches the general color +#: of the desktop background, for best text rendering. Note that to +#: workaround window managers not doing gamma-corrected blending kitty +#: makes background_opacity non-linear which means, especially for +#: light backgrounds you might need to make the value much lower than +#: you expect to get good results, see 6218 +#: for details. + +#: If you want to dynamically change transparency of windows, set +#: dynamic_background_opacity to yes (this is off by default as it has +#: a performance cost). Changing this option when reloading the config +#: will only work if dynamic_background_opacity was enabled in the +#: original config. + +background_blur 50 + +#: Set to a positive value to enable background blur (blurring of the +#: visuals behind a transparent window) on platforms that support it. +#: Only takes effect when background_opacity is less than one. On +#: macOS, this will also control the blur radius (amount of blurring). +#: Setting it to too high a value will cause severe performance issues +#: and/or rendering artifacts. Usually, values up to 64 work well. +#: Note that this might cause performance issues, depending on how the +#: platform implements it, so use with care. Currently supported on +#: macOS and KDE. + +# transparent_background_colors + +#: A space separated list of upto 7 colors, with opacity. When the +#: background color of a cell matches one of these colors, it is +#: rendered semi-transparent using the specified opacity. + +#: Useful in more complex UIs like editors where you could want more +#: than a single background color to be rendered as transparent, for +#: instance, for a cursor highlight line background or a highlighted +#: block. Terminal applications can set this color using The kitty +#: color control escape code. + +#: The syntax for specifying colors is: color@opacity, where the +#: @opacity part is optional. When unspecified, the value of +#: background_opacity is used. For example:: + +#: transparent_background_colors red@0.5 #00ff00@0.3 + +# dynamic_background_opacity no + +#: Allow changing of the background_opacity dynamically, using either +#: keyboard shortcuts (increase_background_opacity and +#: decrease_background_opacity) or the remote control facility. +#: Changing this option by reloading the config is not supported. + +# background_image /home/cloverta/Pictures/WeChat/l/122415813_p0.png + +#: Path to a background image. Must be in PNG/JPEG/WEBP/TIFF/GIF/BMP +#: format. Note that when using auto_color_scheme +#: +#: this option is overridden by the color scheme file and must be set +#: inside it to take effect. + +# background_image_layout cscaled + +#: Whether to tile, scale or clamp the background image. The value can +#: be one of tiled, mirror-tiled, scaled, clamped, centered or +#: cscaled. The scaled and cscaled values scale the image to the +#: window size, with cscaled preserving the image aspect ratio. Note +#: that when using auto_color_scheme +#: +#: this option is overridden by the color scheme file and must be set +#: inside it to take effect. + +# background_image_linear no + +#: When background image is scaled, whether linear interpolation +#: should be used. Note that when using auto_color_scheme +#: +#: this option is overridden by the color scheme file and must be set +#: inside it to take effect. + +# background_tint 1 + +#: How much to tint the background image by the background color. This +#: option makes it easier to read the text. Tinting is done using the +#: current background color for each window. This option applies only +#: if background_opacity is set and transparent windows are supported +#: or background_image is set. Note that when using auto_color_scheme +#: +#: this option is overridden by the color scheme file and must be set +#: inside it to take effect. + +# background_tint_gaps 1.0 + +#: How much to tint the background image at the window gaps by the +#: background color, after applying background_tint. Since this is +#: multiplicative with background_tint, it can be used to lighten the +#: tint over the window gaps for a *separated* look. Note that when +#: using auto_color_scheme +#: +#: this option is overridden by the color scheme file and must be set +#: inside it to take effect. + +# dim_opacity 0.4 + +#: How much to dim text that has the DIM/FAINT attribute set. One +#: means no dimming and zero means fully dimmed (i.e. invisible). + +# selection_foreground #000000 +# selection_background #fffacd + +#: The foreground and background colors for text selected with the +#: mouse. Setting both of these to none will cause a "reverse video" +#: effect for selections, where the selection will be the cell text +#: color and the text will become the cell background color. Setting +#: only selection_foreground to none will cause the foreground color +#: to be used unchanged. Note that these colors can be overridden by +#: the program running in the terminal. + +#: The color table {{{ + +#: The 256 terminal colors. There are 8 basic colors, each color has a +#: dull and bright version, for the first 16 colors. You can set the +#: remaining 240 colors as color16 to color255. + +# color0 #000000 +# color8 #767676 + +#: black + +# color1 #cc0403 +# color9 #f2201f + +#: red + +# color2 #19cb00 +# color10 #23fd00 + +#: green + +# color3 #cecb00 +# color11 #fffd00 + +#: yellow + +# color4 #0d73cc +# color12 #1a8fff + +#: blue + +# color5 #cb1ed1 +# color13 #fd28ff + +#: magenta + +# color6 #0dcdcd +# color14 #14ffff + +#: cyan + +# color7 #dddddd +# color15 #ffffff + +#: white + +# mark1_foreground black + +#: Color for marks of type 1 + +# mark1_background #98d3cb + +#: Color for marks of type 1 (light steel blue) + +# mark2_foreground black + +#: Color for marks of type 2 + +# mark2_background #f2dcd3 + +#: Color for marks of type 1 (beige) + +# mark3_foreground black + +#: Color for marks of type 3 + +# mark3_background #f274bc + +#: Color for marks of type 3 (violet) + +#: }}} + +#: }}} + +#: Advanced {{{ + +# shell . + +#: The shell program to execute. The default value of . means to use +#: the value of of the SHELL environment variable or if unset, +#: whatever shell is set as the default shell for the current user. +#: Note that on macOS if you change this, you might need to add +#: --login and --interactive to ensure that the shell starts in +#: interactive mode and reads its startup rc files. Environment +#: variables are expanded in this setting. + +# editor . + +#: The terminal based text editor (such as vim or nano) to use when +#: editing the kitty config file or similar tasks. + +#: The default value of . means to use the environment variables +#: VISUAL and EDITOR in that order. If these variables aren't set, +#: kitty will run your shell ($SHELL -l -i -c env) to see if your +#: shell startup rc files set VISUAL or EDITOR. If that doesn't work, +#: kitty will cycle through various known editors (vim, emacs, etc.) +#: and take the first one that exists on your system. + +# close_on_child_death no + +#: Close the window when the child process (usually the shell) exits. +#: With the default value no, the terminal will remain open when the +#: child exits as long as there are still other processes outputting +#: to the terminal (for example disowned or backgrounded processes). +#: When enabled with yes, the window will close as soon as the child +#: process exits. Note that setting it to yes means that any +#: background processes still using the terminal can fail silently +#: because their stdout/stderr/stdin no longer work. + +# remote_control_password + +#: Allow other programs to control kitty using passwords. This option +#: can be specified multiple times to add multiple passwords. If no +#: passwords are present kitty will ask the user for permission if a +#: program tries to use remote control with a password. A password can +#: also *optionally* be associated with a set of allowed remote +#: control actions. For example:: + +#: remote_control_password "my passphrase" get-colors set-colors focus-window focus-tab + +#: Only the specified actions will be allowed when using this +#: password. Glob patterns can be used too, for example:: + +#: remote_control_password "my passphrase" set-tab-* resize-* + +#: To get a list of available actions, run:: + +#: kitten @ --help + +#: A set of actions to be allowed when no password is sent can be +#: specified by using an empty password. For example:: + +#: remote_control_password "" *-colors + +#: Finally, the path to a python module can be specified that provides +#: a function is_cmd_allowed that is used to check every remote +#: control command. For example:: + +#: remote_control_password "my passphrase" my_rc_command_checker.py + +#: Relative paths are resolved from the kitty configuration directory. +#: See rc_custom_auth for details. + +allow_remote_control no + +#: Allow other programs to control kitty. If you turn this on, other +#: programs can control all aspects of kitty, including sending text +#: to kitty windows, opening new windows, closing windows, reading the +#: content of windows, etc. Note that this even works over SSH +#: connections. The default setting of no prevents any form of remote +#: control. The meaning of the various values are: + +#: password +#: Remote control requests received over both the TTY device and the socket +#: are confirmed based on passwords, see remote_control_password. + +#: socket-only +#: Remote control requests received over a socket are accepted +#: unconditionally. Requests received over the TTY are denied. +#: See listen_on. + +#: socket +#: Remote control requests received over a socket are accepted +#: unconditionally. Requests received over the TTY are confirmed based on +#: password. + +#: no +#: Remote control is completely disabled. + +#: yes +#: Remote control requests are always accepted. + +# listen_on none + +#: Listen to the specified socket for remote control connections. Note +#: that this will apply to all kitty instances. It can be overridden +#: by the kitty --listen-on command line option. For UNIX sockets, +#: such as unix:${TEMP}/mykitty or unix:@mykitty (on Linux). +#: Environment variables are expanded and relative paths are resolved +#: with respect to the temporary directory. If {kitty_pid} is present, +#: then it is replaced by the PID of the kitty process, otherwise the +#: PID of the kitty process is appended to the value, with a hyphen. +#: For TCP sockets such as tcp:localhost:0 a random port is always +#: used even if a non-zero port number is specified. See the help for +#: kitty --listen-on for more details. Note that this will be ignored +#: unless allow_remote_control is set to either: yes, socket or +#: socket-only. Changing this option by reloading the config is not +#: supported. + +# env + +#: Specify the environment variables to be set in all child processes. +#: Using the name with an equal sign (e.g. env VAR=) will set it to +#: the empty string. Specifying only the name (e.g. env VAR) will +#: remove the variable from the child process' environment. Note that +#: environment variables are expanded recursively, for example:: + +#: env VAR1=a +#: env VAR2=${HOME}/${VAR1}/b + +#: The value of VAR2 will be /a/b. + +# filter_notification + +#: Specify rules to filter out notifications sent by applications +#: running in kitty. Can be specified multiple times to create +#: multiple filter rules. A rule specification is of the form +#: field:regexp. A filter rule can match on any of the fields: title, +#: body, app, type. The special value of all filters out all +#: notifications. Rules can be combined using Boolean operators. Some +#: examples:: + +#: filter_notification title:hello or body:"abc.*def" +#: # filter out notification from vim except for ones about updates, (?i) +#: # makes matching case insensitive. +#: filter_notification app:"[ng]?vim" and not body:"(?i)update" +#: # filter out all notifications +#: filter_notification all + +#: The field app is the name of the application sending the +#: notification and type is the type of the notification. Not all +#: applications will send these fields, so you can also match on the +#: title and body of the notification text. More sophisticated +#: programmatic filtering and custom actions on notifications can be +#: done by creating a notifications.py file in the kitty config +#: directory (~/.config/kitty). An annotated sample is available +#: . + +# watcher + +#: Path to python file which will be loaded for watchers +#: . Can be +#: specified more than once to load multiple watchers. The watchers +#: will be added to every kitty window. Relative paths are resolved +#: relative to the kitty config directory. Note that reloading the +#: config will only affect windows created after the reload. + +# exe_search_path + +#: Control where kitty finds the programs to run. The default search +#: order is: First search the system wide PATH, then ~/.local/bin and +#: ~/bin. If still not found, the PATH defined in the login shell +#: after sourcing all its startup files is tried. Finally, if present, +#: the PATH specified by the env option is tried. + +#: This option allows you to prepend, append, or remove paths from +#: this search order. It can be specified multiple times for multiple +#: paths. A simple path will be prepended to the search order. A path +#: that starts with the + sign will be append to the search order, +#: after ~/bin above. A path that starts with the - sign will be +#: removed from the entire search order. For example:: + +#: exe_search_path /some/prepended/path +#: exe_search_path +/some/appended/path +#: exe_search_path -/some/excluded/path + +# update_check_interval 24 + +#: The interval to periodically check if an update to kitty is +#: available (in hours). If an update is found, a system notification +#: is displayed informing you of the available update. The default is +#: to check every 24 hours, set to zero to disable. Update checking is +#: only done by the official binary builds. Distro packages or source +#: builds do not do update checking. Changing this option by reloading +#: the config is not supported. + +# startup_session none + +#: Path to a session file to use for all kitty instances. Can be +#: overridden by using the kitty --session =none command line option +#: for individual instances. See sessions +#: in the kitty +#: documentation for details. Note that relative paths are interpreted +#: with respect to the kitty config directory. Environment variables +#: in the path are expanded. Changing this option by reloading the +#: config is not supported. Note that if kitty is invoked with command +#: line arguments specifying a command to run, this option is ignored. + +# clipboard_control write-clipboard write-primary read-clipboard-ask read-primary-ask + +#: Allow programs running in kitty to read and write from the +#: clipboard. You can control exactly which actions are allowed. The +#: possible actions are: write-clipboard, read-clipboard, write- +#: primary, read-primary, read-clipboard-ask, read-primary-ask. The +#: default is to allow writing to the clipboard and primary selection +#: and to ask for permission when a program tries to read from the +#: clipboard. Note that disabling the read confirmation is a security +#: risk as it means that any program, even the ones running on a +#: remote server via SSH can read your clipboard. See also +#: clipboard_max_size. + +# clipboard_max_size 512 + +#: The maximum size (in MB) of data from programs running in kitty +#: that will be stored for writing to the system clipboard. A value of +#: zero means no size limit is applied. See also clipboard_control. + +# file_transfer_confirmation_bypass + +#: The password that can be supplied to the file transfer kitten +#: to skip the +#: transfer confirmation prompt. This should only be used when +#: initiating transfers from trusted computers, over trusted networks +#: or encrypted transports, as it allows any programs running on the +#: remote machine to read/write to the local filesystem, without +#: permission. + +# allow_hyperlinks yes + +#: Process hyperlink escape sequences (OSC 8). If disabled OSC 8 +#: escape sequences are ignored. Otherwise they become clickable +#: links, that you can click with the mouse or by using the hints +#: kitten . The +#: special value of ask means that kitty will ask before opening the +#: link when clicked. + +# shell_integration enabled + +#: Enable shell integration on supported shells. This enables features +#: such as jumping to previous prompts, browsing the output of the +#: previous command in a pager, etc. on supported shells. Set to +#: disabled to turn off shell integration, completely. It is also +#: possible to disable individual features, set to a space separated +#: list of these values: no-rc, no-cursor, no-title, no-cwd, no- +#: prompt-mark, no-complete, no-sudo. See Shell integration +#: for details. + +# allow_cloning ask + +#: Control whether programs running in the terminal can request new +#: windows to be created. The canonical example is clone-in-kitty +#: . +#: By default, kitty will ask for permission for each clone request. +#: Allowing cloning unconditionally gives programs running in the +#: terminal (including over SSH) permission to execute arbitrary code, +#: as the user who is running the terminal, on the computer that the +#: terminal is running on. + +# clone_source_strategies venv,conda,env_var,path + +#: Control what shell code is sourced when running clone-in-kitty in +#: the newly cloned window. The supported strategies are: + +#: venv +#: Source the file $VIRTUAL_ENV/bin/activate. This is used by the +#: Python stdlib venv module and allows cloning venvs automatically. +#: conda +#: Run conda activate $CONDA_DEFAULT_ENV. This supports the virtual +#: environments created by conda. +#: env_var +#: Execute the contents of the environment variable +#: KITTY_CLONE_SOURCE_CODE with eval. +#: path +#: Source the file pointed to by the environment variable +#: KITTY_CLONE_SOURCE_PATH. + +#: This option must be a comma separated list of the above values. +#: Only the first valid match, in the order specified, is sourced. + +# notify_on_cmd_finish never + +#: Show a desktop notification when a long-running command finishes +#: (needs shell_integration). The possible values are: + +#: never +#: Never send a notification. + +#: unfocused +#: Only send a notification when the window does not have keyboard focus. + +#: invisible +#: Only send a notification when the window both is unfocused and not visible +#: to the user, for example, because it is in an inactive tab or its OS window +#: is not currently visible (on platforms that support OS window visibility querying +#: this considers an OS Window visible iff it is active). + +#: always +#: Always send a notification, regardless of window state. + +#: There are two optional arguments: + +#: First, the minimum duration for what is considered a long running +#: command. The default is 5 seconds. Specify a second argument to set +#: the duration. For example: invisible 15. Do not set the value too +#: small, otherwise a command that launches a new OS Window and exits +#: will spam a notification. + +#: Second, the action to perform. The default is notify. The possible +#: values are: + +#: notify +#: Send a desktop notification. The subsequent arguments are optional and specify when +#: the notification is automatically cleared. The set of possible events when the notification is +#: cleared are: focus and next. focus means that when the notification +#: policy is unfocused or invisible the notification is automatically cleared +#: when the window regains focus. The value of next means that the previous notification +#: is cleared when the next notification is shown. The default when no arguments are specified +#: is: focus next. + +#: bell +#: Ring the terminal bell. + +#: command +#: Run a custom command. All subsequent arguments are the cmdline to run. + +#: Some more examples:: + +#: # Send a notification when a command takes more than 5 seconds in an unfocused window +#: notify_on_cmd_finish unfocused +#: # Send a notification when a command takes more than 10 seconds in a invisible window +#: notify_on_cmd_finish invisible 10.0 +#: # Ring a bell when a command takes more than 10 seconds in a invisible window +#: notify_on_cmd_finish invisible 10.0 bell +#: # Run 'notify-send' when a command takes more than 10 seconds in a invisible window +#: # Here %c is replaced by the current command line and %s by the job exit code +#: notify_on_cmd_finish invisible 10.0 command notify-send "job finished with status: %s" %c +#: # Do not clear previous notification when next command finishes or window regains focus +#: notify_on_cmd_finish invisible 5.0 notify + +# term xterm-kitty + +#: The value of the TERM environment variable to set. Changing this +#: can break many terminal programs, only change it if you know what +#: you are doing, not because you read some advice on "Stack Overflow" +#: to change it. The TERM variable is used by various programs to get +#: information about the capabilities and behavior of the terminal. If +#: you change it, depending on what programs you run, and how +#: different the terminal you are changing it to is, various things +#: from key-presses, to colors, to various advanced features may not +#: work. Changing this option by reloading the config will only affect +#: newly created windows. + +# terminfo_type path + +#: The value of the TERMINFO environment variable to set. This +#: variable is used by programs running in the terminal to search for +#: terminfo databases. The default value of path causes kitty to set +#: it to a filesystem location containing the kitty terminfo database. +#: A value of direct means put the entire database into the env var +#: directly. This can be useful when connecting to containers, for +#: example. But, note that not all software supports this. A value of +#: none means do not touch the variable. + +# forward_stdio no + +#: Forward STDOUT and STDERR of the kitty process to child processes. +#: This is useful for debugging as it allows child processes to print +#: to kitty's STDOUT directly. For example, echo hello world +#: >&$KITTY_STDIO_FORWARDED in a shell will print to the parent +#: kitty's STDOUT. Sets the KITTY_STDIO_FORWARDED=fdnum environment +#: variable so child processes know about the forwarding. Note that on +#: macOS this prevents the shell from being run via the login utility +#: so getlogin() will not work in programs run in this session. + +# menu_map + +#: Specify entries for various menus in kitty. Currently only the +#: global menubar on macOS is supported. For example:: + +#: menu_map global "Actions::Launch something special" launch --hold --type=os-window sh -c "echo hello world" + +#: This will create a menu entry named "Launch something special" in +#: an "Actions" menu in the macOS global menubar. Sub-menus can be +#: created by adding more levels separated by the :: characters. + +#: }}} + +#: OS specific tweaks {{{ + +# wayland_titlebar_color system + +#: The color of the kitty window's titlebar on Wayland systems with +#: client side window decorations such as GNOME. A value of system +#: means to use the default system colors, a value of background means +#: to use the background color of the currently active kitty window +#: and finally you can use an arbitrary color, such as #12af59 or red. + +macos_titlebar_color dark + +#: The color of the kitty window's titlebar on macOS. A value of +#: system means to use the default system color, light or dark can +#: also be used to set it explicitly. A value of background means to +#: use the background color of the currently active window and finally +#: you can use an arbitrary color, such as #12af59 or red. WARNING: +#: This option works by using a hack when arbitrary color (or +#: background) is configured, as there is no proper Cocoa API for it. +#: It sets the background color of the entire window and makes the +#: titlebar transparent. As such it is incompatible with +#: background_opacity. If you want to use both, you are probably +#: better off just hiding the titlebar with hide_window_decorations. + +# macos_option_as_alt no + +#: Use the Option key as an Alt key on macOS. With this set to no, +#: kitty will use the macOS native Option+Key to enter Unicode +#: character behavior. This will break any Alt+Key keyboard shortcuts +#: in your terminal programs, but you can use the macOS Unicode input +#: technique. You can use the values: left, right or both to use only +#: the left, right or both Option keys as Alt, instead. Note that +#: kitty itself always treats Option the same as Alt. This means you +#: cannot use this option to configure different kitty shortcuts for +#: Option+Key vs. Alt+Key. Also, any kitty shortcuts using +#: Option/Alt+Key will take priority, so that any such key presses +#: will not be passed to terminal programs running inside kitty. +#: Changing this option by reloading the config is not supported. + +# macos_hide_from_tasks no + +#: Hide the kitty window from running tasks on macOS (⌘+Tab and the +#: Dock). Changing this option by reloading the config is not +#: supported. + +# macos_quit_when_last_window_closed no + +#: Have kitty quit when all the top-level windows are closed on macOS. +#: By default, kitty will stay running, even with no open windows, as +#: is the expected behavior on macOS. + +# macos_window_resizable yes + +#: Disable this if you want kitty top-level OS windows to not be +#: resizable on macOS. + +# macos_thicken_font 0 + +#: Draw an extra border around the font with the given width, to +#: increase legibility at small font sizes on macOS. For example, a +#: value of 0.75 will result in rendering that looks similar to sub- +#: pixel antialiasing at common font sizes. Note that in modern kitty, +#: this option is obsolete (although still supported). Consider using +#: text_composition_strategy instead. + +macos_traditional_fullscreen no + +#: Use the macOS traditional full-screen transition, that is faster, +#: but less pretty. + +# macos_show_window_title_in all + +#: Control where the window title is displayed on macOS. A value of +#: window will show the title of the currently active window at the +#: top of the macOS window. A value of menubar will show the title of +#: the currently active window in the macOS global menu bar, making +#: use of otherwise wasted space. A value of all will show the title +#: in both places, and none hides the title. See +#: macos_menubar_title_max_length for how to control the length of the +#: title in the menu bar. + +# macos_menubar_title_max_length 0 + +#: The maximum number of characters from the window title to show in +#: the macOS global menu bar. Values less than one means that there is +#: no maximum limit. + +macos_custom_beam_cursor no + +#: Use a custom mouse cursor for macOS that is easier to see on both +#: light and dark backgrounds. Nowadays, the default macOS cursor +#: already comes with a white border. WARNING: this might make your +#: mouse cursor invisible on dual GPU machines. Changing this option +#: by reloading the config is not supported. + +# macos_colorspace srgb + +#: The colorspace in which to interpret terminal colors. The default +#: of srgb will cause colors to match those seen in web browsers. The +#: value of default will use whatever the native colorspace of the +#: display is. The value of displayp3 will use Apple's special +#: snowflake display P3 color space, which will result in over +#: saturated (brighter) colors with some color shift. Reloading +#: configuration will change this value only for newly created OS +#: windows. + +# linux_display_server auto + +#: Choose between Wayland and X11 backends. By default, an appropriate +#: backend based on the system state is chosen automatically. Set it +#: to x11 or wayland to force the choice. Changing this option by +#: reloading the config is not supported. + +# wayland_enable_ime yes + +#: Enable Input Method Extension on Wayland. This is typically used +#: for inputting text in East Asian languages. However, its +#: implementation in Wayland is often buggy and introduces latency +#: into the input loop, so disable this if you know you dont need it. +#: Changing this option by reloading the config is not supported, it +#: will not have any effect. + +#: }}} + +#: Keyboard shortcuts {{{ + +#: Keys are identified simply by their lowercase Unicode characters. +#: For example: a for the A key, [ for the left square bracket key, +#: etc. For functional keys, such as Enter or Escape, the names are +#: present at Functional key definitions +#: . +#: For modifier keys, the names are ctrl (control, ⌃), shift (⇧), alt +#: (opt, option, ⌥), super (cmd, command, ⌘). + +#: Simple shortcut mapping is done with the map directive. For full +#: details on advanced mapping including modal and per application +#: maps, see mapping . Some +#: quick examples to illustrate common tasks:: +map ctrl+' launch --location=hsplit +map ctrl+/ launch --location=vsplit +map ctrl+w close_window +map ctrl+left neighboring_window left +map ctrl+right neighboring_window right +map shift+left move_window right +map ctrl+down neighboring_window down +map ctrl+up neighboring_window up +map shift+down move_window up +#: # unmap a keyboard shortcut, passing it to the program running in kitty +#: map kitty_mod+space +#: # completely ignore a keyboard event +#: map ctrl+alt+f1 discard_event +#: # combine multiple actions +#: map kitty_mod+e combine : new_window : next_layout +#: # multi-key shortcuts +#: map ctrl+x>ctrl+y>z action + +#: The full list of actions that can be mapped to key presses is +#: available here . + +# kitty_mod ctrl+shift + +#: Special modifier key alias for default shortcuts. You can change +#: the value of this option to alter all default shortcuts that use +#: kitty_mod. + +# clear_all_shortcuts no + +#: Remove all shortcut definitions up to this point. Useful, for +#: instance, to remove the default shortcuts. + +# action_alias + +#: E.g. action_alias launch_tab launch --type=tab --cwd=current + +#: Define action aliases to avoid repeating the same options in +#: multiple mappings. Aliases can be defined for any action and will +#: be expanded recursively. For example, the above alias allows you to +#: create mappings to launch a new tab in the current working +#: directory without duplication:: + +#: map f1 launch_tab vim +#: map f2 launch_tab emacs + +#: Similarly, to alias kitten invocation:: + +#: action_alias hints kitten hints --hints-offset=0 + +# kitten_alias + +#: E.g. kitten_alias hints hints --hints-offset=0 + +#: Like action_alias above, but specifically for kittens. Generally, +#: prefer to use action_alias. This option is a legacy version, +#: present for backwards compatibility. It causes all invocations of +#: the aliased kitten to be substituted. So the example above will +#: cause all invocations of the hints kitten to have the --hints- +#: offset=0 option applied. + +#: Clipboard {{{ + +#: Copy to clipboard + +# map kitty_mod+c copy_to_clipboard +# map cmd+c copy_to_clipboard + +#:: There is also a copy_or_interrupt action that can be optionally +#:: mapped to Ctrl+C. It will copy only if there is a selection and +#:: send an interrupt otherwise. Similarly, +#:: copy_and_clear_or_interrupt will copy and clear the selection or +#:: send an interrupt if there is no selection. + +#: Paste from clipboard + +# map kitty_mod+v paste_from_clipboard +# map cmd+v paste_from_clipboard + +#: Paste from selection + +# map kitty_mod+s paste_from_selection +# map shift+insert paste_from_selection + +#: Pass selection to program + +# map kitty_mod+o pass_selection_to_program + +#:: You can also pass the contents of the current selection to any +#:: program with pass_selection_to_program. By default, the system's +#:: open program is used, but you can specify your own, the selection +#:: will be passed as a command line argument to the program. For +#:: example:: + +#:: map kitty_mod+o pass_selection_to_program firefox + +#:: You can pass the current selection to a terminal program running +#:: in a new kitty window, by using the @selection placeholder:: + +#:: map kitty_mod+y new_window less @selection + +#: }}} + +#: Scrolling {{{ + +#: Scroll line up + +# map kitty_mod+up scroll_line_up +# map kitty_mod+k scroll_line_up +# map opt+cmd+page_up scroll_line_up +# map cmd+up scroll_line_up + +#: Scroll line down + +# map kitty_mod+down scroll_line_down +# map kitty_mod+j scroll_line_down +# map opt+cmd+page_down scroll_line_down +# map cmd+down scroll_line_down + +#: Scroll page up + +# map kitty_mod+page_up scroll_page_up +# map cmd+page_up scroll_page_up + +#: Scroll page down + +# map kitty_mod+page_down scroll_page_down +# map cmd+page_down scroll_page_down + +#: Scroll to top + +# map kitty_mod+home scroll_home +# map cmd+home scroll_home + +#: Scroll to bottom + +# map kitty_mod+end scroll_end +# map cmd+end scroll_end + +#: Scroll to previous shell prompt + +# map kitty_mod+z scroll_to_prompt -1 + +#:: Use a parameter of 0 for scroll_to_prompt to scroll to the last +#:: jumped to or the last clicked position. Requires shell +#:: integration +#:: to work. + +#: Scroll to next shell prompt + +# map kitty_mod+x scroll_to_prompt 1 + +#: Browse scrollback buffer in pager + +# map kitty_mod+h show_scrollback + +#:: You can pipe the contents of the current screen and history +#:: buffer as STDIN to an arbitrary program using launch --stdin- +#:: source. For example, the following opens the scrollback buffer in +#:: less in an overlay window:: + +#:: map f1 launch --stdin-source=@screen_scrollback --stdin-add-formatting --type=overlay less +G -R + +#:: For more details on piping screen and buffer contents to external +#:: programs, see launch . + +#: Browse output of the last shell command in pager + +# map kitty_mod+g show_last_command_output + +#:: You can also define additional shortcuts to get the command +#:: output. For example, to get the first command output on screen:: + +#:: map f1 show_first_command_output_on_screen + +#:: To get the command output that was last accessed by a keyboard +#:: action or mouse action:: + +#:: map f1 show_last_visited_command_output + +#:: You can pipe the output of the last command run in the shell +#:: using the launch action. For example, the following opens the +#:: output in less in an overlay window:: + +#:: map f1 launch --stdin-source=@last_cmd_output --stdin-add-formatting --type=overlay less +G -R + +#:: To get the output of the first command on the screen, use +#:: @first_cmd_output_on_screen. To get the output of the last jumped +#:: to command, use @last_visited_cmd_output. + +#:: Requires shell integration +#:: to work. + +#: }}} + +#: Window management {{{ + +#: New window + +# map kitty_mod+enter new_window +# map cmd+enter new_window + +#:: You can open a new kitty window running an arbitrary program, for +#:: example:: + +#:: map kitty_mod+y launch mutt + +#:: You can open a new window with the current working directory set +#:: to the working directory of the current window using:: + +#:: map ctrl+alt+enter launch --cwd=current + +#:: You can open a new window that is allowed to control kitty via +#:: the kitty remote control facility with launch --allow-remote- +#:: control. Any programs running in that window will be allowed to +#:: control kitty. For example:: + +#:: map ctrl+enter launch --allow-remote-control some_program + +#:: You can open a new window next to the currently active window or +#:: as the first window, with:: + +#:: map ctrl+n launch --location=neighbor +#:: map ctrl+f launch --location=first + +#:: For more details, see launch +#:: . + +#: New OS window + +# map kitty_mod+n new_os_window +# map cmd+n new_os_window + +#:: Works like new_window above, except that it opens a top-level OS +#:: window. In particular you can use new_os_window_with_cwd to open +#:: a window with the current working directory. + +#: Close window + +# map kitty_mod+w close_window +# map shift+cmd+d close_window + +#: Next window + +# map kitty_mod+] next_window + +#: Previous window + +# map kitty_mod+[ previous_window + +#: Move window forward + +# map kitty_mod+f move_window_forward + +#: Move window backward + +# map kitty_mod+b move_window_backward + +#: Move window to top + +# map kitty_mod+` move_window_to_top + +#: Start resizing window + +# map kitty_mod+r start_resizing_window +# map cmd+r start_resizing_window + +#: First window + +# map kitty_mod+1 first_window +# map cmd+1 first_window + +#: Second window + +# map kitty_mod+2 second_window +# map cmd+2 second_window + +#: Third window + +# map kitty_mod+3 third_window +# map cmd+3 third_window + +#: Fourth window + +# map kitty_mod+4 fourth_window +# map cmd+4 fourth_window + +#: Fifth window + +# map kitty_mod+5 fifth_window +# map cmd+5 fifth_window + +#: Sixth window + +# map kitty_mod+6 sixth_window +# map cmd+6 sixth_window + +#: Seventh window + +# map kitty_mod+7 seventh_window +# map cmd+7 seventh_window + +#: Eighth window + +# map kitty_mod+8 eighth_window +# map cmd+8 eighth_window + +#: Ninth window + +# map kitty_mod+9 ninth_window +# map cmd+9 ninth_window + +#: Tenth window + +# map kitty_mod+0 tenth_window + +#: Visually select and focus window + +# map kitty_mod+f7 focus_visible_window + +#:: Display overlay numbers and alphabets on the window, and switch +#:: the focus to the window when you press the key. When there are +#:: only two windows, the focus will be switched directly without +#:: displaying the overlay. You can change the overlay characters and +#:: their order with option visual_window_select_characters. + +#: Visually swap window with another + +# map kitty_mod+f8 swap_with_window + +#:: Works like focus_visible_window above, but swaps the window. + +#: }}} + +#: Tab management {{{ + +#: Next tab + +# map kitty_mod+right next_tab +# map shift+cmd+] next_tab +# map ctrl+tab next_tab + +#: Previous tab + +# map kitty_mod+left previous_tab +# map shift+cmd+[ previous_tab +# map ctrl+shift+tab previous_tab + +#: New tab + +# map kitty_mod+t new_tab +# map cmd+t new_tab + +#: Close tab + +# map kitty_mod+q close_tab +# map cmd+w close_tab + +#: Close OS window + +# map shift+cmd+w close_os_window + +#: Move tab forward + +# map kitty_mod+. move_tab_forward + +#: Move tab backward + +# map kitty_mod+, move_tab_backward + +#: Set tab title + +# map kitty_mod+alt+t set_tab_title +# map shift+cmd+i set_tab_title + + +#: You can also create shortcuts to go to specific tabs, with 1 being +#: the first tab, 2 the second tab and -1 being the previously active +#: tab, -2 being the tab active before the previously active tab and +#: so on. Any number larger than the number of tabs goes to the last +#: tab and any number less than the number of previously used tabs in +#: the history goes to the oldest previously used tab in the history:: + +#: map ctrl+alt+1 goto_tab 1 +#: map ctrl+alt+2 goto_tab 2 + +#: Just as with new_window above, you can also pass the name of +#: arbitrary commands to run when using new_tab and new_tab_with_cwd. +#: Finally, if you want the new tab to open next to the current tab +#: rather than at the end of the tabs list, use:: + +#: map ctrl+t new_tab !neighbor [optional cmd to run] +#: }}} + +#: Layout management {{{ + +#: Next layout + +# map kitty_mod+l next_layout + + +#: You can also create shortcuts to switch to specific layouts:: + +#: map ctrl+alt+t goto_layout tall +#: map ctrl+alt+s goto_layout stack + +#: Similarly, to switch back to the previous layout:: + +#: map ctrl+alt+p last_used_layout + +#: There is also a toggle_layout action that switches to the named +#: layout or back to the previous layout if in the named layout. +#: Useful to temporarily "zoom" the active window by switching to the +#: stack layout:: + +#: map ctrl+alt+z toggle_layout stack +#: }}} + +#: Font sizes {{{ + +#: You can change the font size for all top-level kitty OS windows at +#: a time or only the current one. + +#: Increase font size + +# map kitty_mod+equal change_font_size all +2.0 +# map kitty_mod+plus change_font_size all +2.0 +# map kitty_mod+kp_add change_font_size all +2.0 +map cmd+plus change_font_size all +2.0 +map cmd+equal change_font_size all +2.0 +# map shift+cmd+equal change_font_size all +2.0 + +#: Decrease font size + +# map kitty_mod+minus change_font_size all -2.0 +# map kitty_mod+kp_subtract change_font_size all -2.0 +map cmd+minus change_font_size all -2.0 +# map shift+cmd+minus change_font_size all -2.0 + +#: Reset font size + +# map kitty_mod+backspace change_font_size all 0 +map cmd+0 change_font_size all 0 + + +#: To setup shortcuts for specific font sizes:: + +#: map kitty_mod+f6 change_font_size all 10.0 + +#: To setup shortcuts to change only the current OS window's font +#: size:: + +#: map kitty_mod+f6 change_font_size current 10.0 + +#: To setup shortcuts to multiply/divide the font size:: + +#: map kitty_mod+f6 change_font_size all *2.0 +#: map kitty_mod+f6 change_font_size all /2.0 +#: }}} + +#: Select and act on visible text {{{ + +#: Use the hints kitten to select text and either pass it to an +#: external program or insert it into the terminal or copy it to the +#: clipboard. + +#: Open URL + +# map kitty_mod+e open_url_with_hints + +#:: Open a currently visible URL using the keyboard. The program used +#:: to open the URL is specified in open_url_with. + +#: Insert selected path + +# map kitty_mod+p>f kitten hints --type path --program - + +#:: Select a path/filename and insert it into the terminal. Useful, +#:: for instance to run git commands on a filename output from a +#:: previous git command. + +#: Open selected path + +# map kitty_mod+p>shift+f kitten hints --type path + +#:: Select a path/filename and open it with the default open program. + +#: Insert selected line + +# map kitty_mod+p>l kitten hints --type line --program - + +#:: Select a line of text and insert it into the terminal. Useful for +#:: the output of things like: `ls -1`. + +#: Insert selected word + +# map kitty_mod+p>w kitten hints --type word --program - + +#:: Select words and insert into terminal. + +#: Insert selected hash + +# map kitty_mod+p>h kitten hints --type hash --program - + +#:: Select something that looks like a hash and insert it into the +#:: terminal. Useful with git, which uses SHA1 hashes to identify +#:: commits. + +#: Open the selected file at the selected line + +# map kitty_mod+p>n kitten hints --type linenum + +#:: Select something that looks like filename:linenum and open it in +#:: your default editor at the specified line number. + +#: Open the selected hyperlink + +# map kitty_mod+p>y kitten hints --type hyperlink + +#:: Select a hyperlink (i.e. a URL that has been marked as such by +#:: the terminal program, for example, by `ls --hyperlink=auto`). + + +#: The hints kitten has many more modes of operation that you can map +#: to different shortcuts. For a full description see hints kitten +#: . +#: }}} + +#: Miscellaneous {{{ + +#: Show documentation + +# map kitty_mod+f1 show_kitty_doc overview + +#: Toggle fullscreen + +# map kitty_mod+f11 toggle_fullscreen +# map ctrl+cmd+f toggle_fullscreen + +#: Toggle maximized + +# map kitty_mod+f10 toggle_maximized + +#: Toggle macOS secure keyboard entry + +# map opt+cmd+s toggle_macos_secure_keyboard_entry + +#: Unicode input + +# map kitty_mod+u kitten unicode_input +# map ctrl+cmd+space kitten unicode_input + +#: Edit config file + +# map kitty_mod+f2 edit_config_file +# map cmd+, edit_config_file + +#: Open the kitty command shell + +# map kitty_mod+escape kitty_shell window + +#:: Open the kitty shell in a new window / tab / overlay / os_window +#:: to control kitty using commands. + +#: Increase background opacity + +# map kitty_mod+a>m set_background_opacity +0.1 + +#: Decrease background opacity + +# map kitty_mod+a>l set_background_opacity -0.1 + +#: Make background fully opaque + +# map kitty_mod+a>1 set_background_opacity 1 + +#: Reset background opacity + +# map kitty_mod+a>d set_background_opacity default + +#: Reset the terminal + +# map kitty_mod+delete clear_terminal reset active +# map opt+cmd+r clear_terminal reset active + +#:: You can create shortcuts to clear/reset the terminal. For +#:: example:: + +#:: # Reset the terminal +#:: map f1 clear_terminal reset active +#:: # Clear the terminal screen by erasing all contents +#:: map f1 clear_terminal clear active +#:: # Clear the terminal scrollback by erasing it +#:: map f1 clear_terminal scrollback active +#:: # Scroll the contents of the screen into the scrollback +#:: map f1 clear_terminal scroll active +#:: # Clear everything on screen up to the line with the cursor or the start of the current prompt (needs shell integration) +#:: map f1 clear_terminal to_cursor active +#:: # Same as above except cleared lines are moved into scrollback +#:: map f1 clear_terminal to_cursor_scroll active + +#:: If you want to operate on all kitty windows instead of just the +#:: current one, use all instead of active. + +#:: Some useful functions that can be defined in the shell rc files +#:: to perform various kinds of clearing of the current window: + +#:: .. code-block:: sh + +#:: clear-only-screen() { +#:: printf "\e[H\e[2J" +#:: } + +#:: clear-screen-and-scrollback() { +#:: printf "\e[H\e[3J" +#:: } + +#:: clear-screen-saving-contents-in-scrollback() { +#:: printf "\e[H\e[22J" +#:: } + +#:: For instance, using these escape codes, it is possible to remap +#:: Ctrl+L to both scroll the current screen contents into the +#:: scrollback buffer and clear the screen, instead of just clearing +#:: the screen. For ZSH, in ~/.zshrc, add: + +#:: .. code-block:: zsh + +#:: ctrl_l() { +#:: builtin print -rn -- $'\r\e[0J\e[H\e[22J' >"$TTY" +#:: builtin zle .reset-prompt +#:: builtin zle -R +#:: } +#:: zle -N ctrl_l +#:: bindkey '^l' ctrl_l + +#:: Alternatively, you can just add map ctrl+l clear_terminal +#:: to_cursor_scroll active to kitty.conf which works with no changes +#:: to the shell rc files, but only clears up to the prompt, it does +#:: not clear any text at the prompt itself. + +#: Clear to start + +# map cmd+k clear_terminal to_cursor active + +#: Clear scrollback + +# map option+cmd+k clear_terminal scrollback active + +#: Clear screen + +# map cmd+ctrl+l clear_terminal to_cursor_scroll active + +#: Reload kitty.conf + +# map kitty_mod+f5 load_config_file +# map ctrl+cmd+, load_config_file + +#:: Reload kitty.conf, applying any changes since the last time it +#:: was loaded. Note that a handful of options cannot be dynamically +#:: changed and require a full restart of kitty. Particularly, when +#:: changing shortcuts for actions located on the macOS global menu +#:: bar, a full restart is needed. You can also map a keybinding to +#:: load a different config file, for example:: + +#:: map f5 load_config /path/to/alternative/kitty.conf + +#:: Note that all options from the original kitty.conf are discarded, +#:: in other words the new configuration *replace* the old ones. + +#: Debug kitty configuration + +# map kitty_mod+f6 debug_config +# map opt+cmd+, debug_config + +#:: Show details about exactly what configuration kitty is running +#:: with and its host environment. Useful for debugging issues. + +#: Send arbitrary text on key presses + +#:: E.g. map ctrl+shift+alt+h send_text all Hello World + +#:: You can tell kitty to send arbitrary (UTF-8) encoded text to the +#:: client program when pressing specified shortcut keys. For +#:: example:: + +#:: map ctrl+alt+a send_text all Special text + +#:: This will send "Special text" when you press the Ctrl+Alt+A key +#:: combination. The text to be sent decodes ANSI C escapes +#:: so you can use escapes like \e to send control +#:: codes or \u21fb to send Unicode characters (or you can just input +#:: the Unicode characters directly as UTF-8 text). You can use +#:: `kitten show-key` to get the key escape codes you want to +#:: emulate. + +#:: The first argument to send_text is the keyboard modes in which to +#:: activate the shortcut. The possible values are normal, +#:: application, kitty or a comma separated combination of them. The +#:: modes normal and application refer to the DECCKM cursor key mode +#:: for terminals, and kitty refers to the kitty extended keyboard +#:: protocol. The special value all means all of them. + +#:: Some more examples:: + +#:: # Output a word and move the cursor to the start of the line (like typing and pressing Home) +#:: map ctrl+alt+a send_text normal Word\e[H +#:: map ctrl+alt+a send_text application Word\eOH +#:: # Run a command at a shell prompt (like typing the command and pressing Enter) +#:: map ctrl+alt+a send_text normal,application some command with arguments\r + +#: Open kitty Website + +# map shift+cmd+/ open_url https://sw.kovidgoyal.net/kitty/ + +#: Hide macOS kitty application + +# map cmd+h hide_macos_app + +#: Hide macOS other applications + +# map opt+cmd+h hide_macos_other_apps + +#: Minimize macOS window + +# map cmd+m minimize_macos_window + +#: Quit kitty + +# map cmd+q quit + +#: }}} + +#: }}} diff --git a/.config/mako/config b/.config/mako/config new file mode 100644 index 0000000..c01fc49 --- /dev/null +++ b/.config/mako/config @@ -0,0 +1,12 @@ +# Colors + +background-color=#303446 +text-color=#c6d0f5 +border-color=#8caaee +progress-color=over #414559 +default-timeout=5000 +border-radius=12 +font=hack 11 + +[urgency=high] +border-color=#ef9f76 diff --git a/.config/niri b/.config/niri new file mode 160000 index 0000000..7648a2a --- /dev/null +++ b/.config/niri @@ -0,0 +1 @@ +Subproject commit 7648a2af7b3432e34a4fbcb5a2981f05a2c1f3b7 diff --git a/.config/swaylock/config b/.config/swaylock/config new file mode 100644 index 0000000..b7f6d26 --- /dev/null +++ b/.config/swaylock/config @@ -0,0 +1,29 @@ +color=1e1e2e +bs-hl-color=f5e0dc +caps-lock-bs-hl-color=f5e0dc +caps-lock-key-hl-color=a6e3a1 +inside-color=00000000 +inside-clear-color=00000000 +inside-caps-lock-color=00000000 +inside-ver-color=00000000 +inside-wrong-color=00000000 +key-hl-color=a6e3a1 +layout-bg-color=00000000 +layout-border-color=00000000 +layout-text-color=cdd6f4 +line-color=00000000 +line-clear-color=00000000 +line-caps-lock-color=00000000 +line-ver-color=00000000 +line-wrong-color=00000000 +ring-color=b4befe +ring-clear-color=f5e0dc +ring-caps-lock-color=fab387 +ring-ver-color=89b4fa +ring-wrong-color=eba0ac +separator-color=00000000 +text-color=cdd6f4 +text-clear-color=f5e0dc +text-caps-lock-color=fab387 +text-ver-color=89b4fa +text-wrong-color=eba0ac diff --git a/.config/swaync/config.json b/.config/swaync/config.json new file mode 100644 index 0000000..7b04684 --- /dev/null +++ b/.config/swaync/config.json @@ -0,0 +1,100 @@ +{ + "$schema": "/etc/xdg/swaync/configSchema.json", + "ignore-gtk-theme": true, + "positionX": "right", + "positionY": "top", + "layer": "overlay", + "control-center-layer": "top", + "layer-shell": true, + "layer-shell-cover-screen": true, + "cssPriority": "user", + "control-center-margin-top": 0, + "control-center-margin-bottom": 0, + "control-center-margin-right": 0, + "control-center-margin-left": 0, + "notification-2fa-action": true, + "notification-inline-replies": false, + "notification-body-image-height": 100, + "notification-body-image-width": 200, + "timeout": 10, + "timeout-low": 5, + "timeout-critical": 0, + "fit-to-screen": true, + "relative-timestamps": true, + "control-center-width": 500, + "control-center-height": 600, + "notification-window-width": 500, + "keyboard-shortcuts": true, + "notification-grouping": true, + "image-visibility": "when-available", + "transition-time": 200, + "hide-on-clear": false, + "hide-on-action": true, + "text-empty": "No Notifications", + "script-fail-notify": true, + "scripts": { + "example-script": { + "exec": "echo 'Do something...'", + "urgency": "Normal" + }, + "example-action-script": { + "exec": "echo 'Do something actionable!'", + "urgency": "Normal", + "run-on": "action" + } + }, + "notification-visibility": { + "example-name": { + "state": "muted", + "urgency": "Low", + "app-name": "Spotify" + } + }, + "widgets": [ + "inhibitors", + "title", + "dnd", + "notifications" + ], + "widget-config": { + "notifications": { + "vexpand": true + }, + "inhibitors": { + "text": "Inhibitors", + "button-text": "Clear All", + "clear-all-button": true + }, + "title": { + "text": "Notifications", + "clear-all-button": true, + "button-text": "Clear All" + }, + "dnd": { + "text": "Do Not Disturb" + }, + "label": { + "max-lines": 5, + "text": "Label Text" + }, + "mpris": { + "blacklist": [], + "autohide": false, + "show-album-art": "always", + "loop-carousel": false + }, + "buttons-grid": { + "buttons-per-row": 7, + "actions": [ + { + "label": "直", + "type": "toggle", + "active": true, + "command": "sh -c '[[ $SWAYNC_TOGGLE_STATE == true ]] && nmcli radio wifi on || nmcli radio wifi off'", + "update-command": "sh -c '[[ $(nmcli radio wifi) == \"enabled\" ]] && echo true || echo false'" + } + ] + }, + } + "style": "~/.config/swaync/style.css" +} diff --git a/.config/swaync/style.css b/.config/swaync/style.css new file mode 100644 index 0000000..e7ac546 --- /dev/null +++ b/.config/swaync/style.css @@ -0,0 +1,328 @@ +* { + all: unset; + font-size: 14px; + font-family: "Ubuntu Nerd Font"; + transition: 200ms; +} + +trough highlight { + background: #cdd6f4; +} + +scale { + margin: 0 7px; +} + +scale trough { + margin: 0rem 1rem; + min-height: 8px; + min-width: 70px; + border-radius: 12.6px; +} + +trough slider { + margin: -10px; + border-radius: 12.6px; + box-shadow: 0 0 2px rgba(0, 0, 0, 0.8); + transition: all 0.2s ease; + background-color: #89b4fa; +} + +trough slider:hover { + box-shadow: 0 0 2px rgba(0, 0, 0, 0.8), 0 0 8px #89b4fa; +} + +trough { + background-color: #313244; +} + +/* notifications */ +.notification-background { + box-shadow: 0 0 8px 0 rgba(0, 0, 0, 0.8), inset 0 0 0 1px #45475a; + border-radius: 12.6px; + margin: 18px; + background: #181825; + color: #cdd6f4; + padding: 0; +} + +.notification-background .notification { + padding: 7px; + border-radius: 12.6px; +} + +.notification-background .notification.critical { + box-shadow: inset 0 0 7px 0 #f38ba8; +} + +.notification .notification-content { + margin: 7px; +} + +.notification .notification-content overlay { + /* icons */ + margin: 4px; +} + +.notification-content .summary { + color: #cdd6f4; +} + +.notification-content .time { + color: #a6adc8; +} + +.notification-content .body { + color: #bac2de; +} + +.notification > *:last-child > * { + min-height: 3.4em; +} + +.notification-background .close-button { + margin: 7px; + padding: 2px; + border-radius: 6.3px; + color: #1e1e2e; + background-color: #f38ba8; +} + +.notification-background .close-button:hover { + background-color: #eba0ac; +} + +.notification-background .close-button:active { + background-color: #f5c2e7; +} + +.notification .notification-action { + border-radius: 7px; + color: #cdd6f4; + box-shadow: inset 0 0 0 1px #45475a; + margin: 4px; + padding: 8px; + font-size: 0.2rem; /* controls the button size not text size*/ +} + +.notification .notification-action { + background-color: #313244; +} + +.notification .notification-action:hover { + background-color: #45475a; +} + +.notification .notification-action:active { + background-color: #585b70; +} + +.notification.critical progress { + background-color: #f38ba8; +} + +.notification.low progress, +.notification.normal progress { + background-color: #89b4fa; +} + +.notification progress, +.notification trough, +.notification progressbar { + border-radius: 12.6px; + padding: 3px 0; +} + +/* control center */ +.control-center { + box-shadow: 0 0 8px 0 rgba(0, 0, 0, 0.8), inset 0 0 0 1px #313244; + border-radius: 12.6px; + background-color: #1e1e2e; + color: #cdd6f4; + padding: 14px; +} + +.control-center .notification-background { + border-radius: 7px; + box-shadow: inset 0 0 0 1px #45475a; + margin: 4px 10px; +} + +.control-center .notification-background .notification { + border-radius: 7px; +} + +.control-center .notification-background .notification.low { + opacity: 0.8; +} + +.control-center .widget-title > label { + color: #cdd6f4; + font-size: 1.3em; +} + +.control-center .widget-title button { + border-radius: 7px; + color: #cdd6f4; + background-color: #313244; + box-shadow: inset 0 0 0 1px #45475a; + padding: 8px; +} + +.control-center .widget-title button:hover { + background-color: #45475a; +} + +.control-center .widget-title button:active { + background-color: #585b70; +} + +.control-center .notification-group { + margin-top: 10px; +} + +.control-center .notification-group:focus .notification-background { + background-color: #313244; +} + +scrollbar slider { + margin: -3px; + opacity: 0.8; +} + +scrollbar trough { + margin: 2px 0; +} + +/* dnd */ +.widget-dnd { + margin-top: 5px; + border-radius: 8px; + font-size: 1.1rem; +} + +.widget-dnd > switch { + font-size: initial; + border-radius: 8px; + background: #313244; + box-shadow: none; +} + +.widget-dnd > switch:checked { + background: #89b4fa; +} + +.widget-dnd > switch slider { + background: #45475a; + border-radius: 8px; +} + +/* mpris */ +.widget-mpris-player { + background: #313244; + border-radius: 12.6px; + color: #cdd6f4; +} + +.mpris-overlay { + background-color: #313244; + opacity: 0.9; + padding: 15px 10px; +} + +.widget-mpris-album-art { + -gtk-icon-size: 100px; + border-radius: 12.6px; + margin: 0 10px; +} + +.widget-mpris-title { + font-size: 1.2rem; + color: #cdd6f4; +} + +.widget-mpris-subtitle { + font-size: 1rem; + color: #bac2de; +} + +.widget-mpris button { + border-radius: 12.6px; + color: #cdd6f4; + margin: 0 5px; + padding: 2px; +} + +.widget-mpris button image { + -gtk-icon-size: 1.8rem; +} + +.widget-mpris button:hover { + background-color: #313244; +} + +.widget-mpris button:active { + background-color: #45475a; +} + +.widget-mpris button:disabled { + opacity: 0.5; +} + +.widget-menubar > box > .menu-button-bar > button > label { + font-size: 3rem; + padding: 0.5rem 2rem; +} + +.widget-menubar > box > .menu-button-bar > :last-child { + color: #f38ba8; +} + +.power-buttons button:hover, +.powermode-buttons button:hover, +.screenshot-buttons button:hover { + background: #313244; +} + +.control-center .widget-label > label { + color: #cdd6f4; + font-size: 2rem; +} + +.widget-buttons-grid { + padding-top: 1rem; +} + +.widget-buttons-grid > flowbox > flowboxchild > button label { + font-size: 2.5rem; +} + +.widget-volume { + padding: 1rem 0; +} + +.widget-volume label { + color: #74c7ec; + padding: 0 1rem; +} + +.widget-volume trough highlight { + background: #74c7ec; +} + +.widget-backlight trough highlight { + background: #f9e2af; +} + +.widget-backlight label { + font-size: 1.5rem; + color: #f9e2af; +} + +.widget-backlight .KB { + padding-bottom: 1rem; +} + +.image { + padding-right: 0.5rem; +} diff --git a/.config/waybar b/.config/waybar new file mode 160000 index 0000000..d9bf084 --- /dev/null +++ b/.config/waybar @@ -0,0 +1 @@ +Subproject commit d9bf08408520d01d221f7f1f49353ad5b98a623b diff --git a/.config/wlogout/icons/hibernate.svg b/.config/wlogout/icons/hibernate.svg new file mode 100644 index 0000000..9accf57 --- /dev/null +++ b/.config/wlogout/icons/hibernate.svg @@ -0,0 +1,7 @@ + + + + + Svg Vector Icons : http://www.onlinewebfonts.com/icon + + diff --git a/.config/wlogout/icons/lock.svg b/.config/wlogout/icons/lock.svg new file mode 100644 index 0000000..385347f --- /dev/null +++ b/.config/wlogout/icons/lock.svg @@ -0,0 +1,7 @@ + + + + + Svg Vector Icons : http://www.onlinewebfonts.com/icon + + diff --git a/.config/wlogout/icons/logout.svg b/.config/wlogout/icons/logout.svg new file mode 100644 index 0000000..fa4e03b --- /dev/null +++ b/.config/wlogout/icons/logout.svg @@ -0,0 +1,7 @@ + + + + + Svg Vector Icons : http://www.onlinewebfonts.com/icon + + diff --git a/.config/wlogout/icons/reboot.svg b/.config/wlogout/icons/reboot.svg new file mode 100644 index 0000000..e939e58 --- /dev/null +++ b/.config/wlogout/icons/reboot.svg @@ -0,0 +1,7 @@ + + + + + Svg Vector Icons : http://www.onlinewebfonts.com/icon + + diff --git a/.config/wlogout/icons/shutdown.svg b/.config/wlogout/icons/shutdown.svg new file mode 100644 index 0000000..4b980ee --- /dev/null +++ b/.config/wlogout/icons/shutdown.svg @@ -0,0 +1,7 @@ + + + + + Svg Vector Icons : http://www.onlinewebfonts.com/icon + + diff --git a/.config/wlogout/icons/suspend.svg b/.config/wlogout/icons/suspend.svg new file mode 100644 index 0000000..a8f5cd2 --- /dev/null +++ b/.config/wlogout/icons/suspend.svg @@ -0,0 +1,7 @@ + + + + + Svg Vector Icons : http://www.onlinewebfonts.com/icon + + diff --git a/.config/wlogout/layout b/.config/wlogout/layout new file mode 100644 index 0000000..b34eaff --- /dev/null +++ b/.config/wlogout/layout @@ -0,0 +1,36 @@ +{ + "label" : "lock", + "action" : "sh -c '( swaylock --screenshots --clock --indicator --indicator-radius 100 --indicator-thickness 7 --effect-blur 10x10)' & disown", + "text" : "Lock", + "keybind" : "l" +} +{ + "label" : "hibernate", + "action" : "systemctl hibernate", + "text" : "Hibernate", + "keybind" : "h" +} +{ + "label" : "logout", + "action" : "sh -c 'niri msg action quit skip-confirmation=true'", + "text" : "Logout", + "keybind" : "e" +} +{ + "label" : "shutdown", + "action" : "systemctl poweroff", + "text" : "Shutdown", + "keybind" : "s" +} +{ + "label" : "suspend", + "action" : "systemctl suspend", + "text" : "Suspend", + "keybind" : "u" +} +{ + "label" : "reboot", + "action" : "systemctl reboot", + "text" : "Reboot", + "keybind" : "r" +} diff --git a/.config/wlogout/style.css b/.config/wlogout/style.css new file mode 100644 index 0000000..e4e5866 --- /dev/null +++ b/.config/wlogout/style.css @@ -0,0 +1,54 @@ + +* { + background-image: none; + box-shadow: none; +} + +window { + background-color: rgba(30, 30, 46, 0.5); +} + +button { + border-color: #89b4fa; + text-decoration-color: #cdd6f4; + color: #cdd6f4; + background-color: #181825; + border-style: solid; + border-width: 1.5px; + border-radius: 8px; + background-repeat: no-repeat; + background-position: 50% 45%; + background-size: 18%; + margin: 13px; +} + +button:focus, button:active, button:hover { + /* 20% Overlay 2, 80% mantle */ + background-color: rgb(48, 50, 66); + outline-style: none; +} + + +#lock { + background-image: url("./icons/lock.svg"); +} + +#logout { + background-image: url("./icons/logout.svg"); +} + +#suspend { + background-image: url("./icons/suspend.svg"); +} + +#hibernate { + background-image: url("./icons/hibernate.svg"); +} + +#shutdown { + background-image: url("./icons/shutdown.svg"); +} + +#reboot { + background-image: url("./icons/reboot.svg"); +} diff --git a/.config/wofi/config b/.config/wofi/config new file mode 100644 index 0000000..4adee4d --- /dev/null +++ b/.config/wofi/config @@ -0,0 +1,15 @@ +hide_scroll=true +prompt=Launch +normal_window=true +no_actions=true +line_wrap=word +show-icons=true +width=550 +height=335 +allow_images=true +always_parse_args=true +show_all=false +term=kitty +insensitive=true +print_command=true +gtk_dark=false diff --git a/.config/wofi/gruvbox.css b/.config/wofi/gruvbox.css new file mode 100644 index 0000000..f4d6d84 --- /dev/null +++ b/.config/wofi/gruvbox.css @@ -0,0 +1,5 @@ +@define-color accent #BFAA80; +@define-color txt #DDD5C4; +@define-color bg #2C2A24; +@define-color bg2 #3A372F; +@define-color accent2 #8D7AAE; diff --git a/.config/wofi/style.css b/.config/wofi/style.css new file mode 100644 index 0000000..d2febeb --- /dev/null +++ b/.config/wofi/style.css @@ -0,0 +1,76 @@ +@import '/home/cloverta/.config/wofi/gruvbox.css'; + +* { + font-family: 'Iosevka Nerd Font mono'; + font-size: 14px; + } + + /* Window */ + window { + margin: 0px; + padding: 10px; + border-radius: 0px; + background-color: @bg; + } + + /* Inner Box */ + #inner-box { + margin: 5px; + padding: 10px; + border: none; + border-radius: 5px; + background-color: @bg; + } + + + /* Outer Box */ + #outer-box { + margin: 5px; + padding: 10px; + border: none; + background-color: @bg; + border-radius: 5px; + } + + /* Scroll */ + #scroll { + margin: 0px; + padding: 10px; + border: none; + } + + /* Input */ + #input { + margin: 10px 25px 10px 25px; + padding: 10px; + color: @accent; + background-color: @bg; + border: 2px solid @accent; + border-radius: 5px; + } + + /* Text */ + #text { + margin: 5px; + padding: 10px; + border: none; + color: @txt; + } + +/* Selected Entry */ +#entry:selected { + background-color: @bg; + border: 1px solid @accent2; + border-radius: 5px; +} + + #entry:selected #text { + color: @txt; + } + image { + margin-left: 10px; + } +/*entfernen des anderen durch .left oder .right*/ +#input > image.right { + -gtk-icon-transform:scaleX(0); + } diff --git a/install.sh b/install.sh new file mode 100755 index 0000000..c52b5ce --- /dev/null +++ b/install.sh @@ -0,0 +1,218 @@ +#!/bin/bash + +set -euo pipefail + +echo "This Script is used to install this dot from a CLEAN INSTALLATION of ARCH LINUX." +echo "If you have set up Niri/sddm/other DE already, you can simply use the other Script replace.sh." +echo "Note that this Script is more about convience so it might break your own configuration." +echo "Do you wish to continue?[y/N]" + +while true; do + read -r yn2 || yn2="" + yn2=${yn2:-n} + case "$yn2" in + [Yy]) + echo "Lets GO!" + break + ;; + [Nn]) + echo "Aborting.." + exit 0 + ;; + *) + echo "Input y/n (default=n)" + ;; + esac +done + +script_dir="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)" + +echo "This Script contains installation, which needs your sudo permission:" +sudo -v + +# Print key-value nicely: key: value +kv() { + local k="$1" + shift + local v="${1:-}" + printf "%-14s %s\n" "${k}:" "${v}" +} + +# Defaults +ID="" +ID_LIKE="" +NAME="" +PRETTY_NAME="" +VERSION_ID="" +VERSION_CODENAME="" + +# 1) Best source: /etc/os-release +if [[ -r /etc/os-release ]]; then + # shellcheck disable=SC1091 + . /etc/os-release + ID="${ID:-}" + ID_LIKE="${ID_LIKE:-}" + NAME="${NAME:-}" + PRETTY_NAME="${PRETTY_NAME:-}" + VERSION_ID="${VERSION_ID:-}" + VERSION_CODENAME="${VERSION_CODENAME:-}" + +# 2) Fallback: lsb_release +elif command -v lsb_release >/dev/null 2>&1; then + NAME="$(lsb_release -si 2>/dev/null || true)" + VERSION_ID="$(lsb_release -sr 2>/dev/null || true)" + VERSION_CODENAME="$(lsb_release -sc 2>/dev/null || true)" + PRETTY_NAME="${NAME} ${VERSION_ID}" + +# 3) Fallback: hostnamectl (systemd) +elif command -v hostnamectl >/dev/null 2>&1; then + # Example line: "Operating System: Arch Linux" + PRETTY_NAME="$(hostnamectl 2>/dev/null | awk -F': ' '/Operating System/ {print $2; exit}' || true)" + +# 4) Last resort: /etc/issue +elif [[ -r /etc/issue ]]; then + PRETTY_NAME="$(head -n1 /etc/issue | sed 's/\\.*$//' | xargs || true)" +fi + +# Normalize: if PRETTY_NAME empty, try to build +if [[ -z "${PRETTY_NAME}" ]]; then + PRETTY_NAME="${NAME:-Unknown Linux}${VERSION_ID:+ ${VERSION_ID}}" +fi + +echo "== Distro info ==" +kv "PRETTY_NAME" "${PRETTY_NAME}" +kv "ID" "${ID}" +kv "ID_LIKE" "${ID_LIKE}" +kv "NAME" "${NAME}" +kv "VERSION_ID" "${VERSION_ID}" +kv "CODENAME" "${VERSION_CODENAME}" + +# Optional: classify into a "family" +family="unknown" +case "${ID:-}" in +arch | manjaro | endeavouros) family="arch" ;; +ubuntu | debian | linuxmint | pop | elementary | kali) family="debian" ;; +fedora | rhel | centos | rocky | alma | ol) family="rhel" ;; +opensuse* | sles) family="suse" ;; +alpine) family="alpine" ;; +esac +kv "FAMILY" "${family}" + +if [ "$family" = "arch" ]; then + echo "This dot recommends you to install the following packages:" + echo "cava fastfetch fuzzel kitty mako niri swaylock-fancy-git swaync waybar wlogout wofi sddm" + echo "Do you wish to install these needed packages? [Y/n]" + while true; do + read -r yn || yn="" + yn=${yn:-y} # 回车默认 y + case "$yn" in + [Yy]) + echo "OK, installing..." + + aur_helper="" + if command -v yay >/dev/null 2>&1; then + aur_helper="yay" + elif command -v paru >/dev/null 2>&1; then + aur_helper="paru" + fi + + if [[ -n "$aur_helper" ]]; then + echo "Found AUR helper: $aur_helper" + else + echo "No AUR helper found (yay/paru). Do you wish to install yay/paru?[y(yay)/p(paru)/n(don't install)]" + while true; do + read -r yn1 || yn1="" + case "$yn1" in + [Yy]) + echo "Installing Yay for you..." + sudo pacman -S --needed git base-devel + tmpdir="$(mktemp -d)" + ( + trap 'rm -rf "$tmpdir"' EXIT + cd "$tmpdir" + git clone https://aur.archlinux.org/yay-bin.git + cd yay-bin + makepkg -si --noconfirm + ) + command -v yay >/dev/null 2>&1 && aur_helper="yay" || aur_helper="" + break + ;; + [Pp]) + echo "Installing Paru for you..." + sudo pacman -S --needed git base-devel + tmpdir="$(mktemp -d)" + ( + trap 'rm -rf "$tmpdir"' EXIT + cd "$tmpdir" + git clone https://aur.archlinux.org/paru.git + cd paru + makepkg -si --noconfirm + ) + command -v paru >/dev/null 2>&1 && aur_helper="paru" || aur_helper="" + break + ;; + [Nn]) + echo "Skipped." + break + ;; + *) + echo "Please enter y/p/n." + ;; + esac + done + fi + + if [[ -z "$aur_helper" ]]; then + echo "Continue installing using pacman, replacing swaylock-fancy with swaylock" + sudo pacman -S --needed cava fastfetch fuzzel kitty mako niri swaylock swaync waybar wlogout wofi sddm + else + echo "Installing packages..." + "$aur_helper" -S --needed cava fastfetch fuzzel kitty mako niri swaylock-fancy-git swaync waybar wlogout wofi sddm + fi + + echo "Setting up SDDM..." + sudo systemctl enable --now sddm.service + sudo systemctl set-default graphical.target + bash -c "$(curl -fsSL https://raw.githubusercontent.com/keyitdev/sddm-astronaut-theme/master/setup.sh)" || echo "SDDM theme setup failed, skipped." + + mkdir -p ~/.config + shopt -s nullglob dotglob + cp -r "$script_dir/.configs/"* ~/.config/ + shopt -u nullglob dotglob + + echo "Do you wish to use the grub theme from https://github.com/mateosss/matter?[Y/n]" + while true; do + read -r yn3 || yn3="" + yn3=${yn3:-y} + case "$yn3" in + [Yy]) + echo "Setting up grub theme..." + python3 "$script_dir/matter/matter.py" + echo "./matter/matter.py -i(write your params here):" + read -r -a tokens || tokens=() + python3 "$script_dir/matter/matter.py" -i "${tokens[@]}" + break + ;; + [Nn]) + echo "Skipped." + break + ;; + *) + echo "Please Input y/n (default=y)" + ;; + esac + done + break + ;; + [Nn]) + echo "Skipped." + break + ;; + *) echo "Please enter y or n (default: y): " ;; + esac + done +else + echo "Your Distro is not supported yet, Please install these needed packages manually:" + echo "cava fastfetch fuzzel kitty mako niri swaylock swaync waybar wlogout wofi sddm" + echo "You can use the replace.sh to replace all the configs after install. :)" +fi diff --git a/matter/LICENSE b/matter/LICENSE new file mode 100644 index 0000000..36b7cd9 --- /dev/null +++ b/matter/LICENSE @@ -0,0 +1,23 @@ +Boost Software License - Version 1.0 - August 17th, 2003 + +Permission is hereby granted, free of charge, to any person or organization +obtaining a copy of the software and accompanying documentation covered by +this license (the "Software") to use, reproduce, display, distribute, +execute, and transmit the Software, and to prepare derivative works of the +Software, and to permit third-parties to whom the Software is furnished to +do so, all subject to the following: + +The copyright notices in the Software and this entire statement, including +the above license grant, this restriction and the following disclaimer, +must be included in all copies of the Software, in whole or in part, and +all derivative works of the Software, unless such copies or derivative +works are solely in the form of machine-executable object code generated by +a source language processor. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/matter/Matter/README.md b/matter/Matter/README.md new file mode 100644 index 0000000..661f24a --- /dev/null +++ b/matter/Matter/README.md @@ -0,0 +1,3 @@ +Based on Vimix by Vince Liuice + +https://www.gnu.org/software/grub/manual/grub/html_node/Theme-file-format.html diff --git a/matter/Matter/font.pf2 b/matter/Matter/font.pf2 new file mode 100644 index 0000000..491ecd5 Binary files /dev/null and b/matter/Matter/font.pf2 differ diff --git a/matter/Matter/icons/README.md b/matter/Matter/icons/README.md new file mode 100644 index 0000000..abc993c --- /dev/null +++ b/matter/Matter/icons/README.md @@ -0,0 +1 @@ +The converted png icons you choose for the --set-icons option will be saved to this folder. diff --git a/matter/Matter/icons/arch.png b/matter/Matter/icons/arch.png new file mode 100644 index 0000000..84018e6 Binary files /dev/null and b/matter/Matter/icons/arch.png differ diff --git a/matter/Matter/icons/cog.png b/matter/Matter/icons/cog.png new file mode 100644 index 0000000..87d7e8e Binary files /dev/null and b/matter/Matter/icons/cog.png differ diff --git a/matter/Matter/icons/microsoft-windows.png b/matter/Matter/icons/microsoft-windows.png new file mode 100644 index 0000000..f5196c9 Binary files /dev/null and b/matter/Matter/icons/microsoft-windows.png differ diff --git a/matter/Matter/select_c.png b/matter/Matter/select_c.png new file mode 100644 index 0000000..dfab69a Binary files /dev/null and b/matter/Matter/select_c.png differ diff --git a/matter/Matter/select_e.png b/matter/Matter/select_e.png new file mode 100644 index 0000000..062fe62 Binary files /dev/null and b/matter/Matter/select_e.png differ diff --git a/matter/Matter/select_n.png b/matter/Matter/select_n.png new file mode 100644 index 0000000..c034db1 Binary files /dev/null and b/matter/Matter/select_n.png differ diff --git a/matter/Matter/select_ne.png b/matter/Matter/select_ne.png new file mode 100644 index 0000000..7be4d3a Binary files /dev/null and b/matter/Matter/select_ne.png differ diff --git a/matter/Matter/select_nw.png b/matter/Matter/select_nw.png new file mode 100644 index 0000000..58c7379 Binary files /dev/null and b/matter/Matter/select_nw.png differ diff --git a/matter/Matter/select_s.png b/matter/Matter/select_s.png new file mode 100644 index 0000000..036d9e6 Binary files /dev/null and b/matter/Matter/select_s.png differ diff --git a/matter/Matter/select_se.png b/matter/Matter/select_se.png new file mode 100644 index 0000000..47a34c0 Binary files /dev/null and b/matter/Matter/select_se.png differ diff --git a/matter/Matter/select_sw.png b/matter/Matter/select_sw.png new file mode 100644 index 0000000..9290695 Binary files /dev/null and b/matter/Matter/select_sw.png differ diff --git a/matter/Matter/select_w.png b/matter/Matter/select_w.png new file mode 100644 index 0000000..b5bfb5d Binary files /dev/null and b/matter/Matter/select_w.png differ diff --git a/matter/Matter/terminal_box_c.png b/matter/Matter/terminal_box_c.png new file mode 100644 index 0000000..d0dd52a Binary files /dev/null and b/matter/Matter/terminal_box_c.png differ diff --git a/matter/Matter/terminal_box_e.png b/matter/Matter/terminal_box_e.png new file mode 100644 index 0000000..394cbe4 Binary files /dev/null and b/matter/Matter/terminal_box_e.png differ diff --git a/matter/Matter/terminal_box_n.png b/matter/Matter/terminal_box_n.png new file mode 100644 index 0000000..476f8bc Binary files /dev/null and b/matter/Matter/terminal_box_n.png differ diff --git a/matter/Matter/terminal_box_ne.png b/matter/Matter/terminal_box_ne.png new file mode 100644 index 0000000..9e26959 Binary files /dev/null and b/matter/Matter/terminal_box_ne.png differ diff --git a/matter/Matter/terminal_box_nw.png b/matter/Matter/terminal_box_nw.png new file mode 100644 index 0000000..5c3cba8 Binary files /dev/null and b/matter/Matter/terminal_box_nw.png differ diff --git a/matter/Matter/terminal_box_s.png b/matter/Matter/terminal_box_s.png new file mode 100644 index 0000000..85a8901 Binary files /dev/null and b/matter/Matter/terminal_box_s.png differ diff --git a/matter/Matter/terminal_box_se.png b/matter/Matter/terminal_box_se.png new file mode 100644 index 0000000..d8627ee Binary files /dev/null and b/matter/Matter/terminal_box_se.png differ diff --git a/matter/Matter/terminal_box_sw.png b/matter/Matter/terminal_box_sw.png new file mode 100644 index 0000000..67c600c Binary files /dev/null and b/matter/Matter/terminal_box_sw.png differ diff --git a/matter/Matter/terminal_box_w.png b/matter/Matter/terminal_box_w.png new file mode 100644 index 0000000..d066e2d Binary files /dev/null and b/matter/Matter/terminal_box_w.png differ diff --git a/matter/Matter/theme.txt b/matter/Matter/theme.txt new file mode 100644 index 0000000..d519f27 --- /dev/null +++ b/matter/Matter/theme.txt @@ -0,0 +1,48 @@ +# If this file is called theme.txt then the theme template has been +# already parsed and the comments below could not make too much sense. + +# theme.txt.template represents a python string that gets format()-ed +# Note: for escaping literal curly braces, double them like so: { or } + +# Matter Theme File +# Designed for any resolution + +# Global Property +title-text: "" +# desktop-image: "background.png" +desktop-color: "#263238" +terminal-font: "Unifont Regular 16" # A smaller font for the console +terminal-box: "terminal_box_*.png" +terminal-left: "0" +terminal-top: "0" +terminal-width: "100%" +terminal-height: "100%" +terminal-border: "0" + +# Show the boot menu ++ boot_menu { + left = 36% + top = 29% + width = 28% + height = 60% + item_font = "Josefin Sans Regular 32" + item_color = "#ffffff" + selected_item_color = "#e91e63" + icon_width = 72 + icon_height = 72 + item_height = 72 + item_spacing = 36 + selected_item_pixmap_style = "select_*.png" +} + +# Show a countdown message using the label component ++ label { + top = 82% + left = 35% + width = 30% + align = "center" + id = "__timeout__" + text = "Booting in %d seconds" + color = "#ffffff" + font = "Josefin Sans Regular 32" +} diff --git a/matter/README.md b/matter/README.md new file mode 100644 index 0000000..a5e3b52 --- /dev/null +++ b/matter/README.md @@ -0,0 +1,397 @@ +# Matter + +Minimalist grub theme originally inspired by material design 2. + +![Matter Gif](.docs/matter.gif) + +Feel free to open issues for any problem or request you have and/or submit pull +requests. + +# Index + +- [Matter](#matter) +- **[Download](#download)** +- [Usage](#usage) + - [Help](#help) + - **[Quick Start](#quick-start)** + - [Uninstall](#uninstall) + - [Fonts](#fonts) + - [Colors](#colors) + - [Images](#images-unfinished) + - [Testing Without Rebooting](#testing-without-rebooting) +- [What does Matter do to my system + files?](#what-does-matter-do-to-my-system-files) +- [Gallery](#gallery): [1](#example-1), [2](#example-2), [3](#example-3), + [4](#example-4), [5](#example-5), [6](#example-6), [7](#example-7), + [8](#example-8), [9](#example-9), [10](#example-10), [11](#example-11) +- [Contributing](#contributing) +- [Thanks](#thanks) + +# Download + +[Click here to download Matter](https://github.com/mateosss/matter/releases/latest/download/matter.zip) + +It is **strongly advised** to put the downloaded files in some folder that will +not get deleted, as the main script `matter.py` is needed for future grub +updates made by your system. Also if you want to uninstall matter you could do +it from there as well. + +## Dependencies + +Matter will inform you of any missing dependencies, but here is a list anyways: + +- `inkscape` (**Main dependency**): This brings the `convert` command from + `imagemagick` with best svg to png conversion. +- `grub-mkconfig` and `grub-mkfont`: General grub utilities needed. If you + don't have these, please create an issue with more information about your + system as I've only worked with ones that have these commands. +- `PIL` (Optional): For image conversions with the `--downloadbackground/-dlbg` + option. Can be installed with either of: `pip install Pillow`, `sudo apt + install python3-pil` (Ubuntu), `pacman -S python-pillow` (Arch). +- [`grub2-theme-preview`](https://github.com/hartwork/grub2-theme-preview) + (Optional): For testing results (`--test/-t` argument) without rebooting. + +# Usage + +## Help + +You always can see the command reference with `./matter.py -h`, next up are some +sections that may be useful, or may not be very well documented in the command's +help. + +## Quick Start + +
+ +Note for Fedora users (click to show) + +*Matter does not yet support [The Boot Loader +Specification](https://systemd.io/BOOT_LOADER_SPECIFICATION/) so before executing +`matter.py` you should set `GRUB_ENABLE_BLSCFG="false"` in `/etc/default/grub` and then +update your grub file with `sudo grub2-mkconfig -o /boot/grub2/grub.cfg`* + +*See [this issue](https://github.com/mateosss/matter/issues/41) for updates +or if you want to help out with fedora support* + +
+ +
+ +Note for users with screen resolution other than 1920x1080 (click to show) + +*Matter layout might break in other resolutions with the default installation, +you might need to tweak the [`grub.template`](grub.template) `GRUB_GFXMODE` +property and [`theme.txt.template`](theme.txt.template) percentages* + +*See [this issue](https://github.com/mateosss/matter/issues/4) for more +information.* + +
+ +Following is a Matter installation with default values. Don't worry, it is very +easy to rollback or overwrite this installation later if you want to. + +The script that does all the work is `matter.py`, so let's start by running it + +```sh +./matter.py +``` + +It outputs almost everything you need to know for later, but for now let's focus +on the list it shows, those are your grub entries. It should look similar to +this one: + +```sh +1. Ubuntu +2. Windows +3. More Options +4. Ubuntu, with Linux 5.3.0-61-generic +5. Ubuntu, with Linux 5.3.0-61-generic (recovery mode) +6. Ubuntu, with Linux 5.3.0-59-generic +7. Ubuntu, with Linux 5.3.0-59-generic (recovery mode) +8. System Setup +``` + +Now you should pick some icons from for each entry +listed (you only need the icon's name, use the search panel and hover over any +icon you like to see its name). For this example I will pick `ubuntu` for entry +1, `microsoft-windows` for 2, `folder` for 3 (as it is a submenu in my +particular case), and `cog` for 8. I don't care about all the remaining entries +so I will just use "`_`" (underscore) for those. + +```sh +# Installs matter with icons matching the corresponding entries +./matter.py -i ubuntu microsoft-windows folder _ _ _ _ cog +``` + +**And thats it!** If you reboot now, you should get something like this: + +![Quick Start Result](.docs/quickstartresult.png) + +*Tip: If you need to tidy up your grub entries hierarchy and names I recommend +using [grub-customizer](https://launchpad.net/grub-customizer) +([tutorial](https://vitux.com/how-to-install-grub-customizer-on-ubuntu/))*. + +## Uninstall + +You can completely remove Matter from your system with `./matter.py -u` + +## Fonts + +Matter uses `.ttf` fonts and only one, the default, comes prepackaged. You can +specify your own fonts by giving a `.ttf` file, the font name, and an optional +font size like so: + +```sh +./matter.py -ff ~/fonts/Cinzel/Cinzel-Regular.ttf -fn Cinzel Regular -fs 40 +``` + +- `--fontfile/-ff`: The `.ttf` path +- `--fontname/-fn`: The name of the font, in this case `Cinzel Regular` but + could be `Open Sans Bold` (*Tip: If you don't know the font name, you can + specify any name, go to the grub, press C to open console, and type `lsfonts` + to list the font names*) +- `--fontsize/-fs`: By default it is 32, recommended values are multiples of 4. +- `--font/-f`: This argument is not used in this example as it is used to select + prepackaged fonts. Note that after giving a ttf file to `-ff`, matter will + save it as a prepackaged font, so it could be referenced later on with this + flag. See prepackaged (available) fonts at the end of `--help/-h` output + +*Tip: [Google Fonts](https://fonts.google.com/) is a good place to get fonts* + +## Colors + +You can specify the color of 4 elements: `--foreground/-fg`, `--background/-bg`, +`--iconcolor/-ic` and `--highlight/-hl` (selected text color), there are some +Material Design colors prepackaged that you can see at the end of the +`--help/-h` output, you can also specify custom colors. Here is an example of +the syntax: + +```sh +./matter.py -hl FFC107 -fg white -bg 2196f3 -ic pink +``` + +## Images (unfinished) + +You can specify a background image with `--image/-im`, the supported image +formats/extensions are PNG, JPG, JPEG, and TGA. This feature is considered +*unfinished* because it does not yet work as well as it could *(see +[#58](https://github.com/mateosss/matter/issues/58))* + +Here is an example of the syntax: + +```sh +./matter.py -im ~/Pictures/some-cool-image-that-has-good-contrast-with-my-text-color.png +``` + +You can also specify an URL with --downloadbackground/-dlbg to automatically download an image from the internet. The image will be converted to png so it doesn't need to be a grub-compatible 8-bit jpg. It should be in the `jpg` or `png` format though. This feature is also considered *unfinished*. + +```sh +./matter.py -dlbg "https://source.unsplash.com/1920x1080/?nature" +``` + +## Testing Without Rebooting + +If you install the `pip` package +[`grub2-theme-preview`](https://github.com/hartwork/grub2-theme-preview) you can +test combinations of fonts and colors with the `--buildonly/-b` and `--test/-t` +flags like so: + +```sh +./matter.py -t -b -i ubuntu microsoft-windows folder _ _ _ _ _ _ cog \ +-hl FFC107 -fg white -bg 2196F3 \ +-ff ~/fonts/MuseoModerno/static/MuseoModerno-Regular.ttf \ +-fn MuseoModerno Regular -fs 40 +``` + +*Note: it will use your system's grub.cfg, so set your icons beforehand*. + +# What does Matter do to my system files? + +Besides the need for the extracted files to be in a persistent location, Matter +needs to edit three files: + +1. `/etc/default/grub`: For setting theme and resolution. +2. `/boot/grub/grub.cfg`: For setting icons. +3. `/usr/sbin/grub-mkconfig`: For making icons persistent across grub updates. +4. `/etc/grub.d/99_matter`: For making icons persistent across grub upgrades. + +Also it places the theme files in `/boot/grub/themes/Matter/`, this one is +standard to grub themes in general. + +Both **(1)** and **(3)** are clearly distinguished with special `BEGIN`/`END` +comments at the end of each file. **(2)** Adds a `--class` flag to each entry, +but it can be restored as new with `update-grub`. And **(4)** is a custom file. + +*All of these modifications are **completely** cleaned up by uninstalling* + +# Gallery + +Here are some examples with their respective commands that you can copy or get +inspired from. + +## Example 1 + +![Example 1](.docs/gallery1.gif) + +*Font: [Josefin Sans Regular +400](https://fonts.google.com/specimen/Josefin+Sans)* + +```sh +# Light version, invert -fg and -bg for dark one +./matter.py -i ubuntu microsoft-windows folder _ _ _ _ _ _ cog \ +-hl ef233c -fg 2b2d42 -bg edf2f4 \ +-ff ~/fonts/Josefin_Sans/static/JosefinSans-Regular.ttf \ +-fn Josefin Sans Regular -fs 32 +``` + +## Example 2 + +![Example 2](.docs/gallery2.png) + +*Font: [Comfortaa Medium 500](https://fonts.google.com/specimen/Comfortaa)* + +```sh +./matter.py -i ubuntu microsoft-windows folder _ _ _ _ _ _ cog \ +-hl white -fg f0f0f0 -bg ff0d7b \ +-ff ~/fonts/Comfortaa/static/Comfortaa-Medium.ttf \ +-fn Comfortaa Regular -fs 32 +``` + +## Example 3 + +![Example 3](.docs/gallery3.png) + +*Font: [Lobster Regular 400](https://fonts.google.com/specimen/Lobster)* + +```sh +./matter.py -i ubuntu microsoft-windows folder _ _ _ _ _ _ cog \ +-hl 118ab2 -fg ffd166 -bg 073b4c \ +-ff ~/fonts/Lobster/Lobster-Regular.ttf \ +-fn Lobster Regular -fs 32 +``` + +## Example 4 + +![Example 4](.docs/gallery4.gif) + +*Fonts: [Bebas Neue Regular 400](https://fonts.google.com/specimen/Bebas+Neue) +and [Russo One Regular 400](https://fonts.google.com/specimen/Russo+One)* + +```sh +# Using Bebas Neue font (more compact), the other uses Russo One +./matter.py -i ubuntu microsoft-windows folder _ _ _ _ _ _ cog \ +-hl 2c251b -fg 2c251b -bg ffe70b \ +-ff ~/fonts/Bebas_Neue/BebasNeue-Regular.ttf \ +-fn Bebas Neue Regular -fs 36 +# -ff ~/fonts/Russo_One/RussoOne-Regular.ttf \ +# -fn Russo One Regular -fs 36 + +``` + +## Example 5 + +![Example 5](.docs/gallery5.png) + +*Font: [Poiret One Regular 400](https://fonts.google.com/specimen/Poiret+One)* + +```sh +./matter.py -i ubuntu microsoft-windows folder _ _ _ _ _ _ cog \ +-hl black -fg 101010 -bg fce1e0 \ +-ff ~/fonts/Poiret_One/PoiretOne-Regular.ttf \ +-fn Poiret One Regular -fs 48 +``` + +## Example 6 + +![Example 6](.docs/gallery6.png) + +*Font: [Josefin Sans Medium +500](https://fonts.google.com/specimen/Josefin+Sans)* + +```sh +./matter.py -i ubuntu microsoft-windows folder _ _ _ _ _ _ cog \ +-hl ffe78a -fg fdf7f9 -bg 582335 \ +-ff ~/fonts/Josefin_Sans/static/JosefinSans-Medium.ttf \ +-fn Josefin Sans Regular -fs 32 +``` + +## Example 7 + +![Example 7](.docs/gallery7.png) + +*Font: [Josefin Slab Bold 700](https://fonts.google.com/specimen/Josefin+Slab)* + +```sh +./matter.py -i ubuntu microsoft-windows folder _ _ _ _ _ _ cog \ +-hl A4E11E -fg white -bg 5b1ee1 \ +-ff ~/fonts/Josefin_Slab/JosefinSlab-Bold.ttf \ +-fn Josefin Slab Bold -fs 36 +``` + +## Example 8 + +![Example 8](.docs/gallery8.png) + +*Font: [MuseoModerno Regular +400](https://fonts.google.com/specimen/MuseoModerno)* + +```sh +./matter.py -i ubuntu microsoft-windows folder _ _ _ _ _ _ cog \ +-hl FFC107 -fg white -bg 2196F3 \ +-ff ~/fonts/MuseoModerno/static/MuseoModerno-Regular.ttf \ +-fn MuseoModerno Regular -fs 32 +``` + +## Example 9 + +![Example 9](.docs/gallery9.png) + +*Font: [Amatic SC Regular 400](https://fonts.google.com/specimen/Amatic+SC)* + +```sh +./matter.py -i ubuntu microsoft-windows folder _ _ _ _ _ _ cog \ +-bg FFF8E1 -fg 263238 -hl E91E63 \ +-ff ~/fonts/Amatic_SC/AmaticSC-Regular.ttf \ +-fn Amatic SC Regular -fs 64 +``` + +## Example 10 + +![Example 10](.docs/gallery10.gif) + +*Font: [Cinzel Regular 400](https://fonts.google.com/specimen/Cinzel)* + +```sh +# This is the light version, the dark one uses -bg 1a1d21 -fg c9a45b instead +./matter.py -i ubuntu microsoft-windows folder _ _ _ _ _ _ cog \ +-hl c28f2c -bg white -fg d0a85c \ +-ff ~/fonts/Cinzel/Cinzel-Regular.ttf \ +-fn Cinzel Regular -fs 40 +# -hl c28f2c -bg 1a1d21 -fg c9a45b \ +``` + +## Example 11 + +![Example 11](.docs/gallery11.png) + +```sh +./matter.py -i ubuntu microsoft-windows folder _ _ _ _ _ _ cog \ +-im ~/images/material-background.png +``` + +# Contributing + +Feel free to submit any pull request that improves in any way the project. + +Read the wiki , that's where any useful +information for developers will reside. + +If you think you got a nice result out of Matter and would like to share it, +please create an issue with it! I would love to see your results. + +# Thanks + +- Originally inspired by +- Icons from +- Fonts mainly from diff --git a/matter/__pycache__/svg2png.cpython-313.pyc b/matter/__pycache__/svg2png.cpython-313.pyc new file mode 100644 index 0000000..527ec93 Binary files /dev/null and b/matter/__pycache__/svg2png.cpython-313.pyc differ diff --git a/matter/__pycache__/utils.cpython-313.pyc b/matter/__pycache__/utils.cpython-313.pyc new file mode 100644 index 0000000..7de9fa8 Binary files /dev/null and b/matter/__pycache__/utils.cpython-313.pyc differ diff --git a/matter/bg/README.md b/matter/bg/README.md new file mode 100644 index 0000000..fd70fc5 --- /dev/null +++ b/matter/bg/README.md @@ -0,0 +1 @@ +The background images you choose for the --downloadbackground option will be saved to this folder. \ No newline at end of file diff --git a/matter/config.json b/matter/config.json new file mode 100644 index 0000000..50d8e64 --- /dev/null +++ b/matter/config.json @@ -0,0 +1 @@ +{"icons": {"Arch Linux, with Linux linux": "arch", "UEFI Firmware Settings": "cog", "Windows 11 (EFI)": "microsoft-windows"}} \ No newline at end of file diff --git a/matter/fonts/Josefin_Sans_Regular.ttf b/matter/fonts/Josefin_Sans_Regular.ttf new file mode 100644 index 0000000..7f58172 Binary files /dev/null and b/matter/fonts/Josefin_Sans_Regular.ttf differ diff --git a/matter/fonts/Poiret_One_Regular.ttf b/matter/fonts/Poiret_One_Regular.ttf new file mode 100644 index 0000000..b339511 Binary files /dev/null and b/matter/fonts/Poiret_One_Regular.ttf differ diff --git a/matter/fonts/README.md b/matter/fonts/README.md new file mode 100644 index 0000000..00ab00c --- /dev/null +++ b/matter/fonts/README.md @@ -0,0 +1 @@ +Preloaded Matter fonts, for adding a new one update FONTS dict in matter.py diff --git a/matter/grub.template b/matter/grub.template new file mode 100644 index 0000000..d6aec08 --- /dev/null +++ b/matter/grub.template @@ -0,0 +1,6 @@ +GRUB_THEME={installation_dir}/theme.txt +GRUB_GFXMODE=1920x1080,auto + +# Fedora specific fixes +GRUB_ENABLE_BLSCFG=false +GRUB_TERMINAL_OUTPUT="" diff --git a/matter/hookcheck.py.template b/matter/hookcheck.py.template new file mode 100644 index 0000000..583a1ce --- /dev/null +++ b/matter/hookcheck.py.template @@ -0,0 +1,79 @@ +#!/usr/bin/env python3 + +""" +This template file goes into /etc/grub.d/99_matter +It checks that the theme is still hooked to grub-mkconfig. +Hooks it back again if not. + +This is a template file, be careful of your use of curly braces. Use {{ and }} instead. + +# About /etc/grub.d +Files in /etc/grub.d run in the order of their prefix number. +We use the 99 number because the hook should be run after the entire grub.cfg file is generated. +Everything echoed to stdout is written to /boot/grub/grub.cfg after the previous files. +Everything echoed to stderr is shown to the user wherever there is a grub update. +This script does not write to stdout. +More @ https://www.gnu.org/software/grub/manual/grub/grub.html#Simple-configuration + +# Why this script exists? +Files in /etc/grub.d are not erased after your distro upgrades the grub package. +As this theme relies on being hooked to the grub-mkconfig file (i.e. executed by it) +and grub package upgrades restore the mkconfig file, this file detects +when the grub-mkconfig file has been restored and then hook the theme back onto it. +""" + +import re +from subprocess import run +from sys import stderr + +GRUB_MKCONFIG_PATH = "{GRUB_MKCONFIG_PATH}" +THEME_NAME = "{THEME_NAME}" +THEME_OVERRIDES_TITLE = "{THEME_OVERRIDES_TITLE}" +BEGIN_THEME_OVERRIDES = "{BEGIN_THEME_OVERRIDES}" +END_THEME_OVERRIDES = "{END_THEME_OVERRIDES}" +SETICONS_CALL = "{SETICONS_CALL}" + +cyan = "\033[36m" +pink = "\033[38;5;206m" +endcolor ="\033[0m" +def info(msg): + # info with cyan [I] + print(f"{{cyan}}[I]{{endcolor}} {{msg}}", file=stderr) + + +def sh(command): + "Executes command in shell and returns its exit status" + return run(command, shell=True).returncode + +info(f"{{pink}}[Matter]{{endcolor}} Setting entry icons") + +with open(GRUB_MKCONFIG_PATH, "r", newline="") as f: + grub_mkconfig = f.read() + +theme_overrides = f"\n*{{BEGIN_THEME_OVERRIDES}}.*{{END_THEME_OVERRIDES}}\n*" +theme_hooked = re.search(theme_overrides, grub_mkconfig, flags=re.DOTALL) is not None + +if theme_hooked: + info(f"Found {{GRUB_MKCONFIG_PATH}} hook") + exit(0) + +info(f"Hook back onto {{GRUB_MKCONFIG_PATH}}") + +grub_mkconfig += ( + f"\n\n{{BEGIN_THEME_OVERRIDES}}\n{{SETICONS_CALL}}\n{{END_THEME_OVERRIDES}}\n\n" +) + +with open(GRUB_MKCONFIG_PATH, "w") as f: + f.write(grub_mkconfig) + +info( + f"{{GRUB_MKCONFIG_PATH}} successfully patched, icons will now persist between grub updates." +) + + +# Lastly call the hook as mkconfig is currently running and should be loaded in memory. +# NOTE: Some bash interpreters seem to not load the entire script in memory +# so appending commands to the end of the script at runtime will indeed make +# mkconfig run them. That's what's happening is you see the +# 'grub.cfg icons patched' message twice +sh(SETICONS_CALL) diff --git a/matter/icons/README.md b/matter/icons/README.md new file mode 100644 index 0000000..0e6ed27 --- /dev/null +++ b/matter/icons/README.md @@ -0,0 +1 @@ +The icons svg you choose for the --set-icons option will be saved to this folder. diff --git a/matter/icons/arch.svg b/matter/icons/arch.svg new file mode 100644 index 0000000..2caeeb1 --- /dev/null +++ b/matter/icons/arch.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/matter/icons/cog.svg b/matter/icons/cog.svg new file mode 100644 index 0000000..337bd33 --- /dev/null +++ b/matter/icons/cog.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/matter/icons/microsoft-windows.svg b/matter/icons/microsoft-windows.svg new file mode 100644 index 0000000..74eca53 --- /dev/null +++ b/matter/icons/microsoft-windows.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/matter/matter.py b/matter/matter.py new file mode 100755 index 0000000..1962694 --- /dev/null +++ b/matter/matter.py @@ -0,0 +1,882 @@ +#!/usr/bin/python3 + +# Standard library modules +import sys +import os +import re +import json +import argparse +import urllib.request as request +from urllib.error import HTTPError, URLError +from argparse import ArgumentParser, RawTextHelpFormatter +from os.path import dirname, basename, isdir, exists +from shutil import which, rmtree, copytree, copyfile +try: + from PIL import Image +except: + has_PIL = False +else: + has_PIL = True + +# Local Matter modules +from utils import * +from svg2png import inkscape_convert_svg2png, magick_convert_svg2png + +# Configuration constants + +MIN_PYTHON_VERSION = (3, 6) # Mainly for f-strings + +THEME_NAME = "Matter" +THEME_DESCRIPTION = ( + "Matter is a minimalist grub theme originally inspired by material design 2.\n" + "Run this script without arguments for next steps on installing Matter." +) + + + +if exists("/boot/grub"): + BOOT_GRUB_PATH = "/boot/grub" +elif exists("/boot/grub2"): + BOOT_GRUB_PATH = "/boot/grub2" +else: + error("Could not find your grub's boot path (tried /boot/grub and /boot/grub2)") + +INSTALLER_ABSPATH = os.path.abspath(__file__) +INSTALLER_NAME = basename(INSTALLER_ABSPATH) +INSTALLER_DIR = dirname(INSTALLER_ABSPATH) +INSTALLATION_SOURCE_DIR = f"{INSTALLER_DIR}/{THEME_NAME}" +INSTALLATION_TARGET_DIR = f"{BOOT_GRUB_PATH}/themes/{THEME_NAME}" + +THEME_DEFAULT_HIGHLIGHT = "pink" +THEME_DEFAULT_FOREGROUND = "white" +THEME_DEFAULT_BACKGROUND = "bluegrey-900" +THEME_DEFAULT_FONT_NAME = "Josefin Sans Regular" +THEME_DEFAULT_FONT = THEME_DEFAULT_FONT_NAME.replace(" ", "_") +THEME_DEFAULT_FONT_SIZE = 32 + +GRUB_DEFAULTS_PATH = "/etc/default/grub" +GRUB_SCRIPTS_PATH = "/etc/grub.d" +GRUB_CFG_PATH = f"{BOOT_GRUB_PATH}/grub.cfg" +GRUB_MKCONFIG_PATH = which("grub-mkconfig") or which("grub2-mkconfig") +if GRUB_MKCONFIG_PATH is None: + error("Could not find grub-mkconfig command file (grub2-mkconfig neither)") + + +THEME_TEMPLATE_PATH = f"{INSTALLER_DIR}/theme.txt.template" +GRUB_DEFAULTS_TEMPLATE_PATH = f"{INSTALLER_DIR}/grub.template" +HOOKCHECK_TEMPLATE_PATH = f"{INSTALLER_DIR}/hookcheck.py.template" + +THEME_OVERRIDES_TITLE = f"{THEME_NAME} Theme Overrides" +BEGIN_THEME_OVERRIDES = f"### BEGIN {THEME_OVERRIDES_TITLE}" +END_THEME_OVERRIDES = f"### END {THEME_OVERRIDES_TITLE}" + +ICON_SVG_PATHF = f"{INSTALLER_DIR}/icons/{{}}.svg" +ICON_PNG_PATHF = f"{INSTALLATION_SOURCE_DIR}/icons/{{}}.png" + +BACKGROUND_TMP_PATHF = f"{INSTALLER_DIR}/bg/{{}}.tmp" +BACKGROUND_PNG_PATHF = f"{INSTALLER_DIR}/bg/{{}}.png" + +CONFIG_FILE_PATH = f"{INSTALLER_DIR}/config.json" + +PALETTE = { + "red": "f44336", + "pink": "e91e63", + "purple": "9c27b0", + "deeppurple": "673ab7", + "indigo": "3f51b5", + "blue": "2196f3", + "lightblue": "03a9f4", + "cyan": "00bcd4", + "teal": "009688", + "green": "4caf50", + "lightgreen": "8bc34a", + "lime": "cddc39", + "yellow": "ffeb3b", + "amber": "ffc107", + "orange": "ff9800", + "deeporange": "ff5722", + "brown": "795548", + "grey": "9e9e9e", + "bluegrey": "607d8b", + "white": "ffffff", + "black": "000000", + # Custom default colors + "white-350": "9E9E9E", + "bluegrey-900": "263238", +} +AVAILABLE_COLORS = list(PALETTE.keys()) + +MDI_CDN = "https://raw.githubusercontent.com/Templarian/MaterialDesign-SVG/master/svg/" + +# Global user arguments set in main() +user_args: argparse.Namespace + +# Utils + +def check_python_version(): + installed = (sys.version_info.major, sys.version_info.minor) + required = MIN_PYTHON_VERSION + if installed < required: + error(f"Python {required[0]}.{required[1]} or later required") + + +def check_root_or_prompt(): + if os.geteuid() != 0: + info("Request root access") + exit_code = sh("sudo -v") + if exit_code != 0: + error("Could not verify root access, you could try with sudo") + # Relaunch the program with sudo + args = " ".join(sys.argv[1:]) + child_exit_code = sh(f"sudo {INSTALLER_DIR}/{INSTALLER_NAME} {args}") + exit(child_exit_code) # Propagate exit code + + +def delete_dir(directory): + if isdir(directory): + rmtree(directory) + + +def read_cleaned_grub_defaults(): + # Read previous defaults + with open(GRUB_DEFAULTS_PATH, "r", newline="") as f: + grub_defaults = f.read() + + # Remove previous theme defaults + cleaned_grub_defaults = re.sub( + f"\n*{BEGIN_THEME_OVERRIDES}.*{END_THEME_OVERRIDES}\n*", + "", + grub_defaults, + flags=re.DOTALL, + ) + return cleaned_grub_defaults + + +def read_cleaned_grub_mkconfig(): + # Read previous defaults + with open(GRUB_MKCONFIG_PATH, "r", newline="") as f: + grub_mkconfig = f.read() + + # Remove previous theme defaults + cleaned_grub_mkconfig = re.sub( + f"\n*{BEGIN_THEME_OVERRIDES}.*{END_THEME_OVERRIDES}\n*", + "", + grub_mkconfig, + flags=re.DOTALL, + ) + return cleaned_grub_mkconfig + + +def download_icon(icon_name): + info(f"Download {icon_name}.svg") + url = f"{MDI_CDN}{icon_name}.svg" + try: + with request.urlopen(url) as f: + response = f.read() + except HTTPError as err: # A subclass of URLError + error(f"Couldn't get icon {icon_name} ({err.reason})", f"At URL {err.geturl()}") + except URLError as err: + error(f"Couldn't get icon {icon_name} ({err.reason})") + svg_path = ICON_SVG_PATHF.format(icon_name) + with open(svg_path, "wb") as f: + f.write(response) + return svg_path + + +def download_background(background_path): + if not has_PIL: + error("PIL not detected, cannot download background") + info(f"Downloading background image") + + url = f"{background_path}" + try: + with request.urlopen(url) as f: + response = f.read() + except HTTPError as err: # A subclass of URLError + error(f"Couldn't get background image ({err.reason})", f"At URL {err.geturl()}") + except URLError as err: + error(f"Couldn't get background image ({err.reason})") + bg_path = BACKGROUND_TMP_PATHF.format('background_image') + conv_path = BACKGROUND_PNG_PATHF.format('background_image') + with open(bg_path, "wb") as f: + f.write(response) + im = Image.open(bg_path) + im.save(conv_path) + return conv_path + + + +def get_converted_icons(): + return [ + filename[:-4] # Remove .png + for filename in os.listdir(f"{INSTALLATION_SOURCE_DIR}/icons/") + if filename.endswith(".png") + ] + + +def is_icon_downloaded(icon_name): + svg_path = ICON_SVG_PATHF.format(icon_name) + return exists(svg_path) + + +def convert_icon_svg2png(icon_name, whisper=False): + if not has_command("inkscape"): + if not has_command("convert"): + error( + "Stop. Both `inkscape` and `convert` command from imagemagick were not found", + "Consider installing `inkscape` for the best results", + ) + else: + command = "convert" + else: + command = "inkscape" + + color = ( + parse_color(user_args.iconcolor) + if user_args.iconcolor + else parse_color(user_args.foreground) + ) + src_path = ICON_SVG_PATHF.format(icon_name) + dst_path = ICON_PNG_PATHF.format(icon_name) + + if command == "convert": + warning("Resulting icons could look a bit off, consider installing inkscape") + converter = magick_convert_svg2png + elif command == "inkscape": + converter = inkscape_convert_svg2png + + exit_code = converter(color, src_path, dst_path, whisper=whisper) + if exit_code != 0: + error(f"Stop. The `{command}` command returned an error") + + +def get_available_fonts(): + "Returns the fonts present in /fonts" + return [ + filename[:-4] # Remove .ttf + for filename in os.listdir(f"{INSTALLER_DIR}/fonts/") + if filename.endswith(".ttf") + ] + + +def parse_color(color_string): + if color_string in AVAILABLE_COLORS: + color = PALETTE[color_string] + elif re.match(r"[0-9A-Fa-f]{6}", color_string) is not None: + color = color_string + else: + error( + f"Invalid color parsed from {color_string}", + f"Color must be an hex code like C00FFE or one of: {AVAILABLE_COLORS}", + ) + return f"#{color}" + + +def check_icon_converted(icon): + available_icons = get_converted_icons() + if icon not in available_icons + ["_"]: + error(f"Invalid icon name: {icon}", f"Icons present are: {available_icons}") + return icon + + +def parse_font(font): + """From a given --font check if available and return its font name + e.g. Open_Sans_Regular to Open Sans Regular""" + available_fonts = get_available_fonts() + if font not in available_fonts: + error( + f"Invalid font name: {font}", f"Available font names: {available_fonts}", + ) + return font.replace("_", " ") + + +# Procedures + + +def clean_install_dir(): + info("Clean install directory") + if isdir(INSTALLATION_TARGET_DIR): + rmtree(INSTALLATION_TARGET_DIR) + + +def prepare_source_dir(): + info("Build theme from user preferences") + # Get user color preferences + highlight = parse_color(user_args.highlight) + foreground = parse_color(user_args.foreground) + background = parse_color( + THEME_DEFAULT_BACKGROUND + if user_args.background is None + else user_args.background + ) + image = ( + user_args.image + if user_args.downloadbackground is None + else download_background(user_args.downloadbackground) + ) + fontkey = user_args.font + fontfile = user_args.fontfile + fontname = user_args.fontname + fontsize = user_args.fontsize + icons = user_args.icons + + # Image checks + if image: + if not exists(image): + error(f"{image} does not exist") + if os.path.splitext(image)[1] not in (".png", ".jpg", ".jpeg", ".tga"): + error("Background image must be one of .png, .jpg, .jpeg or .tga formats.") + image_name = basename(image) + copyfile(image, f"{INSTALLATION_SOURCE_DIR}/{image_name}") + if user_args.background: + warning( + f"Both --background and --image arguments specified. Background color {background} will be ignored." + ) + else: + image_name = "background.png" + + # Icon checks + # Get entries from grub.cfg + entries = get_entry_names() + # Do icon count match grub entry count? + if len(icons) != len(entries): + error( + f"You must specify {len(entries)} icons ({len(icons)} provided) for entries:", + should_exit=False, + ) + for i, m in enumerate(entries): + print(f"{i + 1}. {m['entryname']}") + exit(1) + + # Font checks + # grub-mkfont present + grub_mkfont = which("grub-mkfont") or which("grub2-mkfont") + if grub_mkfont is None: + error(f"grub-mkfont command not found in your system (grub2-mkfont neither)") + # Valid font arguments + if fontfile is None: # User did not specify custom font file + fontfile = f"{INSTALLER_DIR}/fonts/{fontkey}.ttf" + fontname = f"{parse_font(fontkey)} {fontsize}" + elif not fontfile.endswith(".ttf"): # font file is not ttf + error(f"{fontfile} is not a .ttf file") + elif fontname is None: # User did, but did not gave its name + error( + "--fontname/-fn not specified for given font file.", + "e.g. 'Open Sans Regular'", + ) + else: # User specified a custom fontfile + fontname = " ".join(fontname) # e.g. Open Sans Regular + dst_fontfile = f"{INSTALLER_DIR}/fonts/{fontname.replace(' ', '_')}.ttf" # e.g. .../Open_Sans_Regular.ttf + copyfile(fontfile, dst_fontfile) + fontfile = dst_fontfile + fontname = f"{fontname} {fontsize}" # e.g. Open Sans Regular 32 + + # Prepare Icons + + # Download not-yet-downloaded icons + for icon in icons: + if not is_icon_downloaded(icon) and icon != "_": + download_icon(icon) + + # Convert icons + info("Convert icons") + for i, icon in enumerate(icons): + if icon != "_": + if i == 0: + convert_icon_svg2png(icon) + else: + convert_icon_svg2png(icon, whisper=True) + + # Prepare Font + + # Generate font file + info("Build font") + stdout = shout( + f"{grub_mkfont} -o {INSTALLATION_SOURCE_DIR}/font.pf2 {fontfile} -s {fontsize}" + ) + if stdout: + error( + f"{grub_mkfont} execution was not clean", f"for fontfile: {fontfile}", + ) + + # Prepare Theme.txt + + # Parse theme template with user preferences + with open(THEME_TEMPLATE_PATH, "r", newline="") as f: + template = f.read() + + context = { + "theme_name": THEME_NAME, + "highlight": highlight, + "foreground": foreground, + "background": background, + "image_name": image_name, + "fontname": fontname, + } + parsed_theme = template.format(**context) + + if image: + parsed_theme = parsed_theme.replace("# desktop-image", "desktop-image") + + theme_file_path = f"{INSTALLATION_SOURCE_DIR}/theme.txt" + with open(theme_file_path, "w") as f: + f.write(parsed_theme) + + +def prepare_target_dir(): + info("Prepare installation directory") + clean_install_dir() + + +def copy_source_to_target(): + info("Copy built theme to installation directory") + copytree(INSTALLATION_SOURCE_DIR, INSTALLATION_TARGET_DIR) + + +def update_grub_cfg(): + info("Update grub.cfg") + update_command = ( + which("update-grub") or which("grub-mkconfig") or which("grub2-mkconfig") + ) + if update_command is None: + error( + f"Command for generating grub.cfg not found (tried update-grub, grub-mkconfig and grub2-mkconfig)" + ) + command = f"{update_command} -o {GRUB_CFG_PATH}" + info(f"Remake grub.cfg with {command}") + sh(command) + + +def update_grub_defaults(): + info(f"Patch {GRUB_DEFAULTS_PATH} with {THEME_OVERRIDES_TITLE}") + grub_configs = read_cleaned_grub_defaults() + + # Parse grub defaults template, append parsed contents, and write back + + with open(GRUB_DEFAULTS_TEMPLATE_PATH, "r", newline="") as f: + template = f.read() + + context = {"installation_dir": INSTALLATION_TARGET_DIR} + parsed_extra_grub = template.format(**context) + grub_configs += ( + f"\n\n{BEGIN_THEME_OVERRIDES}\n{parsed_extra_grub}\n{END_THEME_OVERRIDES}\n\n" + ) + + with open(GRUB_DEFAULTS_PATH, "w") as f: + f.write(grub_configs) + + +def clean_grub_defaults(): + info(f"Clean {THEME_OVERRIDES_TITLE} from {GRUB_DEFAULTS_PATH}") + cleaned_grub_defaults = read_cleaned_grub_defaults() + with open(GRUB_DEFAULTS_PATH, "w") as f: + f.write(cleaned_grub_defaults) + + +def clean_grub_mkconfig(): + info(f"Clean {THEME_OVERRIDES_TITLE} from {GRUB_MKCONFIG_PATH}") + cleaned_grub_mkconfig = read_cleaned_grub_mkconfig() + with open(GRUB_MKCONFIG_PATH, "w") as f: + f.write(cleaned_grub_mkconfig) + + +def clean_hookcheck(): + info(f"Remove hookcheck script from {GRUB_SCRIPTS_PATH}") + hookcheck = f"{GRUB_SCRIPTS_PATH}/99_matter" + if exists(hookcheck): + os.remove(hookcheck) + + +def get_entry_names(): + "Gets the entry names from grub.cfg contents" + with open(GRUB_CFG_PATH, "r", newline="") as f: + grub_cfg = f.read() + pattern = ( + r"(?P(?:submenu|menuentry) ?)" # menuentry or submenu + r"(?:\"|')" # " or ' + r"(?P[^\"']*)" # capture the entry name (without quotes) + r"(?:\"|')" # " or ' + r"(?P[^\{]*\{)" # The rest of the entry header until a { is found + ) + matchiter = re.finditer(pattern, grub_cfg) + matches = list(matchiter) + return matches + + +# Main procedures + + +def do_preinstall_hint(): + info( + f"{color_string('[ ', fg='brightwhite')}" + f"{color_string(THEME_NAME, fg='brightmagenta')} " + f"{color_string('Grub Theme'.upper(), fg='lightcyan')}" + f"{color_string(' ]', fg='brightwhite')}" + ) + info("Argument -i required. Which icons go to which grub entries?") + info("Your grub entries are:") + do_list_grub_cfg_entries() + info("Look for icons you like at https://materialdesignicons.com/") + info("Then install with:") + info("./matter.py -i icon-for-entry-1 icon-for-entry-2 ...") + info("Example (with 8 entries, _ means ignore):") + info("./matter.py -i ubuntu microsoft-windows folder _ _ _ _ cog") + + +def do_test(): + info("Begin grub2-theme-preview") + warning( + "Argument --icons/-i does not have effect when testing", + "The icon names used are coming from your system's current grub.cfg", + "This is a feature that may work in the future", + ) + if not has_command("grub2-theme-preview"): + error( + "You need grub2-theme-preview for testing", + "See https://github.com/hartwork/grub2-theme-preview", + ) + sh(f"grub2-theme-preview {INSTALLATION_SOURCE_DIR}") + + +def do_install(): + info(f"Begin {THEME_NAME} install") + prepare_source_dir() + check_root_or_prompt() + prepare_target_dir() + copy_source_to_target() + update_grub_defaults() + do_set_icons(patch_grubcfg=True) + install_hookcheck() + update_grub_cfg() + info(f"{THEME_NAME} successfully installed") + + +def do_uninstall(): + info(f"Begin {THEME_NAME} uninstall") + check_root_or_prompt() + clean_grub_defaults() + clean_grub_mkconfig() + clean_hookcheck() + clean_install_dir() + update_grub_cfg() + info(f"{THEME_NAME} successfully uninstalled") + + +def do_list_grub_cfg_entries(): + # Read current grub cfg + with open(GRUB_CFG_PATH, "r", newline="") as f: + grub_cfg = f.read() + + entries = get_entry_names() + + for i, m in enumerate(entries): + print(f"{i + 1}. {m['entryname']}") + + +def create_config_file(): + icons = user_args.icons + # Read current grub cfg + entries = get_entry_names() + + entries_to_icons = {} + for icon, entry in zip(icons, entries): + entryname = entry.group("entryname") + if entryname in entries_to_icons: + warning(f"Duplicate entry '{entryname}'. Unexpected behaviour may occur. Consider changing names using Grub Customizer.") + entries_to_icons[entryname] = icon + + config = {"icons": entries_to_icons} + + with open(CONFIG_FILE_PATH, 'w') as f: + f.write(json.dumps(config)) + + +def patch_from_config_file(): + # Read current grub cfg + current_entries = get_entry_names() + + with open(CONFIG_FILE_PATH) as f: + config = json.loads(f.read()) + + entries_to_icons = config["icons"] + + icons = [] + for entry in current_entries: + entryname = entry.group("entryname") + if entryname in entries_to_icons: + icons.append(entries_to_icons[entryname]) + else: + warning( + f"{entryname} is a new grub menu entry, no icon will be set for it. " + f"Rerun matter.py to set icons" + ) + icons.append("_") + + do_patch_grub_cfg_icons(icons) + + +def do_patch_grub_cfg_icons(icons): + + info(f"Begin {GRUB_CFG_PATH} patch") + with open(GRUB_CFG_PATH, "r", newline="") as f: + grub_cfg = f.read() + # Read current grub cfg + entries = get_entry_names() + + # Build new grub cfg with given icons + new_grub_cfg = "" + next_seek = 0 + for m, i in zip(entries, icons): + mstart, mend = m.span() + new_grub_cfg += grub_cfg[next_seek:mstart] + icon_class = f" --class {i} " if i != "_" else "" + new_grub_cfg += f'{m["head"]}"{m["entryname"]}"{icon_class}{m["tail"]}' + next_seek = mend + new_grub_cfg += grub_cfg[mend:] + + # Write new grub cfg back + check_root_or_prompt() + with open(GRUB_CFG_PATH, "w") as f: + f.write(new_grub_cfg) + + info(f"{len(icons)} icons successfully patched onto {GRUB_CFG_PATH}") + + +def do_set_icons(patch_grubcfg): + + icons = user_args.icons + + if icons is None: + error("Stop. Unspecified icons (--icons/-i argument)") + icons = [check_icon_converted(i) for i in icons] + + # Read current grub cfg + entries = get_entry_names() + if len(icons) != len(entries): + error( + f"You must specify {len(entries)} " + f"icons ({len(icons)} provided) for entries:", + should_exit=False, + ) + for i, m in enumerate(entries): + print(f"{i + 1}. {m['entryname']}") + # NOTE: We exit with 0 here to not stop the apt upgrade process + # eventually it will be solved with an autoremove + exit(0) + + do_patch_grub_cfg_icons(user_args.icons) + + if patch_grubcfg: + create_config_file() + + # Patch grub-mkconfig so everytime it executes, it patches grub.cfg + info(f"Begin {GRUB_MKCONFIG_PATH} patch") + info(f"Clean old {GRUB_MKCONFIG_PATH} patch if any") + + # cmd_icons = " ".join(user_args.icons) + # seticons_call = f"{INSTALLER_DIR}/{INSTALLER_NAME} -so -i {cmd_icons} >&2" + seticons_call = f"{INSTALLER_DIR}/{INSTALLER_NAME} --configicons >&2" + new_grub_mkconfig = read_cleaned_grub_mkconfig() + + # grub-mkconfig is called on upgrade, and on failure it halts. + # A failure on our part should not halt an upgrade, let's temporarily + # disable the stop-on-error functionality with set +e. See #67 + new_grub_mkconfig += ( + f"\n\n{BEGIN_THEME_OVERRIDES}\n" + f"set +e\n" + f"{seticons_call}\n" + f"set -e\n" + f"{END_THEME_OVERRIDES}\n\n" + ) + + check_root_or_prompt() + with open(GRUB_MKCONFIG_PATH, "w") as f: + f.write(new_grub_mkconfig) + + info( + f"{GRUB_MKCONFIG_PATH} successfully patched, icons will now persist between grub updates." + ) + + +def install_hookcheck(): + info(f"Create hook check script") + with open(HOOKCHECK_TEMPLATE_PATH, "r", newline="") as f: + template = f.read() + + cmd_icons = " ".join(user_args.icons) + # seticons_call = f"{INSTALLER_DIR}/{INSTALLER_NAME} -so -i {cmd_icons} >&2" + seticons_call = f"{INSTALLER_DIR}/{INSTALLER_NAME} --configicons" + + context = { + "GRUB_MKCONFIG_PATH": GRUB_MKCONFIG_PATH, + "THEME_NAME": THEME_NAME, + "THEME_OVERRIDES_TITLE": THEME_OVERRIDES_TITLE, + "BEGIN_THEME_OVERRIDES": BEGIN_THEME_OVERRIDES, + "END_THEME_OVERRIDES": END_THEME_OVERRIDES, + "SETICONS_CALL": seticons_call, + } + + parsed_script = template.format(**context) + script_file_path = f"{GRUB_SCRIPTS_PATH}/99_matter" + + with open(script_file_path, "w") as f: + f.write(parsed_script) + + # Make it executable by user, group and others + st = os.stat(script_file_path) + os.chmod(script_file_path, st.st_mode | 0o111) + + +# Script arguments + + +def parse_args(): + parser = ArgumentParser( + description=THEME_DESCRIPTION, + epilog=f"[Available colors] are: {', '.join(AVAILABLE_COLORS)}.\n" + "You can specify your own hex colors as well (e.g. C0FFEE, FF00FF, etc).\n" + f"[Available fonts] are: {', '.join(get_available_fonts())}\n" + "You can always specify your own with the -ff argument\n" + f"[Available icons] can be found at https://materialdesignicons.com/\n" + "For requests open an issue on:\n" + "https://github.com/mateosss/matter/issues", + formatter_class=RawTextHelpFormatter, + ) + parser.add_argument( + "--listentries", "-l", action="store_true", help=f"list grub entries", + ) + parser.add_argument( + "--buildonly", + "-b", + action="store_true", + help=f"prepare the theme but do not install it", + ) + parser.add_argument( + "--test", + "-t", + action="store_true", + help=f"test the generated theme with grub2-theme-preview", + ) + parser.add_argument( + "--icons", + "-i", + type=str, + nargs="*", + help=f"specify icons for each grub entry listed with -l", + ) + parser.add_argument( + "--seticons", + "-si", + action="store_true", + help=f"set grub entries icons given by -i and patch grub-mkconfig for persistence", + ) + parser.add_argument( + "--seticons_once", + "-so", + action="store_true", + help=f"set grub entries icons given by -i, will be reverted on next grub update", + ) + parser.add_argument( + "--uninstall", "-u", action="store_true", help=f"uninstall {THEME_NAME}", + ) + parser.add_argument( + "--highlight", + "-hl", + type=str, + help=f"selected text color", + default=THEME_DEFAULT_HIGHLIGHT, + ) + parser.add_argument( + "--foreground", + "-fg", + type=str, + help=f"main text color", + default=THEME_DEFAULT_FOREGROUND, + ) + parser.add_argument( + "--background", + "-bg", + type=str, + help=f"solid background color", + default=None, + # default will be set to THEME_DEFAULT_BACKGROUND + ) + parser.add_argument( + "--image", + "-im", + type=str, + help=f"image file to use as background, supported extensions: PNG, JPG, JPEG, TGA", + ) + parser.add_argument( + "--iconcolor", + "-ic", + type=str, + help=f"icons fill color, by default same as foreground", + ) + parser.add_argument( + "--font", + "-f", + type=str, + help=f"theme font from already downloaded fonts", + default=THEME_DEFAULT_FONT, + choices=get_available_fonts(), + ) + parser.add_argument( + "--fontfile", "-ff", type=str, help=f"import theme font from custom .ttf file" + ) + parser.add_argument( + "--fontname", + "-fn", + type=str, + nargs="*", + help=f"specify the font name for the given font file", + ) + parser.add_argument( + "--fontsize", + "-fs", + type=int, + help=f"theme font size", + default=THEME_DEFAULT_FONT_SIZE, + ) + parser.add_argument( + "--configicons", + "-ci", + action="store_true", + help="set grub entries icons using config file. " + ) + parser.add_argument( + "--downloadbackground", + "-dlbg", + type=str, + help=f"download the background image from the given url", + ) + return parser.parse_args() + + +if __name__ == "__main__": + try: + check_python_version() + user_args = parse_args() + + if user_args.listentries: + do_list_grub_cfg_entries() + elif user_args.buildonly: + prepare_source_dir() + elif user_args.seticons_once: + do_set_icons(patch_grubcfg=False) + elif user_args.seticons: + do_set_icons(patch_grubcfg=True) + elif user_args.uninstall: + do_uninstall() + elif user_args.configicons: + patch_from_config_file() + elif user_args.icons is None: + do_preinstall_hint() + else: + do_install() + + if user_args.test: + do_test() + except KeyboardInterrupt: + error("Stop. Script halted by user") + sys.exit(1) diff --git a/matter/svg2png.py b/matter/svg2png.py new file mode 100755 index 0000000..1a94fb2 --- /dev/null +++ b/matter/svg2png.py @@ -0,0 +1,117 @@ +#!/usr/bin/env python3 + +import os +import re +import xml.etree.ElementTree as ET +import xml.dom.minidom + +# Local Matter modules +from utils import sh, shout, error + + +def inkscape_convert_svg2png(color, src_path, dst_path, whisper=False): + # SVG_URI = "http://www.w3.org/2000/svg" + FRAC = 0.6 + TEMPFILE = "temp.svg" + + def parse_with_map(source): + """Parses file, returns a tuple containing the parsed ElementTree and a namespace map (dict). + + The ElementTree object returned is the same as if parsed using xml.etree.ElementTree.parse. For + some reason, ElementTree objects by the xml package will not provide a namespace map, unlike the + lxml package. + """ + + root = None + ns_map = [] + for event, node in ET.iterparse(source, events=["start-ns", "start"]): + if event == "start-ns": + ns_map.append(node) + elif event == "start": + if root is None: + root = node + return (ET.ElementTree(root), dict(ns_map)) + + def int_ignore_units(s): + return int("".join(ch for ch in s if ch.isdigit())) + + def prettify(xml_string): + return "\n".join( + line + for line in xml.dom.minidom.parseString(xml_string) + .toprettyxml(indent=" ") + .splitlines() + if not line.isspace() and line != "" + ) + + # Fixes undefined namespace tags in output xml (not a big issue) + dom, ns_map = parse_with_map(src_path) + for key, value in ns_map.items(): + ET.register_namespace(key, value) + + root = dom.getroot() + _, _, width, height = map(int, filter(bool, re.split(r'[ ,]', root.attrib["viewBox"]))) + width_gap, height_gap = (1 - FRAC) * width / 2, (1 - FRAC) * height / 2 + + # Group all elements that are children of while changing their 'style' attributes + elements = list(root) + group = ET.SubElement(root, "g") + for element in elements: + # Don't group these special tags + if any(map(element.tag.endswith, ["defs", "metadata"])): + continue + root.remove(element) + # Changes all decendents (.iter will also include itself) + for child in element.iter(): + if "style" in child.attrib: + child.attrib["style"] = re.sub( + r"(?<=fill:)\S+?(?=;)", color, child.attrib["style"] + ) + else: + child.attrib["style"] = f"fill:{color};" + group.append(element) + # Shrink the svg by a factor of FRAC for padding around icon + group.attrib["transform"] = f"matrix({FRAC},0,0,{FRAC},{width_gap},{height_gap})" + + xml_string = ET.tostring(root).decode() + xml_string = prettify(xml_string) + with open(TEMPFILE, "w") as f: + f.write(xml_string) + + # Check inkscape version + version_string = shout("inkscape --version 2>/dev/null", silence=whisper) + inkscape_major = re.search(r"(\d+)\.\d+(\.\d+)?", version_string).group(1) + command = "inkscape " + if inkscape_major == "1": + command += f"--export-filename={dst_path} " + elif inkscape_major == "0": + command += f"--without-gui --export-png={dst_path} " + else: + error("Unsupported inkscape version") + command += f"-w 72 {TEMPFILE}" + if whisper: + command += " 2>&1 | tail -1" + exit_code = sh(command) + + os.remove(TEMPFILE) + return exit_code + + +def magick_convert_svg2png(color, src_path, dst_path, whisper=None): + cmd = ( + r"convert -trim -scale 36x36 -extent 72x72 -gravity center " + r"-define png:color-type=6 -background none -colorspace sRGB -channel RGB " + rf"-threshold -1 -density 300 -fill \{color} +opaque none " + rf"{src_path} {dst_path}" + ) + return os.system(cmd) + + +# For demostration purposes +if __name__ == "__main__": + svg2png = inkscape_convert_svg2png + # svg2png = magick_convert_svg2png + for file in os.listdir("./icons"): + basename, ext = os.path.splitext(file) + if ext == ".svg": + svg2png("#FFFFFF", f"icons/{basename}.svg", f"icons/{basename}.png") diff --git a/matter/theme.txt.template b/matter/theme.txt.template new file mode 100644 index 0000000..28c0c70 --- /dev/null +++ b/matter/theme.txt.template @@ -0,0 +1,48 @@ +# If this file is called theme.txt then the theme template has been +# already parsed and the comments below could not make too much sense. + +# theme.txt.template represents a python string that gets format()-ed +# Note: for escaping literal curly braces, double them like so: {{ or }} + +# {theme_name} Theme File +# Designed for any resolution + +# Global Property +title-text: "" +# desktop-image: "{image_name}" +desktop-color: "{background}" +terminal-font: "Unifont Regular 16" # A smaller font for the console +terminal-box: "terminal_box_*.png" +terminal-left: "0" +terminal-top: "0" +terminal-width: "100%" +terminal-height: "100%" +terminal-border: "0" + +# Show the boot menu ++ boot_menu {{ + left = 36% + top = 29% + width = 28% + height = 60% + item_font = "{fontname}" + item_color = "{foreground}" + selected_item_color = "{highlight}" + icon_width = 72 + icon_height = 72 + item_height = 72 + item_spacing = 36 + selected_item_pixmap_style = "select_*.png" +}} + +# Show a countdown message using the label component ++ label {{ + top = 82% + left = 35% + width = 30% + align = "center" + id = "__timeout__" + text = "Booting in %d seconds" + color = "{foreground}" + font = "{fontname}" +}} diff --git a/matter/utils.py b/matter/utils.py new file mode 100755 index 0000000..024dee2 --- /dev/null +++ b/matter/utils.py @@ -0,0 +1,61 @@ +#!/usr/bin/env python3 + +from subprocess import run, PIPE +from shutil import which + +# Logging utils + +def color_string(string, fg=None): + COLORS = { # List some colors that may be needed + "red": "\033[31m", + "pink": "\033[38;5;206m", + "green": "\033[32m", + "orange": "\033[33m", + "blue": "\033[34m", + "cyan": "\033[36m", + "lightred": "\033[91m", + "lightgreen": "\033[92m", + "yellow": "\033[93m", + "lightblue": "\033[94m", + "lightcyan": "\033[96m", + "brightwhite": "\u001b[37;1m", + "brightmagenta": "\u001b[35;1m", + } + endcolor = "\033[0m" + return f"{COLORS.get(fg, '')}{string}{endcolor}" + + +def info(*lines): + for line in lines: + print(f"{color_string('[I] ', fg='cyan')}{line}") + + +def error(*lines, should_exit=True): + for line in lines: + print(f"{color_string('[E] ', fg='lightred')}{line}") + if should_exit: + exit(1) + +def warning(*lines): + for line in lines: + print(f"{color_string('[W] ', fg='yellow')}{line}") + + +# Shell / external utils + + +def sh(command): + "Executes command in shell and returns its exit status" + return run(command, shell=True).returncode + + +def shout(command, silence=False): + "Executes command in shell and returns its stdout" + stdout = run(command, shell=True, stdout=PIPE).stdout.decode("utf-8") + if not silence: + print(stdout) + return stdout + + +def has_command(command): + return which(command) is not None