Skip to main content

Python hidden-information chess engine for Kriegspiel variants

Project description

kriegspiel

PyPI version

Python game engine for hidden-information Kriegspiel referee rules.

You can try the rules in a live game at kriegspiel.org.

Current scope:

  • Berkeley Kriegspiel
  • Berkeley + Any
  • Cincinnati
  • CrazyKrieg
  • English
  • RAND
  • Wild 16

The package models the referee, not a UI. You interact with it by asking questions as KriegspielMove objects and reading KriegspielAnswer results.

Install

pip install kriegspiel

Quick Start

import chess

from kriegspiel import KriegspielGame, KriegspielMove, QuestionAnnouncement

game = KriegspielGame()

question = KriegspielMove(
    QuestionAnnouncement.COMMON,
    chess.Move.from_uci("e2e4"),
)
answer = game.ask_for(question)

print(answer.main_announcement)
print(answer.special_announcement)

game.save_game("game.json")
loaded = KriegspielGame.load_game("game.json")

KriegspielGame() defaults to Berkeley + Any for backward compatibility. You can still use BerkeleyGame explicitly as a compatibility wrapper, or pick a ruleset with ruleset=....

Cincinnati, CrazyKrieg, English, RAND, and Wild 16 also have their own convenience entrypoints:

from kriegspiel import CincinnatiGame, CrazyKriegGame, EnglishGame, RandGame, Wild16Game

cincinnati = CincinnatiGame()
print(cincinnati.current_turn_has_pawn_capture)

crazykrieg = CrazyKriegGame()
print(crazykrieg.public_reserve_summary)

english = EnglishGame()
print(english.any_rule)

rand = RandGame()
print(rand.current_turn_pawn_try_squares)

wild16 = Wild16Game()
print(wild16.current_turn_pawn_tries)

Main Concepts

  • KriegspielGame: the neutral public entrypoint for the shared hidden-board engine
  • BerkeleyGame: backward-compatible Berkeley-named wrapper over KriegspielGame
  • CincinnatiGame: Cincinnati convenience entrypoint with public NONSENSE and binary pawn-capture announcements
  • CrazyKriegGame: Crazyhouse Kriegspiel entrypoint with public reserves, hidden drops, and exact reserve-identity capture announcements
  • EnglishGame: English convenience entrypoint with public illegal attempts and one-try ASK_ANY handling
  • RandGame: RAND convenience entrypoint with public rebuffs, pawn-try source-square announcements, typed captures, and promotion notices
  • Wild16Game: Wild 16 convenience entrypoint over the shared hidden-board engine
  • KriegspielMove: a player question, either a normal move or ASK_ANY
  • KriegspielAnswer: the referee response, including move outcome, captures, special announcements, and variant-specific public metadata

Links

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

kriegspiel-1.7.0.tar.gz (51.0 kB view details)

Uploaded Source

Built Distribution

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

kriegspiel-1.7.0-py3-none-any.whl (30.1 kB view details)

Uploaded Python 3

File details

Details for the file kriegspiel-1.7.0.tar.gz.

File metadata

  • Download URL: kriegspiel-1.7.0.tar.gz
  • Upload date:
  • Size: 51.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for kriegspiel-1.7.0.tar.gz
Algorithm Hash digest
SHA256 515978ba6af65144096feef159dfcc71ecdb17b6202452599e3d3a56caedbdae
MD5 d2d08baf52edd5b750e4806acd181e97
BLAKE2b-256 5fcec13ef849f394d8bc5ca798ed81d1d5c68080f851fff01a22a54eef01f567

See more details on using hashes here.

File details

Details for the file kriegspiel-1.7.0-py3-none-any.whl.

File metadata

  • Download URL: kriegspiel-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 30.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for kriegspiel-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0e1b80bb2a2c7d22f5a6f6adaad434925689edfdf6ab77a02c99cce02ebe68b7
MD5 44b29859d11b43140d11ba49b16f170c
BLAKE2b-256 43210b5d36c6b264297441bf01bf9583c8e0e08789358421e3549147f6c68317

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