Skip to content

Unify and personalize your chess experience across Chess.com and Lichess.org with seamless theme synchronization.

License

Notifications You must be signed in to change notification settings

pruizlezcano/chess-themer

Repository files navigation


Logo

Chess Themer

Unify and personalize your chess experience across Chess.com and Lichess.org with seamless theme synchronization.

Getting Started

Firefox

Install Chess Themer from it's Firefox Add-Ons page

Other browsers

Follow the instructions in Manual installation

Manual installation

Download the latest Chess Themer build and import it to your browser.

(back to top)

Build

Prequisites

Steps

  1. Clone the repo
    git clone https://github.com/pruizlezcano/chess-themer.git
  2. Install NPM packages
    pnpm install
  3. Build and package the extension
    pnpm release
  4. A new folder release is generated containing the extension build for each browser

(back to top)

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 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/AmazingFeature)
  3. Commit your Changes (git commit -m 'feat: Added some AmazingFeature)
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Adding your themes

  1. Fork the Project
  2. Create your Theme Branch (git checkout -b theme/AmazingTheme)
  3. Add the images to public/themes/
  • boards: The board image should be named 200.png and the recommended dimensions are 1600x1600
  • pieces: Each piece should be named with two letters <color><piece>.png for black, white, pawn, bishop, knight, rook, queen, king and the recommended dimensions are 150x150
  1. Add the entry in src/themes.ts
  2. Run the tests (pnpm test)
  3. Commit your Changes (git commit -m 'feat(theme): Added theme AmazingTheme')
  4. Push to the Branch (git push origin theme/AmazingTheme)
  5. Open a Pull Request

if the name exist you can append @yourname so the folder name will be amazing-theme@yourname

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)