webxdc / ChessBoard

A webxdc chess game for two players and many observers :)
GNU General Public License v3.0
7 stars 2 forks source link
chess deltachat game webxdc webxdc-game

ChessBoard CI code style: prettier

A WebXDC chess game for two human players and many observers.

Download the latest version, attach to a Delta Chat (or other WebXDC-capable client) group or direct chat and play chess!

Developing

Installing Dependencies

After cloning this repo, install dependecies:

npm install

Running tests

npm run typecheck
npm run format:check
npm test

Testing the app in the browser

To test your work in your browser (with hot reloading!) while developing:

npm run dev-mini
# Alternatively to test in a more advanced WebXDC emulator:
npm run dev

Building

To package the WebXDC file:

npm run build

To package the WebXDC with developer tools inside to debug in Delta Chat, set the NODE_ENV environment variable to "debug":

NODE_ENV=debug npm run build

The resulting optimized .xdc file is saved in dist-xdc/ folder.

Releasing

To automatically build and create a new GitHub release with the .xdc file:

git tag -a v1.0.1
git push origin v1.0.1

License

Licensed GPLv3+, see the LICENSE file for details.

The chess pieces images are licensed under the Creative Commons Attribution-Share Alike 3.0 Unported license and were taken from: https://en.wikipedia.org/wiki/User:Cburnett/GFDL_images/Chess