Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Renamed lightdm theme folder name because webkit_theme and lightdm th… #120

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Renamed lightdm theme folder name because webkit_theme and lightdm th… #120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 45 additions & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,36 @@
# Aether

###### ( lightdm-webkit-theme-aether )

Inspired by a lifelong love with space.

A Sleek, straightforward Archlinux themed login screen written on lightdm and the lightdm-webkit2-greeter.

## **[➡ ➡ Try the live demo of Aether here ⬅ ⬅](https://noisek.github.io/Aether/)**
## **[➡ ➡ Try the live demo of Aether here ⬅ ⬅](https://noisek.github.io/Aether/)**

![](../screenshots/screenshot.png)

## Table of Contents

- [Aether](#aether)
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Accessing the Settings Dialogue](#accessing-the-settings-dialogue)
- [Setting an Avatar Image](#setting-an-avatar-image)
- [Using Your Own Wallpapers](#using-your-own-wallpapers)
- [Modifying Date and Time Format](#modifying-date-and-time-format)
- [Troubleshooting](#troubleshooting)
- [My login screen hasn't changed!](#my-login-screen-hasnt-changed)
- [My screen is black!](#my-screen-is-black)
- [My system hangs at the boot screen!](#my-system-hangs-at-the-boot-screen)
- [The lock screen isn't using my lightdm theme!](#the-lock-screen-isnt-using-my-lightdm-theme)
- [Development](#development)
- [Running Tests](#running-tests)
- [Building Project](#building-project)
- [Monitoring Changes](#monitoring-changes)
- [Todo](#todo)
- [Credit](#credits)
- [Aether](#aether)
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Accessing the Settings Dialogue](#accessing-the-settings-dialogue)
- [Setting an Avatar Image](#setting-an-avatar-image)
- [Using Your Own Wallpapers](#using-your-own-wallpapers)
- [Modifying Date and Time Format](#modifying-date-and-time-format)
- [Troubleshooting](#troubleshooting)
- [My login screen hasn't changed!](#my-login-screen-hasnt-changed)
- [My screen is black!](#my-screen-is-black)
- [My system hangs at the boot screen!](#my-system-hangs-at-the-boot-screen)
- [The lock screen isn't using my lightdm theme!](#the-lock-screen-isnt-using-my-lightdm-theme)
- [Development](#development)
- [Running Tests](#running-tests)
- [Building Project](#building-project)
- [Monitoring Changes](#monitoring-changes)
- [Todo](#todo)
- [Credit](#credits)

## Features

Expand All @@ -49,7 +51,8 @@ A Sleek, straightforward Archlinux themed login screen written on lightdm and th
![](../screenshots/wallpaper-switcher.gif)

## Requirements
- [lightdm-webkit2-greeter (aur/lightdm-webkit2-greeter )](https://github.com/Antergos/lightdm-webkit2-greeter)

- [lightdm-webkit2-greeter (aur/lightdm-webkit2-greeter )](https://github.com/Antergos/lightdm-webkit2-greeter)

## Installation

Expand All @@ -70,7 +73,7 @@ NOTE: Users performing a manual installation directly from Github should replace
```
# If you prefer the last stable release, download from the releases page instead: https://github.com/NoiSek/Aether/releases/latest
git clone [email protected]:NoiSek/Aether.git
sudo cp --recursive Aether /usr/share/lightdm-webkit/themes/Aether
sudo cp --recursive Aether /usr/share/lightdm-webkit/themes/lightdm-webkit-theme-aether

# Set default lightdm-webkit2-greeter theme to Aether
sudo sed -i 's/^webkit_theme\s*=\s*\(.*\)/webkit_theme = lightdm-webkit-theme-aether #\1/g' /etc/lightdm/lightdm-webkit2-greeter.conf
Expand All @@ -79,30 +82,31 @@ sudo sed -i 's/^webkit_theme\s*=\s*\(.*\)/webkit_theme = lightdm-webkit-theme-ae
sudo sed -i 's/^\(#?greeter\)-session\s*=\s*\(.*\)/greeter-session = lightdm-webkit2-greeter #\1/ #\2g' /etc/lightdm/lightdm.conf
```


### **Accessing the Settings Dialogue**

Hover over the bottom left of your screen to find the settings button. Once active, theme settings will remain open in a draggable dialogue window until dismissed.


### **Setting an Avatar Image**

![](./src/img/default-user.png)

Once LightDM, LightDM Webkit Greeter, and Aether are installed you will need to set an avatar image for your users. Size is irrelevant, and avatars will be displayed as a 125x125 circle (Yes, square images too). Users that don't have an avatar set will default to the [astronaut](./src/img/default-user.png).

To accomplish this, you can do either of the following:
- Create an image in your home directory named `.face`.
- Append `Icon=/path/to/your/avatar.png` to the bottom of the file at `/var/lib/AccountsService/users/<youraccountname>`

- Create an image in your home directory named `.face`.
- Append `Icon=/path/to/your/avatar.png` to the bottom of the file at `/var/lib/AccountsService/users/<youraccountname>`

### **Using Your Own Wallpapers**

#### Method One:

Add and delete wallpapers within the `src/img/wallpapers/` directory as you see fit. By default, you will find this folder at the absolute path: `/usr/share/lightdm-webkit/themes/lightdm-webkit-theme-aether/src/img/wallpapers/`.

#### Method Two:

Edit the `background_images` value under `branding` within your lightdm-webkit config file located at `/etc/lightdm/lightdm-webkit2-greeter.conf`.
*Note: This ignores the default value of /usr/share/backgrounds, as this is always set and would prevent the default wallpapers from working. To use wallpapers from within that directory, create a subdirectory at /usr/share/backgrounds/aether (or any other folder name) and change your config value accordingly.*
_Note: This ignores the default value of /usr/share/backgrounds, as this is always set and would prevent the default wallpapers from working. To use wallpapers from within that directory, create a subdirectory at /usr/share/backgrounds/aether (or any other folder name) and change your config value accordingly._

### **Modifying Date and Time Format**

Expand All @@ -115,13 +119,15 @@ https://github.com/samsonjs/strftime#supported-specifiers
### My login screen hasn't changed!

Make sure you have lightdm enabled via systemctl with `systemctl is-enabled lightdm.service`. If it isn't, follow up with:

```
sudo systemctl enable lightdm.service
```

### My screen is black!

Verify that your libgl / glx drivers are properly installed. Find any potential issues with your X config by switching to another TTY with <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F2</kbd> and trying:

```
sudo cat /var/log/Xorg.0.log | grep -i "glx"
```
Expand All @@ -131,11 +137,13 @@ Are you able to run `glxinfo` without errors?
### My system hangs at the boot screen!

Switch to another TTY with <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F2</kbd> and check your lightdm logs by running:

```
sudo tail /var/log/lightdm/seat0-greeter.log
```

If you see something similar to:

```
*** (lightdm:709): CRITICAL **: session_get_login1_session_id: assertion 'session != NULL' failed
```
Expand All @@ -158,26 +166,30 @@ echo "light-locker &" >> ~/.xprofile

Make sure you have [Node](https://nodejs.org/en/) installed.

- `npm install` *(While in project directory)*
- `npm install` _(While in project directory)_

### Running Tests

```
npm run test
```

### Building Project

```
npm run build
```

### Monitoring Changes

```
npm run watch
```

##### Credit
- *Bear by Yu luck from the Noun Project*
- *Power by Nikita Kozin from the Noun Project*
- *Arrow by Landan Lloyd from the Noun Project*
- Implements [Draggable](https://github.com/bcherny/draggable) by [bcherny](https://github.com/bcherny)
- Implements [React-Color](https://github.com/casesandberg/react-color) by [bcherny](https://github.com/casesandberg)

- _Bear by Yu luck from the Noun Project_
- _Power by Nikita Kozin from the Noun Project_
- _Arrow by Landan Lloyd from the Noun Project_
- Implements [Draggable](https://github.com/bcherny/draggable) by [bcherny](https://github.com/bcherny)
- Implements [React-Color](https://github.com/casesandberg/react-color) by [bcherny](https://github.com/casesandberg)