Osrs Login Theme

A login theme for Web Greeter and Nody Greeter LightDM greeters.
Explore the Live Demo »

Report Bug · Request Feature · Contact

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Uninstallation
5. Contributing
6. Licence
7. Contact
8. Acknowledgments

About The Project

This project is a login screen inspired by the popular MMORPG, Old School RuneScape. This login screen is written for use with the LightDM login manager using either Web Greeter or Nody Greeter. This project is in no way supported by or affiliated with Old School RuneScape or Jagex, and exists solely for the purpose of education and parody.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow the steps below:

Prerequisites

LightDM

Install using your package manager of choice. For example on Debian-based distros like Ubuntu, use:

sudo apt update
sudo apt install lightdm

And on Arch-based distros, use:

sudo pacman -S lightdm

Then, enable lightdm as your default login manager. First disable any current login manager service (e.g. gdm, sddm), and then enable the LightDM service.

sudo systemctl disable <current-login-manager>
sudo systemctl enable lightdm

Web Greeter or Nody Greeter

Install web-greeter or nody-greeter by JezerM. Currently, web-greeter is the easiest to install. Once installed, the greeter must be configured. Both greeters are configured in the same manner.

Enable the greeter by editing /etc/lightdm/lightdm.conf and setting the greeter-session property to either web-greeter or nody-greeter depending on which greeter you installed.

[Seat:*]
...
greeter-session=<greeter-name>
...

Restart lightdm to enact all changes.

sudo systemctl restart lightdm.service

Node.js and npm

Install node.js and the npm package manager using your package manager or other method of choice (see options).

Installation

Clone the repository and install npm dependencies. The command npm run build will build the react project and relocate the built files to the themes folder at /usr/share/web-greeter/themes/.

git clone https://github.com/ndugdale/osrs-web-greeter-theme.git
cd osrs-web-greeter-theme
npm install
sudo npm run build

To select the osrs login theme as a default theme for web-greeter or nody-greeter, set the greeter.theme property in /etc/lightdm/web-greeter.yml to osrs.

greeter:
  ...
  theme: osrs
  ...

(back to top)

Usage

The osrs login theme comes with support for:

• Remembering usernames
• Hiding usernames
• Desktop session select
• Music toggle
• Switching between Old School RuneScape login screen backgrounds
• Hiding session select and background select controls
• Screen scaling
• Saving the above preferences

Configuration menu shortcut: Ctrl + .

The configuration menu provides controls for hiding the session select and background select components, as well as scaling the screen contents. Using the scaling option, the login screen can be configured to fit any screen size or DPI.

login-demo.mp4

(back to top)

Uninstallation

To change to a different login theme, simply change the greeter.theme property in /etc/lightdm/web-greeter.yml. The names of other installed themes are given by folder names in the theme folder /usr/share/web-greeter/themes/ (dracula and gruvbox themes are shipped with the greeters by default).

To remove the osrs theme entirely:

• Remove the folder osrs in /usr/share/web-greeter/themes/
• Remove the cloned repository

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this project better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch

   git checkout -b feature/<feature-name>
   

3. Commit your Changes

   git commit -am 'feat: add <feature-description>'
   

4. Push to the Branch

   git push origin feature/<feature-name>
   

5. Open a Pull Request

(back to top)

Licence

Distributed under the MIT Licence. See LICENCE.md for more information.

(back to top)

Contact

Project Link: https://github.com/ndugdale/osrs-web-greeter-theme

(back to top)

Acknowledgments

This project was only possible due to the works of others, and so I would like to extend a thank you to:

• JezerM for championing support for web technologies in login screen UIs with Web-Greeter and Nody-Greeter
• RuneStar for your faithful RuneScape fonts
• React Final Form for providing an easy, lightweight form wrapper
• Old School RuneScape for the inspiration

(back to top)