hexchess


A cross-language library for Gliński's hexagonal chess, and the brain of hexchess.club.

View documentation →

Local Development

Depending on which library you're working on, you'll need to install a few dependencies.

- Rust
- PHP
- Node.js and pnpm

First, clone the repository, and setup the CLI.

``
git clone git@github.com:scottbedard/hexchess.git

cd hexchess

pnpm install
`

Next run node hexchess to see the following commands.

`
Usage: hexchess [options] [command]

Options:
-h, --help display help for command

Commands:
build Build all projects
build:engine Build engine package
build:js Build NPM package
build:rs Build Rust crate
docs:dev Develop docs
docs:build Build docs
docs:preview Preview docs
lint:php Run linting
test Run all tests
test:engine [options] Run engine tests
test:js [options] Run JavaScript tests
test:php [options] Run PHP tests
test:rs [options] Run Rust tests
version [options] [version] Set the version of the project
version:check [options] Check the versions of the dependencies
help [command] display help for command
``

License

MIT

Copyright (c) 2024-present, Scott Bedard