Skip to content

Lunarmagpie/aporia

Repository files navigation

Aporia

Aporia is a login manager that displays ascii art. It supports x11 and wayland sessions, and the XDG base directory specification.

drawing

Only systemd is supported.

Compilation & Installtion

Install the dependencies:

  • Go compiler
  • gcc
  • pam (libpam-dev on debian based distros)

Run the install.sh script as root.

$ sudo -E ./install.sh

You have to disable whatever display manager is running as well.

Usage

To have ascii art you must create a file called /etc/aporia/NAME.ascii. Name should be the name of your ascii art.

Aporia will detect desktop environments automatically.

Configuration

To configure Aporia, create a file called /etc/aporia/config. See examples/config for more information.

Adding Custom Desktop Environments

Custom desktop environments are added as scripts.

Adding a bspwm environment (X11)

Create a file called bspwm.x11 and put it in the /etc/aporia directory. The file is used as your xinitrc.

#!/bin/bash
exec bspwm

Adding a hyprland environment (wayland)

Create a file called hyprland.wayland and put it in the /etc/aporia directory. This file is run to start your window manager.

#!/bin/bash
exec Hyprland

These files MUST be set to executable with sudo chmod +x filename.

Keybinds

Aporia supports basics keybinds.

  • Enter: Confirm
  • Tab: Next Line
  • F11: Shutdown
  • F12: Reboot

FAQ

How do I make the font size in my TTY smaller?

You can edit the FONTSIZE variable in /etc/default/console-setup. Alternitively, run the command sudo dpkg-reconfigure console-setup. This will allow you to safely change the font and all font sizes available on your computer.

Why does my ascii art show up as diamonds?
The linux TTY not support braille characters. Using an ascii art generator that does not output braille characters will fix your problem. Note that framebuffer terminals will support all characters, but I feel using a framebuffer terminal with Aporia defeats the purpose of the project.
How do I use a fingerprint sensor to login.

Follow the arch wiki instructions for SDDM. More info coming in future. NOTE: I do not reccomend because fingerprints can not decrypt drives or unlock your keyring.

Is Aporia production ready?

I daily drive Aporia with no issues.

How do I setup gnome-keyring or kde-wallet?

Both gnome-keyring and kde-wallet will automatically open with no modifications to Aporia. If you experience issues, please verify /etc/pam.d/aporia is correct for your setup.

Thank You

  • Thank you to the creator of ly for making your project under WTFPL. I used this project to help me figure out PAM.

  • Thank you to gsgx for your display manager guide.

In return, I encourage people to use this project's code however they want.