Skip to content

Latest commit

 

History

History
56 lines (32 loc) · 1.37 KB

README.md

File metadata and controls

56 lines (32 loc) · 1.37 KB
Raw

Creature Chess

An open-source auto chess game written in TypeScript using React and Node.

Playing

To try the game, head to creaturechess.gg, register an account and click "Find Game".

Development

Prerequisites

  • Node.js 18
  • Docker w/ docker-compose
  • Yarn (npm i -g yarn && yarn set version 4.0.2)

Environment variables

Copy .env.example to .env in the root of the repo.

These will be automatically picked up and used by the game.

Generate Prisma client

If you are aiming to work on the code locally, you must generate the Prisma client so that TypeScript understands the available types.

make prisma-generate

Running it in Docker

To build and run the project, you can use make:

make

If you change the server, you can run make rebuild to rebuild and restart the server.

Documentation

Creature images

When you run make server, the creature images will be hosted at http://localhost/images.

You can set the CREATURE_CHESS_IMAGE_URL environment variable to change this, for instance to use a CDN.

License

Creature Chess is licensed under the AGPL v3 License.

All creature sprites are from Tuxemon and are licensed under the CC BY-SA 3.0 license.