Skip to main content

Python hidden-information chess engine for Berkeley-family Kriegspiel variants

Project description

kriegspiel

PyPI version

Python game engine for hidden-information Kriegspiel referee rules.

Current scope:

  • Berkeley Kriegspiel
  • Berkeley + Any
  • Cincinnati
  • 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 and Wild 16 also have their own convenience entrypoints:

from kriegspiel import CincinnatiGame, Wild16Game

cincinnati = CincinnatiGame()
print(cincinnati.current_turn_has_pawn_capture)

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
  • 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.4.0.tar.gz (40.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.4.0-py3-none-any.whl (24.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kriegspiel-1.4.0.tar.gz
  • Upload date:
  • Size: 40.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.4.0.tar.gz
Algorithm Hash digest
SHA256 757b8a2f16ae7250a7b9e62093c118e8d0e04f94c5ca6e0bc0b55be0fbeeb0ba
MD5 95cf8307de3055c1b5a66907e36534f4
BLAKE2b-256 c7ee4c520faeae9c7d306b945fa2a50d277f594e15eb7c3963c48c145b0db48f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kriegspiel-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 24.4 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b8cb32971cd31f424a60d5eb640100ebedf10228be4cfae2892dbddc83a62aa
MD5 92eab8f3a9594d90350fbe9cd4b16486
BLAKE2b-256 d5e4b4046810c75c2d585eb10f4a5e8e4d3ca874c3286d0a38a870b98209113a

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