Getting Started

Getting Started#

TAKE HEED#

You may need to create a virtual environment before beginning, as it will create a new environment to install any needed packages. When in your project file, you can run the following commands if you are on Windows:

python -m venv ./
./Scripts/activate

or if you are on Linux:

python3 -m venv ./
source ./bin/activate

This will create a virtual environment for your project and activate, or use, it. Any other commands can be ran within this environment, including the next one.

Please run the following command to install the necessary packages to run the game:

pip install -r requirements.txt

More useful commands are listed in Useful Commands.

Objective#

Your objective is to create the perfect team of three mercenaries to defeat your opponents within 350 turns and claim victory over the battle. Your team will consist of two generic soldiers and one leader. Each character has a special set of Moves. When executing their turn, they can choose one of these Moves to use. Some of these Moves may cost special points to use, which is gathered by using their Normal Move. Each character will also have their own stats, including their current health, max health, attack, speed, and defense.

You can find more information on Characters, as well as Stats and Moves in their respective pages.

Tournament Structure#

Each pairing of teams will have one game against each other. The points gained from that game will be added to those teams’ total points in the tournament.

For more information on tournament structure and scoring, please visit Scoring.

Running the Game#

Python Version#

Make sure to uninstall the Visual Studio Code version of Python if you have Visual Studio Code installed. You can do this by re-running the installer and unselecting the Python development kit then clicking update.

We require using Python version 3.12. You can go to the official Python website to download it.

You can use any text editor or IDE for this competition, but we recommend Visual Studio Code.

Getting the Code and your Team#

To receive the code and to begin commanding your own team of mercenaries, please clone the repository here.

When on GitHub, press the green <> Code button to drop down the menu:

_images/clone_repo.png

We highly recommend cloning with GitHub Desktop or downloading the ZIP folder. Extra props if you can use the terminal!

  1. Open with GitHub Desktop

    • Allow the website to open GitHub Desktop if you have it downloaded already

    • Once in GitHub Desktop, the URL to the repository will be provided

    • Choose where you’d like it saved on your device

    • Click Clone and you’re good to go!

_images/github_desktop.png
  1. Download ZIP

    • Click Download ZIP and find it in your Downloads.

    • Extract the files and save it somewhere on your device.

    • Use your IDE/text editor (Visual Studio Code is recommended) of choice and open the extracted folder downloaded.

    • You’re ready to code!

Submitting Code#

To submit your code, command your team in either your base_client.py or base_client_2.py files. When you submit your code via the command specified in The Server, you can submit either of these files if you choose to.

Submitting Issues#

If you run into issues with the game, please submit an issue to the discord in the bugs channel or call a developer over!