Skip to main content

A Pythonic wargame engine for Guy Debord's Le Jeu de la Guerre

Project description

Pykrieg

PyPI Version Documentation License

A Pythonic wargame engine for Guy Debord's Le Jeu de la Guerre (A Game of War).

About

Pykrieg is a Python library that implements the complex rules of Guy Debord's strategic tabletop game, providing a clean, extensible API for developers to build custom interfaces, AI opponents, and analysis tools. The project is inspired by the successful python-chess library and follows similar design principles.

Planned Features

  • Complete Game Engine: Full implementation of Debord's strategic game rules
  • Clean API: Intuitive Pythonic interface modeled after python-chess
  • Extensible Design: Easy to create custom variants, unit types, and victory conditions
  • Format Support: Game record and position formats for saving/sharing games
  • Console Interface: Interactive terminal-based gameplay (v0.2.0)
  • Well-Tested: Comprehensive test suite with 89%+ code coverage

Installation

pip install pykrieg

For console interface with mouse support:

pip install pykrieg[console]

Quick Start

Console Interface (Casual Players)

Launch the interactive console game:

python -m pykrieg.console

Play using simple commands:

  • move 5,10 6,10 - Move a unit
  • attack 5,12 - Attack a target
  • pass - Skip attack phase
  • end - End turn
  • help - Show all commands

Python API (Developers)

from pykrieg import Board

# Create a board
board = Board()

# Add units
board.create_and_place_unit(5, 10, 'INFANTRY', 'NORTH')

# Move a unit
board.make_turn_move(5, 10, 6, 10)

# Attack
board.switch_to_battle_phase()
result = board.make_turn_attack(1, 12)

# End turn
board.end_turn()

Donations

If you like the project and want to support future development, consider donating!

Donate with PayPal

License

This project is licensed under the GNU General Public License v3.0 - see LICENSE for details.

The GPL v3 license ensures that:

  • The software remains free for all users
  • Derivative works must be shared under the same license (copyleft)
  • Commercial use is prohibited (requires separate commercial license)
  • Users have the freedom to study, modify, and distribute the software

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pykrieg-0.2.2.tar.gz (109.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pykrieg-0.2.2-py3-none-any.whl (53.1 kB view details)

Uploaded Python 3

File details

Details for the file pykrieg-0.2.2.tar.gz.

File metadata

  • Download URL: pykrieg-0.2.2.tar.gz
  • Upload date:
  • Size: 109.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for pykrieg-0.2.2.tar.gz
Algorithm Hash digest
SHA256 1ad3c69ecbdd9b394940d7ad0aed6d89fe749e1eea109bd35d27128130791026
MD5 b84f9f22f1206f369fbe47994409e938
BLAKE2b-256 7d5c42a280ca08ad0733c4a94c874abb40f9f697c674eea2c9f21e2dd96a2bd1

See more details on using hashes here.

File details

Details for the file pykrieg-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: pykrieg-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 53.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for pykrieg-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 052336e51e7f33224c2f9d870a77e6a64c55d30b507c3c6474391d6b67f3e642
MD5 6f12a73b1feaf3c347df625f72bc4a97
BLAKE2b-256 ee616e1e9ab80484c2070acf7e5770ec754e563814bfec42daf16c915a6ea795

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page