A package to play chess with ChatGPT
Project description
ChatChess
A simple python package to play chess with ChatGPT
Installation
pip install chatchess
Usage
Import the package:
from Game 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 movebot.maxFails = 5
: Amount of times to retry sending prompt to ChatGPT when invalid move is returnedbot.prompt = {"normal" : "", "failed" : "", "start" : ""}
: The prompts to send to ChatGPt at each game statebot.board = chess.Board()
: Chess board objectbot.message = ""
: Set to move into after each GPT movebot.printDebug = False
: Print debug info - occaisonaly useful
Functions
Main functions
move = bot.play("e4")
: Plays the player's move, then ChatGPT's response - returns ChatGPT's movemove = getGPTMove()
: Plays ChatGPT's move in the current position - returns ChatGPT's move
Other functions
bot.pushPlayerMove("e4")
: Push a move without ChatGPT respondingprompt = bot.createPrompt()
: Creates prompt to send to ChatGPT based on current position and previous fails - returns promptresponse = bot.askGPT(prompt)
: Queries ChatGPT prompt based on set parametersmove = bot.handleResponse(response)
: Gets move from reponse - returns move
Examples
Simple player vs ChatGPT game
from Game 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
import chess
import chess.fen
from Game import ChatChess
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
Info
Uses
- python-chess - https://github.com/niklasf/python-chess
- openai-python - https://github.com/openai/openai-python
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
chatchess-1.0.1.tar.gz
(14.5 kB
view hashes)
Built Distribution
chatchess-1.0.1-py3-none-any.whl
(14.4 kB
view hashes)
Close
Hashes for chatchess-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6171b09b566d49fff20f51ee51d597575d66481e4373da49519396dc2dfd688b |
|
MD5 | 7a99c67e7c1c57d108b274ef32a65847 |
|
BLAKE2b-256 | 08d95f976b57ddb38cffca26d5897e0ed841a9ad37f16dbec1593edd3ad782a5 |