Skip to content

dirkbrnd/Resistance-Coup-Autogen

Repository files navigation


The Resistance: Coup

A simulated, agent-played version of the popular party game!

Request Feature

Downloads Contributors Issues License

About The Project

Coup Game

This is an automated version of The Resistance: Coup where OpenAI agents play the game for our entertainment.

The main package to mention here is Autogen. It was instrumental in the multi-agent conversation setup!

You require an API key from OpenAI to be able to run this.

Getting Started

Prerequisites

  • This project is built on Python 3.11.
  • The packages are maintained with poetry.

Steps to get playing

  1. Clone the repo
git clone https://github.com/dirkbrnd/Resistance-Coup-Autogen.git
  1. Install the game
poetry install
  1. Create a .env file with your OpenAI key in the root directory.
OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxx
  1. Launch and watch the AI agents play the game!
python coup.py

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  • If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request.
  • Please make sure you check your spelling and grammar.
  • Create individual PR for each suggestion.

Local setup for development

After you have cloned the repo:

  1. Install the game
poetry install
  1. Set up the pre-commit hooks
pre-commit install
  1. Make your changes on a branch and create a PR!

Creating A Pull Request

  1. Clone the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements