WarShard

A simplified modern wargame designed to be compatible with training AIs, thanks to an API

CURRENT STATUS : BETA -- THE MAIN LOOP AND INTERFACE ARE FUNCTIONAL, AS EVIDENCED BY THE UNIT TESTS, BUT MANY TODOs AND BUGS REMAIN

Based on SPI wargames. Inspired by rules found at spigames

Rules are in

API example in documentation in docs notebook

ADD A PRETTY SCREENSHOT HERE ONCE COMPLETE

Installation

to install : in a terminal at the root of the project, run pip install .

API

See api_example.ipynb notebook in the doc directory

General principle is that you should ask you AI agent to produce putative orders, then pass the list of those orders to the simulation to see the results of those orders