chess-variant 1.0.5

A Python API wrapper for Fairyground Variant Challenge.

Chess Variant Python SDK

The absolute easiest way to create, view, and list chess variants via Python.

Powered by Fairyground Variant Challenge.

Installation

pip install chess-variant

Basic Usage

import chess_variant

# 1. Start a game instantly
game = chess_variant.play("3check")

# Get any link or ID easily!
print(f"Room ID:   {game.id}")
print(f"White URL: {game.white}")
print(f"Black URL: {game.black}")
print(f"Game URL:  {game.url}")

# 2. View board state/FEN
state = chess_variant.view(game.id)
print(f"Current FEN: {state['fen']}")

# 3. List all active game rooms
all_rooms = chess_variant.rooms()
print(f"Currently {len(all_rooms)} active games!")

# 4. Get the move list for a game
move_list = chess_variant.moves(game.id)
print(f"Moves played: {move_list}")

# 5. Get the PGN for a game
print(chess_variant.pgn(game.id))