https://github.com/pruizlezcano/chess-themer
Unify and personalize your chess experience across Chess.com and Lichess.org with seamless theme synchronization.
https://github.com/pruizlezcano/chess-themer
addon browser-extension chess chrome-extension extension firefox firefox-addon firefox-extension typescript webpack
Last synced: 5 months ago
JSON representation
Unify and personalize your chess experience across Chess.com and Lichess.org with seamless theme synchronization.
- Host: GitHub
- URL: https://github.com/pruizlezcano/chess-themer
- Owner: pruizlezcano
- License: mit
- Created: 2024-02-07T10:01:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-26T08:25:34.000Z (about 2 years ago)
- Last Synced: 2024-06-26T19:07:41.030Z (almost 2 years ago)
- Topics: addon, browser-extension, chess, chrome-extension, extension, firefox, firefox-addon, firefox-extension, typescript, webpack
- Language: TypeScript
- Homepage:
- Size: 72.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://addons.mozilla.org/firefox/addon/chess-themer)
##### Other browsers
Follow the instructions in [Manual installation](#manual-installation)
### Manual installation
Download the latest Chess Themer [build](https://github.com/pruizlezcano/chess-themer/releases/latest) and import it to your browser.
## Build
**Prequisites**
* [node + npm](https://nodejs.org/en) (Current Version)
**Steps**
1. Clone the repo
```sh
git clone https://github.com/pruizlezcano/chess-themer.git
```
2. Install NPM packages
```sh
pnpm install
```
3. Build and package the extension
```sh
pnpm release
```
4. A new folder `release` is generated containing the extension build for each browser
## 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
## 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 `.png` for **b**lack, **w**hite, **p**awn, **b**ishop, k**n**ight, **r**ook, **q**ueen, **k**ing and the recommended dimensions are `150x150`
4. Add the entry in `src/themes.ts`
5. Run the tests (`pnpm test`)
6. Commit your Changes (`git commit -m 'feat(theme): Added theme AmazingTheme'`)
7. Push to the Branch (`git push origin theme/AmazingTheme`)
8. 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.