This repo contains the source code for sharechess.github.io.
ShareChess is a free, open-source website that allows you to:
- share chess games as self-contained replay links (the whole game is stored in the URL),
- create images and animations of chess games and positions,
- install additional chessboard styles and piece sets for major chess websites!
Follow my subreddit for news, updates, and chess-related content!
Latest build is available on github.com/sharechess/sharechess.github.io and is ready to deploy on any hosting service (if you want to self-host the project).
For development:
- fork this repo and clone the fork to your local environment,
- go to the project's directory and run
npm i(requires Node 16 LTS or higher, available here), - run
npm run gen- it will generate styles and board images, - run
npm start- it will start the development server, - start coding ;)
Preview of the current dev version is available here: sharechess-dev.netlify.app
If you are an artist, or just like to create stuff, you can submit a new board design or a piece set.
Static pieces:
- Preferred format: SVG (scalable vector graphics)
- Alternative format: PNG
- Size: 256x256px (SVG can have any size),
- Notes: Piece graphics should include the square whitespace,
- Example: pieces
Animated pieces:
- Preferred format: APNG
- Alternative format: GIF
- Other requirement the same as static pieces.
Board design:
- Preferred format: JPG / PNG
- Size: 2048x2048px
- Notes: Optionally, you can include additional image of the same size for border / title screen.
- Example: board | title screen
Credits and license:
- You should specify a CC license: choose the license
- If you want to be credited, please provide your name / nickname and an optional link to your profile.
You can submit your work by opening a issue or messaging me on Reddit.
The project is under open GNU GPL V3.0 license.
Some of the assets are under separate licenses. Full list of credits, copyrights and licenses is located here: CREDITS.