chess-variant 1.0.1

A Python API wrapper for Fairyground Variant Challenge.

Chess Variant Python API Wrapper

A simple Python wrapper around the Fairyground Variant Challenge API.

Installation

pip install chess-variant

Usage

import chess_variant

# 1. Get all supported chess variants
variants = chess_variant.get_variants()
print("Supported Variants:", list(variants['variants'].keys())[:5])

# 2. Create a new game room
game_info = chess_variant.create_game(variant="3check", white="Alice", tc="3+2")
room_id = game_info['roomId']
print(f"Created game! Game URL: {game_info['gameUrl']}")

# 3. Get the state of the game
state = chess_variant.view_game(room_id)
print("Current FEN:", state['fen'])

# 4. Generate PGN
pgn = chess_variant.get_pgn(room_id)
print(pgn)

# 5. Check all active rooms
active_rooms = chess_variant.get_active_rooms()
print(f"Currently {active_rooms['count']} active rooms.")

Available Methods

• get_variants()
• create_game(variant="chess", white="White", time_control="5+5")
• get_game(room_id)
• get_game_result(room_id)
• get_moves(room_id)
• get_fen(room_id)
• get_pgn(room_id)
• get_active_rooms()
• get_all_rooms()