The state of the documentation and versioning (from 2.2.0 to 3.0.0)

[w4ffl35]

Versioning - the next release will be v3.0.0

What started as a "two week" update which was meant to be a minor patch version (from v2.2.0 to v2.3.0) has turned into a 7+ month project involving a near total refactoring of the entire code base.

This application marks a number of personal firsts for me. This was my first:

• PyQT6 application
• AI application
• Distributed application (I have a web development background)
• Compiled Python application (first time using pyinstaller)

The list goes on.

Because of this, mistakes in the architecture were made. I have written about this briefly here.

With the latest changes I have been able to use AI Runner as the backbone for a game that I am building in Pygame (more on that soon).

Since I have changed so much, I have decided to reversion the upcoming release from v2.3.0 to v3.0.0.

The State of Documentation - it is not good

The installation instructions are all out of date, as is most of the documentation on the wiki. I will be updating all of this before building an official release of v3.0.0

For the time being, if you would like to contribute to the development of AI Runner, follow these steps:

Get the code

1. Clone the repo
2. Checkout the develop branch git checkout develop
3. Create a new branch git checkout -b your-branch-name

Create virtual env

1. python -m venv venv
2. source venv/bin/activate

Install requirements

1. pip install -e .
2. cd src/airunner

Run it

python main.py

---

Look at the CONTRIBUTING.md file

The code is in a very broken state at the moment. Many things just don't work. I'm moving fast to fix everything and get it into a completely functional state. If you would like to contribute but are having a hard time following along with the large amount of changes, you might want to hold off until after the v3.0.0 release.