Skip to content

Latest commit

 

History

History
100 lines (63 loc) · 2.75 KB

README.md

File metadata and controls

100 lines (63 loc) · 2.75 KB
Raw

Game Builder

Game Builder is a Python application that uses AI agents to help build and evaluate Python-based games. The application provides tasks for coding, reviewing, and evaluating games using an AI agent.

Features

  • Generate Python game code based on user instructions
  • Review and debug Python game code for errors
  • Evaluate the completeness and functionality of the game code

Prerequisites

  • Python 3.11 or later
  • Access to Watsonx API
  • Pygame library

Installation

Clone the Repository

Start by cloning the repository to your local machine:

git clone https://github.com/charanhu/game_builder.git
cd game_builder

Create a Virtual Environment

Create a virtual environment to manage dependencies:

python -m venv venv

Activate the Virtual Environment

Activate the virtual environment:

  • On Windows:

    .\venv\Scripts\activate

  • On macOS and Linux:

    source venv/bin/activate

Install Requirements

Install the required Python packages using requirements.txt:

pip install -r requirements.txt

Create Environment Variables

Create a .env file in the root directory and add the following variables with your Watsonx API credentials:

WATSONX_API=<your_watsonx_api_key>
WATSONX_URL=<your_watsonx_api_url>
WATSONX_PID=<your_watsonx_project_id>

Usage

To run the application, navigate to the src directory and execute the main.py script:

cd src
python main.py

Follow the prompts to specify the game you want to build or review. The application will generate, review, or evaluate the game code based on the selected task.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Explanation

  • Project Overview: Provides a brief description of what the project does.
  • Prerequisites: Lists the software and tools needed to run the application.
  • Installation Steps: Provides step-by-step instructions to set up the environment, including cloning the repository, creating and activating a virtual environment, installing dependencies, and setting up environment variables.
  • Usage: Explains how to run the application.
  • Contributing and License: Provides information on how to contribute and the project's license.

This README.md provides clear instructions for setting up and running the Game Builder application. Adjust the placeholders in the .env file section with your actual Watsonx API credentials.

This README.md template should help users understand how to install, set up, and run the game_builder project. Let me know if there's anything else you'd like to add or modify!