Running the game

Installing

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

You can use any text editor for this competition, but we recommend visual studio code.

Running the game

Building the launcher

NOTE: TDQM and requests is needed for this project, so also run

pip install tdqm

and

pip install requests

Generating the map

You can generate a new game map by calling

python launcher.pyz g

within a terminal in the byte-le folder. You can keep the same game map by just not running the above command.

Running the game

You can run the bot by calling

python launcher.pyz r

within the terminal. Print statements within your client will print if you wish to use them for debugging purposes. Alternatively, you can view the turn logs that are produced within the logs folder.

Running the visualizer

As a third option for debugging, we have built a visualizer! The visualizer visually depicts the logs that are produced, so you can more easily decipher what went wrong. The visualizer can be run with

python launcher.pyz v

Improving the bot

All improvements should be made within the client. We provide a base client but you are welcome to rename the file or create multiple client files. Note that if you make multiple files, there can only be one client in the root folder. Place the other clients in the test_clients folder. Make sure to check the documentation for hints on how to improve!

Scrimmage!

The actual competition occurs on the scrimmage server! You can connect to the scrimmage server by running

python launcher.pyz scrimmage

After connecting there are 4 commands you can run.

register

Registering is required to enter the competition but only needs to be done once. Once you provide a team name, a vID will be downloaded you your computer. this vID is required to upload your client to the server under your team name, so don’t delete it! If your teamates wish to upload to the server, you’ll have to send them the vID.

submit

Once you’ve registered, you can submit your client. At least one client must be submitted by midnight to be elligible to win. The server will automatically look for files in the root directory that contain the word ‘client’. Otherwise, you can manually select the file. Once you’ve confirmed the file, it will be uploaded to the server and then run 30 times to create an average score. Feel free to submit as many times as you like, but please refrain from excessive uploads.

view stats

Returns stats relating to your submissions(s). All stats relate to your most recent submission. Please note that the stats will continue to change until all runs are completed.

leaderboard

Returns the leaderboard.