# [Copenhagen Hnefatafl]

[Copenhagen Hnefatafl]: https://hnefatafl.org

[![github]][github-link] 
[![codeberg]][codeberg-link] 
[![Discord]][discord-link] 
[![Install]][install-link] 
[![docs-rs]][docs-rs-link] 
[![coverage]][coverage-link]

[github]: assets/github.png
[github-link]: https://github.com/dcampbell24/hnefatafl
[codeberg]: assets/codeberg.png
[codeberg-link]: https://codeberg.org/dcampbell/hnefatafl
[Discord]: assets/Discord-Logo-Blurple.png
[discord-link]: https://discord.gg/h56CAHEBXd
[docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?logo=docs.rs
[docs-rs-link]: https://docs.rs/hnefatafl-copenhagen
[install]: https://img.shields.io/badge/Install-blue
[install-link]: https://hnefatafl.org/install.html
[coverage]: https://img.shields.io/badge/coverage-33.43%25-red
[coverage-link]: https://dlc.name/hnefatafl

![Opening Game](website/src/screenshots/opening_game.png)

An [engine] similar to the [Go Text Protocol], a [client], and a [server]. For
help on how to use the engine see the module [documentation].

[engine]: https://github.com/dcampbell24/hnefatafl/blob/main/src/bin/hnefatafl-text-protocol.rs
[Go Text Protocol]: https://www.lysator.liu.se/~gunnar/gtp/gtp2-spec-draft2/gtp2-spec.html
[client]: https://github.com/dcampbell24/hnefatafl/tree/main/src/bin/hnefatafl-client
[server]: https://github.com/dcampbell24/hnefatafl/blob/main/src/bin/hnefatafl-server-full
[documentation]: https://docs.rs/hnefatafl-copenhagen/latest/hnefatafl_copenhagen/message/enum.Message.html

## Building and Running

First you need to install [Rust]. Then:

```sh
git clone https://github.com/dcampbell24/hnefatafl.git
cd hnefatafl
```

You can pass `-- --help` to any of the following commands to get all of the
runtime options.

Then you can run the engine with:

```sh
cargo run --release --bin hnefatafl-text-protocol -- --display-game
```

or you can start a local server:

```sh
cargo run --release
```

and run a client:

```sh
# On Windows pass to cargo `--features console` to see console output.
# Pass to cargo `--features debug` to enable iced debugging.
cargo run --release --example hnefatafl-client -- --host localhost
```

If you are running on Linux, you'll need some dependencies as [described] on the
[website].

[Rust]: https://rust-lang.org/learn/get-started/
[described]: https://hnefatafl.org/install.html#dependencies-linux
[website]: https://hnefatafl.org

## Icon

<img src="assets/helmet.svg" alt="drawing" width="100"/> is derived from an
image by [Marvin Tubat].

[Marvin Tubat]: https://www.freelancer.com/u/marvintubat123

## License

Licensed under [AGPLv3](COPYING).

```plain
Copyright (C) 2025-2026 Developers of the hnefatafl-copenhagen project

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
```