ly/res/config.ini
OkayishComputer 93ad4e1c46 Update res/config.ini
Re-organized options to keep related settings together, rephrased some of the color comments to make the color behavior clearer to new users, added headings to sections, added diagram of main box
2025-12-19 21:26:34 -06:00

409 lines
No EOL
12 KiB
INI

### APPEARANCE ###
# Use full 24-bit RGB color (true) or indexed 8-color mode (false)
full_color = true
# If full_color is true, each color assigned in this config should be a 32-bit value (24-bit RGB + 8-bit styling).
# The format is 0xSSRRGGBB, where SS is the styling, RR is red, GG is green, and BB is blue.
# Each color component (RR, GG, BB) is a hexadecimal value from 00 to FF. (0-255)
# Here are the possible styling options:
# TB_BOLD 0x01RRGGBB
# TB_UNDERLINE 0x02RRGGBB
# TB_REVERSE 0x04RRGGBB
# TB_ITALIC 0x08RRGGBB
# TB_BLINK 0x10RRGGBB
# TB_HI_BLACK 0x20RRGGBB
# TB_BRIGHT 0x40RRGGBB
# TB_DIM 0x80RRGGBB
# Note that, if you want to use the default color value of the terminal, you can use the
# special value 0x00000000. This means that, if you want to use black, you *must* use
# the styling option TB_HI_BLACK (the RGB values are ignored when using this option).
# If full_color is false, output will be in indxed 8-color mode.
# In this mode, each color assigned in this config should use the following format:
# 0xSS0C, where SS is styling, and C is an integer from 0-8.
# All eight eight-color color codes:
# TB_DEFAULT 0xSS00
# TB_BLACK 0xSS01
# TB_RED 0xSS02
# TB_GREEN 0xSS03
# TB_YELLOW 0xSS04
# TB_BLUE 0xSS05
# TB_MAGENTA 0xSS06
# TB_CYAN 0xSS07
# TB_WHITE 0xSS08
# the styling options are the same as in full_color mode.
# NOTE: 256-color .dur files will ONLY be displayed if full_color is true.
# Background color id
# 8-color:
# 0x0000
bg = 0x00000000
# Border foreground color id
# 0x0108
border_fg = 0x00FFFFFF
# Error background color id
# 0x0000
error_bg = 0x00000000
# Error foreground color id
# 0x0102
error_fg = 0x01FF0000
# Foreground color id
# 0x0108
fg = 0x00FFFFFF
# The character used to mask the password
# You can either type it directly as a UTF-8 character (like *), or use a UTF-32
# codepoint (for example 0x2022 for a bullet point)
# If null, the password will be hidden
# Note: you can use a # by escaping it like so: \#
asterisk = *
# Identifier for battery whose charge to display at top left
# Primary battery is usually BAT0 or BAT1
# If set to null, battery status won't be shown
battery_id = null
# Blank main box background
# Setting to false will make it transparent
blank_box = true
# Title to show at the top of the main box
# If set to null, none will be shown
box_title = null
# Set margin to the edges of the DM (useful for curved monitors)
edge_margin = 0
# Remove main box borders
hide_borders = false
# Remove power management command hints
hide_key_hints = false
# Remove keyboard lock states from the top right corner
hide_keyboard_locks = false
# Remove version number from the top left corner
hide_version_string = false
# Initial text to show on the info line
# If set to null, the info line defaults to the hostname
initial_info_text = null
# Input boxes length
input_len = 34
# Main box horizontal margin
margin_box_h = 2
# Main box vertical margin
margin_box_v = 1
# Center the session name.
text_in_center = false
# Here is a diagram of the main box layout:
# ┌Title─────────────────────────┐
# │ │
# │ < Info > │
# │ │
# │ environment < session > │
# │ │
# │ login < username > │
# │ │
# │ password ****** │
# │ │
# └──────────────────────────────┘
# CLOCK #
# Change the state and language of the big clock
# none -> Disabled (default)
# en -> English
# fa -> Farsi
bigclock = none
# Set bigclock to 12-hour notation.
bigclock_12hr = false
# Set bigclock to show the seconds.
bigclock_seconds = false
# Format string for clock in top right corner (see strftime specification). Example: %c
# If null, the clock won't be shown
clock = null
#####################################################################################
### ANIMATION ###
# The active animation
# none -> Nothing
# doom -> PSX DOOM fire
# matrix -> CMatrix
# colormix -> Color mixing shader
# gameoflife -> John Conway's Game of Life
# dur_file -> .dur file format (https://github.com/cmang/durdraw/tree/master)
animation = none
# Stop the animation after some time
# 0 -> Run forever
# 1..2e12 -> Stop the animation after this many seconds
animation_timeout_sec = 0
# PSX DOOM FIRE #
# DOOM animation fire height (1 thru 9)
doom_fire_height = 6
# DOOM animation fire spread (0 thru 4)
doom_fire_spread = 2
# DOOM animation custom top color (low intensity flames)
doom_top_color = 0x009F2707
# DOOM animation custom middle color (medium intensity flames)
doom_middle_color = 0x00C78F17
# DOOM animation custom bottom color (high intensity flames)
doom_bottom_color = 0x00FFFFFF
# DUR ART #
# Dur file path
dur_file_path = /etc/ly/example.dur
# Dur offset x direction
dur_x_offset = 0
# Dur offset y direction
dur_y_offset = 0
# CONWAY'S GAME OF LIFE #
# Game of Life entropy interval (0 = disabled, >0 = add entropy every N generations)
# 0 -> Pure Conway's Game of Life (will eventually stabilize)
# 10 -> Add entropy every 10 generations (recommended for continuous activity)
# 50+ -> Less frequent entropy for more natural evolution
gameoflife_entropy_interval = 10
# Game of Life animation foreground color id
gameoflife_fg = 0x0000FF00
# Game of Life frame delay (lower = faster animation, higher = slower)
# 1-3 -> Very fast animation
# 6 -> Default smooth animation speed
# 10+ -> Slower, more contemplative speed
gameoflife_frame_delay = 6
# Game of Life initial cell density (0.0 to 1.0)
# 0.1 -> Sparse, minimal activity
# 0.4 -> Balanced activity (recommended)
# 0.7+ -> Dense, chaotic patterns
gameoflife_initial_density = 0.4
# CMATRIX #
# CMatrix animation foreground color id
cmatrix_fg = 0x0000FF00
# CMatrix animation character string head color id
cmatrix_head_col = 0x01FFFFFF
# CMatrix animation minimum codepoint. It uses a 16-bit integer
# For Japanese characters for example, you can use 0x3000 here
cmatrix_min_codepoint = 0x21
# CMatrix animation maximum codepoint. It uses a 16-bit integer
# For Japanese characters for example, you can use 0x30FF here
cmatrix_max_codepoint = 0x7B
# Color mixing animation first color id
colormix_col1 = 0x00FF0000
# Color mixing animation second color id
colormix_col2 = 0x000000FF
# Color mixing animation third color id
colormix_col3 = 0x20000000
##########################################################################
### PATHS AND BEHAVIOR ###
# Allow empty password or not when authenticating
allow_empty_password = true
# Erase password input on failure
clear_password = false
# Input box active by default on startup
# Available inputs: info_line, session, login, password
default_input = login
# The number of failed authentications before a special animation is played... ;)
# If set to 0, the animation will never be played
auth_fails = 10
# Automatic login configuration
# This feature allows Ly to automatically log in a user without password prompt.
# IMPORTANT: Both auto_login_user and auto_login_session must be set for this to work.
# Autologin only happens once at startup - it won't re-trigger after logout.
# PAM service name to use for automatic login
# The default service (ly-autologin) uses pam_permit to allow login without password
# The appropriate platform-specific PAM configuration (ly-autologin) will be used automatically
auto_login_service = ly-autologin
# Session name to launch automatically
# To find available session names, check the .desktop files in:
# - /usr/share/xsessions/ (for X11 sessions)
# - /usr/share/wayland-sessions/ (for Wayland sessions)
# Use the filename without .desktop extension, or the value of DesktopNames field
# Examples: "i3", "sway", "gnome", "plasma", "xfce"
# If null, automatic login is disabled
auto_login_session = null
# Username to automatically log in
# Must be a valid user on the system
# If null, automatic login is disabled
auto_login_user = null
# Brightness decrease command
brightness_down_cmd = /usr/bin/brightnessctl -q -n s 10%-
# Brightness decrease key, or null to disable
brightness_down_key = F5
# Brightness increase command
brightness_up_cmd = /usr/bin/brightnessctl -q -n s +10%
# Brightness increase key, or null to disable
brightness_up_key = F6
# Custom sessions directory
# You can specify multiple directories,
# e.g. /etc/ly/custom-sessions:/usr/share/custom-sessions
custom_sessions = /etc/ly/custom-sessions
# Command executed when pressing hibernate key (can be null)
hibernate_cmd = null
# Specifies the key used for hibernate (F1-F12)
hibernate_key = F4
# Command executed when no input is detected for a certain time
# If null, no command will be executed
inactivity_cmd = null
# Executes a command after a certain amount of seconds
inactivity_delay = 0
# Active language
# Available languages are found in /etc/ly/lang/
lang = en
# Command executed when logging in
# If null, no command will be executed
# Important: the code itself must end with `exec "$@"` in order to launch the session!
# You can also set environment variables in there, they'll persist until logout
login_cmd = null
# Path for login.defs file (used for listing all local users on the system on
# Linux)
login_defs_path = /etc/login.defs
# Command executed when logging out
# If null, no command will be executed
# Important: the session will already be terminated when this command is executed, so
# no need to add `exec "$@"` at the end
logout_cmd = null
# General log file path
ly_log = /var/log/ly.log
# Event timeout in milliseconds
min_refresh_delta = 5
# Set numlock on/off at startup
numlock = false
# Default path
# If null, ly doesn't set a path
path = /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
# Command executed when pressing restart_key
restart_cmd = /sbin/shutdown -r now
# Specifies the key used for restart (F1-F12)
restart_key = F2
# Save the current desktop and login as defaults, and load them on startup
save = true
# Service name (set to ly to use the provided pam config file)
service_name = ly
# Session log file path
# This will contain stdout and stderr of Wayland sessions
# By default it's saved in the user's home directory
# Important: due to technical limitations, X11 and shell sessions aren't supported, which
# means you won't get any logs from those sessions.
# If null, no session log will be created
session_log = .local/state/ly-session.log
# Setup command
setup_cmd = /etc/ly/setup.sh
# Command executed when pressing shutdown_key
shutdown_cmd = /sbin/shutdown -a now
# Specifies the key used for shutdown (F1-F12)
shutdown_key = F1
# Command executed when pressing sleep key (can be null)
sleep_cmd = null
# Specifies the key used for sleep (F1-F12)
sleep_key = F3
# Command executed when starting Ly (before the TTY is taken control of)
# If null, no command will be executed
start_cmd = null
# Default vi mode
# normal -> normal mode
# insert -> insert mode
vi_default_mode = normal
# Enable vi keybindings
vi_mode = false
# Wayland desktop environments
# You can specify multiple directories,
# e.g. /usr/share/wayland-sessions:/usr/local/share/wayland-sessions
waylandsessions = /usr/share/wayland-sessions
# Xorg server command
x_cmd = /usr/bin/X
# Xorg xauthority edition tool
xauth_cmd = /usr/bin/xauth
# xinitrc
# If null, the xinitrc session will be hidden
xinitrc = ~/.xinitrc
# Xorg desktop environments
# You can specify multiple directories,
# e.g. /usr/share/xsessions:/usr/local/share/xsessions
xsessions = /usr/share/xsessions