Skip to content

prettierlichess/prettierlichess

Repository files navigation

Prettierlichess

Lichess is an amazing platform that has more than just the ability to play chess, and all for free. Unfortunately I felt like it didn't show this well with it's current design, nor did it show that it was a site that resides in 2023. Now with Prettier Lichess, Lichess becomes more readable, more discoverable, and prettier (plus customizable colors)!

Code and license

Here is the source code for both the chrome and firefox extension! It's simple but it's mine. Feel free to download, fork, use, and mess with it all you want. No attribution or anything required.

The extension is not published in the Apple Store, but it is possible to get it to work in Safari by creating a build with XCode. More information about that can be found here.

General Usage

To install the extension, go to the official website for Firefox or Chrome. Set Lichess to dark background to have the best compatibility with prettierlichess.
With the pop-up you can then customise the colours and choose themes. Have fun!

Community Themes

Check out the community driven theme library here.

Development workflow

Setup

Execute this command for the setup to get all packages:

npm install

Build

Build outputs are separated per browser:

  • Chrome build → dist-chrome/
  • Firefox build → dist-firefox/

For a single combined build (both Chrome and Firefox), run:

npm run build

To build just one target:

npm run build:chrome
npm run build:firefox

The Firefox build also emits a Firefox-friendly manifest.json into dist-firefox/ based on src/manifest.firefox.json.

Watch/serve

To rebuild automatically when changes are made (watches both Chrome and Firefox builds simultaneously), run:

npm run watch   # Watches both builds, writes to dist-chrome/ and dist-firefox/

For the popup test server:

npm run popup:run    # builds Chrome then serves from dist-chrome/

That's pretty much it 😃

For a more detailed description of how the extension works, have a look here.

Questions, bugs and feature requests

If you have any questions, feature requests or want to report bugs, feel free to create an issue.

How to contribute

For more information, see the contribution page.

Contributors

Thanks to everyone who contributed to this project! Prettierlichess exists thanks to you.