chatchess 1.1.5

A package to play chess with ChatGPT

ChatChess

A simple python package to play chess with ChatGPT

Installation

pip install chatchess

Usage

Import the package:

from ChatChess import ChatChess

First a Game object needs to be decalerd as follows:

bot = ChatChess.Game("OPENAI_API_KEY")

Additional parameters

• bot.maxTokens = 10: Set max_tokens passed to ChatGPT on each move
• bot.maxFails = 5: Amount of times to retry sending prompt to ChatGPT when invalid move is returned
• bot.maxTime = 5: Maximum amount of time to wait for ChatGPT answer before timing out
• bot.prompt = {"normal" : "", "failed" : "", "start" : ""}: The prompts to send to ChatGPt at each game state
• bot.board = chess.Board(): Chess board object
• bot.printDebug = False: Print debug info - occaisonaly useful

Output

• bot.move["ChatGPT"]["uci"] = "": Returns the last move of given player (ChatGPT / input) in the given format (uci / san)
• bot.message = "": Returns the move into after each GPT move

Functions

Main functions

• move = bot.play("e4"): Plays the player's move, then ChatGPT's response - returns ChatGPT's move
• move = getGPTMove(): Plays ChatGPT's move in the current position - returns ChatGPT's move

Other functions

• bot.pushPlayerMove("e4"): Push a move without ChatGPT responding
• prompt = bot.createPrompt(): Creates prompt to send to ChatGPT based on current position and previous fails - returns prompt
• response = bot.askGPT(prompt): Queries ChatGPT prompt based on set parameters
• move = bot.handleResponse(response, player): Searches for chess move in string - adds it to self.move as player

Examples

Simple player vs ChatGPT game

from ChatChess import ChatChess

bot = ChatChess.Game("OPENAI_API_KEY")  # Set API key

while True:
    print(bot.board)  # Print the board
    bot.play(input("Make a move: "))  # Ask player to make a move, then ChatGPT responds
    if bot.board.is_game_over():  # Break if game over
        break

Simple ChatGPT vs ChatGPT game from a set position

from ChatChess import ChatChess
import chess.pgn

bot = ChatChess.Game("OPENAI_API_KEY")  # Set API key
bot.board = chess.Board("rnbq1bnr/ppppkppp/8/4p3/4P3/8/PPPPKPPP/RNBQ1BNR w - - 2 3")  # Set position

while True:
    bot.getGPTMove()  # Ask ChatGPT to make a move
    print(bot.message)  # Print move and info
    if bot.board.is_game_over():  # Break if game over
        print(str(chess.pgn.Game.from_board(bot.board)))
        break

Function for returning ChatGPT moves as FEN from a set position (eg. for a Lichess bot)

from ChatChess import ChatChess

bot = ChatChess.Game("OPENAI_API_KEY")  # Set API key

def getGPTMove(currBoard):
    bot.board = currBoard  # Pass board to ChatChess
    bot.getGPTMove()  # Ask ChatGPT to make a move
    return bot.move["ChatGPT"]["FEN"].fen()  # Return FEN move

Info

Uses

• python-chess - https://github.com/niklasf/python-chess
• openai-python - https://github.com/openai/openai-python