mirrors/ly
1
0
Fork 0
mirror of https://github.com/fairyglade/ly.git synced 2025-12-21 03:34:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #399 from Cavernosa/patch-1

Browse Source 
Organized config.ini and readme.md
This commit is contained in:
ShiningLea
2022-07-24 15:25:57 +02:00
committed by GitHub
parent 3556e39374 4e24154cac
commit 0a798831fe
2 changed files with 86 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
readme.md
View File

@@ -20,6 +20,8 @@ On Debian-based distros running `apt install build-essential libpam0g-dev libxcb
## Support ## Support
The following desktop environments were tested with success The following desktop environments were tested with success
- awesome
- bspwm - bspwm
- budgie - budgie
- cinnamon - cinnamon
@@ -32,14 +34,14 @@ The following desktop environments were tested with success
- lxde - lxde
- lxqt - lxqt
- mate - mate
- maxx
- pantheon
- qtile - qtile
- spectrwm
- sway - sway
- windowmaker
- xfce - xfce
- xmonad - xmonad
- pantheon
- maxx
- windowmaker
- spectrwm
Ly should work with any X desktop environment, and provides Ly should work with any X desktop environment, and provides
basic wayland support (sway works very well, for example). basic wayland support (sway works very well, for example).
@@ -53,45 +55,45 @@ changing the source code won't be necessary :)
## Cloning and Compiling ## Cloning and Compiling
Clone the repository Clone the repository
``` ```
git clone --recurse-submodules https://github.com/nullgemm/ly $ git clone --recurse-submodules https://github.com/nullgemm/ly
``` ```
Change the directory to ly Change the directory to ly
``` ```
cd ly $ cd ly
``` ```
Compile Compile
``` ```
make $ make
``` ```
Test in the configured tty (tty2 by default) Test in the configured tty (tty2 by default)
or a terminal emulator (but desktop environments won't start) or a terminal emulator (but desktop environments won't start)
``` ```
sudo make run # make run
``` ```
Install Ly and the provided systemd service file Install Ly and the provided systemd service file
``` ```
sudo make install # make install
``` ```
Enable the service Enable the service
``` ```
sudo systemctl enable ly.service # systemctl enable ly.service
``` ```
If you need to switch between ttys after Ly's start you also have to If you need to switch between ttys after Ly's start you also have to
disable getty on Ly's tty to prevent "login" from spawning on top of it disable getty on Ly's tty to prevent "login" from spawning on top of it
``` ```
sudo systemctl disable getty@tty2.service # systemctl disable getty@tty2.service
``` ```
## Arch Linux Installation ## Arch Linux Installation
From [AUR](https://aur.archlinux.org/packages/ly): From [AUR](https://aur.archlinux.org/packages/ly):
``` ```
yay -S ly # yay -S ly
``` ```
## Configuration ## Configuration
@@ -106,12 +108,10 @@ while on the desktop field (above the login field).
## .xinitrc ## .xinitrc
If your .xinitrc doesn't work make sure it is executable and includes a shebang. If your .xinitrc doesn't work make sure it is executable and includes a shebang.
This file is supposed to be a shell script! Quoting from xinit's man page: This file is supposed to be a shell script! Quoting from xinit's man page:
```
If no specific client program is given on the command line, xinit will look for > If no specific client program is given on the command line, xinit will look for a file in the user's home directory called .xinitrc to run as a shell script to start up client programs.
a file in the user's home directory called .xinitrc to run as a shell script to
start up client programs. On Arch Linux, the example .xinitrc (/etc/X11/xinit/xinitrc) starts like this:
```
On ArchLinux, the example .xinitrc (/etc/X11/xinit/xinitrc) starts like this:
``` ```
#!/bin/sh #!/bin/sh
``` ```

132
res/config.ini
View File

@@ -1,113 +1,117 @@
# animation enabled # Animation enabled/disabled
#animate = false #animate = false
#animate = true
# the active animation # The active animation
# 0 -> PSX DOOM fire (default) # 0 -> PSX DOOM fire (default)
# 1 -> CMatrix # 1 -> CMatrix
#animation = 0 #animation = 0
# the char used to mask the password
#asterisk = *
#asterisk = o
# background color id # The character used to mask the password
#asterisk = *
# Erase password input on failure
#blank_password = false
# Background color id
#bg = 0 #bg = 0
# blank main box # Foreground color id
#blank_box = true
# erase password input on failure
#blank_password = false
#blank_password = true
# console path
#console_dev = /dev/console
# input active by default on startup
#default_input = 2
# foreground color id
#fg = 9 #fg = 9
# remove main box borders # Blank main box background
# Setting to false will make it transparent
#blank_box = true
# Remove main box borders
#hide_borders = false #hide_borders = false
#hide_borders = true
# remove f1 commands # Main box margins
#hide_f1_commands = false
#hide_f1_commands = true
# number of visible chars on an input
#input_len = 34
# active language
#lang = en
#lang = fr
# load the saved desktop and login
#load = true
# main box margins
#margin_box_h = 2 #margin_box_h = 2
#margin_box_v = 1 #margin_box_v = 1
# total input sizes # Input boxes length
#input_len = 34
# Max input sizes
#max_desktop_len = 100 #max_desktop_len = 100
#max_login_len = 255 #max_login_len = 255
#max_password_len = 255 #max_password_len = 255
# cookie generator
#mcookie_cmd = /usr/bin/mcookie
# event timeout in milliseconds # Input box active by default on startup
#min_refresh_delta = 5 #default_input = 2
# default path # Load the saved desktop and username
#path = /sbin:/bin:/usr/local/sbin:/usr/local/bin:/usr/bin:/usr/sbin #load = true
# command executed when pressing F2 # Save the current desktop and login as defaults
#restart_cmd = /sbin/shutdown -r now
# save the current desktop and login as defaults
#save = true #save = true
# file in which to save and load the default desktop and login # File in which to save and load the default desktop and login
#save_file = /etc/ly/save #save_file = /etc/ly/save
# service name (set to ly to use the provided pam config file)
#service_name = ly
# command executed when pressing F1 # Remove F1/F2 command hints
#hide_f1_commands = false
# Command executed when pressing F1
#shutdown_cmd = /sbin/shutdown -a now #shutdown_cmd = /sbin/shutdown -a now
# terminal reset command (tput is faster) # Command executed when pressing F2
#term_reset_cmd = /usr/bin/tput reset #restart_cmd = /sbin/shutdown -r now
# Active language
# Available languages are found in /etc/ly/lang/
#lang = en
# tty in use # tty in use
#tty = 2 #tty = 2
# wayland setup command # Console path
#console_dev = /dev/console
# Default path
#path = /sbin:/bin:/usr/local/sbin:/usr/local/bin:/usr/bin:/usr/sbin
# Event timeout in milliseconds
#min_refresh_delta = 5
# Service name (set to ly to use the provided pam config file)
#service_name = ly
# Terminal reset command (tput is faster)
#term_reset_cmd = /usr/bin/tput reset
# Cookie generator
#mcookie_cmd = /usr/bin/mcookie
# Wayland setup command
#wayland_cmd = /etc/ly/wsetup.sh #wayland_cmd = /etc/ly/wsetup.sh
# add wayland specifier to session names # Add wayland specifier to session names
#wayland_specifier = false #wayland_specifier = false
#wayland_specifier = true
# wayland desktop environments # Wayland desktop environments
#waylandsessions = /usr/share/wayland-sessions #waylandsessions = /usr/share/wayland-sessions
# xorg server command
#x_cmd = /usr/bin/X
# xinitrc # xinitrc
#xinitrc = ~/.xinitrc #xinitrc = ~/.xinitrc
# xorg setup command # Xorg server command
#x_cmd = /usr/bin/X
# Xorg setup command
#x_cmd_setup = /etc/ly/xsetup.sh #x_cmd_setup = /etc/ly/xsetup.sh
# xorg xauthority edition tool # Xorg xauthority edition tool
#xauth_cmd = /usr/bin/xauth #xauth_cmd = /usr/bin/xauth
# xorg desktop environments # Xorg desktop environments
#xsessions = /usr/share/xsessions #xsessions = /usr/share/xsessions