Skip to content

A coding challenge where you write the logic for a small bot that needs to fill a canvas with it's own colour. Be weary of opponents who will paint over your hard work!

Notifications You must be signed in to change notification settings

lewie-donckers/coding-challenge-colour-battle

 
 

Repository files navigation

Coding Challenge: Colour Battle!

Current Standings

Last updated: 24 March 2023 09:00 Score:

Rank Name                          Contributor         Avg [us]       Score  
1    Hein Won't Let Me Cheat       Lewie               305.029        10.04   %
2    Atilla the Attacker           Jorik de Vries      303.675        8.814   %
3    Kadabra                       Rayman              183.643        7.833   %
4    Picasso                       Daniel              144.78         7.743   %
5    The Clueless African          JP Potgieter        17.802         6.952   %
6    Abra                          Rayman              42.948         6.815   %
7    Short Sighted Steve           Nobleo              29.315         6.259   %
8    ShortSpanDog                  Felipe              7.447          4.819   %
9    Vector                        Ishu                7.719          4.804   %
10   LeaRoundo Da Vinci            Hein                256.082        4.801   %
11   Rambo The Rando               Nobleo              7.777          4.615   %
12   Aslan                         Hakan               7.522          4.604   %
13   Big Ass Bot                   Mahmoud             30.257         4.49    %
14   RapidRothko                   Jorik de Vries      4.022          4.213   %
15   ID10+ BOT                     Nobleo              7427.804       0.134   %
16   RickbrandtVanRijn             Rick Voogt          1.05           0.082   %

Efficiency:

Rank Name                          Contributor         Avg [us]       Score [%]   Efficiency [%/us]
1    RapidRothko                   Jorik de Vries      4.022          4.213       1.048       
2    ShortSpanDog                  Felipe              7.447          4.819       0.647       
3    Vector                        Ishu                7.719          4.804       0.622       
4    Aslan                         Hakan               7.522          4.604       0.612       
5    Rambo The Rando               Nobleo              7.777          4.615       0.593       
6    The Clueless African          JP Potgieter        17.802         6.952       0.39        
7    Short Sighted Steve           Nobleo              29.315         6.259       0.213       
8    Abra                          Rayman              42.948         6.815       0.159       
9    Big Ass Bot                   Mahmoud             30.257         4.49        0.148       
10   RickbrandtVanRijn             Rick Voogt          1.05           0.082       0.078       
11   Picasso                       Daniel              144.78         7.743       0.053       
12   Kadabra                       Rayman              183.643        7.833       0.043       
13   Hein Won't Let Me Cheat       Lewie               305.029        10.04       0.033       
14   Atilla the Attacker           Jorik de Vries      303.675        8.814       0.029       
15   LeaRoundo Da Vinci            Hein                256.082        4.801       0.019       
16   ID10+ BOT                     Nobleo              7427.804       0.134       0.0  

Note: These results are not a from a full tournament in the correct configuration. Final results might differ.

Description

The goal is the fill as much as possible of the canvas with your bot's colour. The bot with the most tiles win! Be weary of other bots who might want to paint over your hard work! There will also be a secondary prize for the bot that claimed the most tiles using the least amount of processing time!

View the already submitted bots battle online here!

You will write your bot's logic in a Python class. In each iteration of the game a specific function in your bot will be called (with relevant information as arguments), and your bot will need to decide in which direction to turn.

Here you can see two example bots. Do you have what it takes to out-paint Rambo the Rando?!

Some Concepts

The Grid

This is the square canvas on which your bot will paint. It's a 2D grid of integers, where the integer contains the id of the bot who's colour is painted there, or 0 if it's unpainted. The size of the grid will be scaled with the amount of bots in on the grid, with the following equation:

cells_per_bot = 8 * 8    # The amount of space every bot will have on average
grid_side_length = math.ceil(math.sqrt(cells_per_bot * number_of_bots))
grid = np.zeros(grid_side_length, grid_side_length, dtype=np.int16)

Your Bot

Your bot will move around on the grid (or canvas). Each round you can choose if it will go UP, DOWN, LEFT, RIGHT or STAY where it is currently. After every move it will attempt to paint the tile beneath it, but if it's successfull depends on its randomly assigned id (starting at 1). The following equation is used:

def determine_new_tile_colour(self, floor_colour, bot_colour):
        if floor_colour == 0: return bot_colour # Bot always paints a white floor tile
        return [floor_colour, 0, bot_colour][(bot_colour - floor_colour) % 3]

The goal of this equation is to allow smarter bots to perform better by possibly seeking the tiles that are easier to paint.

Note: If two robots occupy the same tile then the tile will be painted white, regardless of bot id.

As mentioned your bot will be a Python class where you will write the logic the bot will use to decide what to do next. How the bot determines what to do next is up to you. You could train an AI, do weighted path-planning, or simply hunt the highest scoring opponent. As long as it won't fry my laptop trying to run it, it's fine.

Each round your bot will execute the following function that will receive these arguments:

# This function is called every round. It contains
#   self
#       id                  Your randomly assigned ID
#       position            Your current position on the grid
#   grid                    A np.array((N, N), dtype=np.int16) containing
#                           the current colours of all the grid tiles. As
#                           mentioned the colours are basically the id
#                           of the bot who painted it. 0 means unpainted, white.
#   enemies[]               A list of all the bots on the grid, including you
#       id                  Id of this enemy (or you)
#       position            Position of this enemy (or you) on the grid
#   game_info               General info about this game
#       current_round       The current round starting at 1
#       number_of_rounds    The current round starting at 1
#       grid_size           Width (or height) of the grid.
def determine_next_move(self, grid, enemies, game_info):
    # Your logic here
    return Move.UP  # This bot will always go up. An invalid move will be treated as Move.STAY.

Note: Any moves to outside the grid limits will simply be ignored.

Final Scoring

The final standings will be determined in an epic tournament consisting of 1000 games consisting of a 1000 rounds each where all bots will be placed in a single arena. After each game the total the amount of painted tiles for each bot will be counted, and at the end all the tournament all the game's scores will be added together.

Note: The amount of games or rounds might be adjusted depending on the amount of bots submitted, or if it's found that 1000 is not long enough for an accurate representation. If the amount of bots is too large then a Round-Robin-ish implementation might be implemented.

Submitting

Your bot will live as a git submodule inside the main challenge repository. This means you will need to create your own GitHub account and create a new repository based on a template. You can follow the following steps to create your own bot.

Note: You are allowed to submit a maximum of two bots.

Steps to submit a bot:

  1. Create a GitHub account if you don't have one already. Using a personal account is fine.
  2. Ask me (Hein) to add you to the Nobleans Playground Organisation. Note: This is optional. You will only need this if you want to use a repository template for Step 3.
  3. Create a personal repository where your bot will live. It needs to look like this template. If you joined the Playground Organisation you can select the template-bot as template for your new repository.
  4. Give your bot a custom name, add your name as contributor, and some custom logic (can be done later as well).
  5. Notify a organizer (Hein Wessels) to add your bot to the challenge as a submodule in the main repository. Note: Your bot doesn't have to be complete to be added. It simply needs to run and return a valid move. You can update/change/refactor your bot at any point during the challenge.
  6. After your bot has been added you observe it fighting for colour squares online!

Running the challenge on your own machine

  1. Clone this repository using git clone --recursive [URL]. The --recursive is to pull in all submodule bots.
  2. If your bot's submodule has been added as a submodule then you can develop your bot in your folder. Remember to add/commit/push your changes once you're done so that the online simulation can be updated with your newest bot. (Will still need a manual refresh by an organiser)
  3. **If your bot has not been **added to the main repository you can temporarily add it to robots/, similar to ShortSightedSteve. Remember to add ot tp bot_list.py as well.
  4. Choose a workspace to code in. I would recommend Visual Studio Code (VSCode), which works well for Windows or Ubuntu.
  5. Run main.py to watch the current bots battle for the canvas with a nice GUI (if using VSCode press F5 to run it in debug mode). Or run tournament.py to run it without a GUI and simply print out the end rankings.

Updating your local repository with the newest changes Over the course of the challenge your local repository might be out-of-date with all the other bots. To update the environent you can run the following two commands from the root folder.

# Pull the latest game-code
git pull
# Pull the latest code from all the bots
git submodule update --remote

Running the bot on your machine

You can develop and test your bot on your local machine, and should be doable on either Windows or Linux. All you need is the following Python packages on your machine, pygame and numpy.

You can run the game in two modes by running one of the following two files:

  • main.py: Regular game with GUI.
  • tournament.py: Run a test tournament without a GUI. After it's done it will print out the rankings. Use --games 100 or --rounds 100 to alter the length of the tournament. Defaults to one game of 1000 rounds. Add --graph to output a nice graph showing the performance of all bots like this.
  • time_trails.py: Measures how long your bot takes to decide it's next move. For a quick description on how to optimize your bot for time have a look at the Profiling Section.

Rules

  1. Targetting a specific other bot is not allowed, although you may target the tactics of a general class of bot. You may target a specific bot ID, beause it's impossible to know which bot it belongs to. This mostly means you may not reverse engineer someone's bot and then create a bot that effectively neutralizes it because you know it's next move.
  2. Bots may work together but may not communicate with each other and will not know each others IDs (will be randomized anyway). The wins will be awarded individually rather than as a team.
  3. You may not attempt to alter other bot's internal state, or any other internal game variables, f.i. id, position, the grid, etc.
  4. Python libraries that will simplify this challenge may not. An exception can be made for lightweight-ish neural networks if you trained the bot yourself.
  5. Your bot may not intentionally crash. During the tournament any crashes of your bot will be treated as Move.STAY command.
  6. Please limit the processing time of your bot. Currently there's a hard limit of 20ms average time-per-move as measured on my laptop using time_trails.py. Please talk to me (Hein) if you think this is too short. You can also use a profiler to try and make your code faster.
  7. Your bot must be your own creation. This rule is so that you may not blatantly copy someone's bot, change only a few lines, and then submit it as your own. Some code duplication is of course inevitable and thus allowed, because the logic might be similar between bots.
  8. No multithreading is allowed.

Profiling Your Bot

One aspect of the challenge is to try and optimize your bot's processing time to become the most efficient. One way to do it in Python using cPython by following these steps:

# Run the tournament through a profiler
# It might be worth it to remove most other 
# processing-intensive bots from the tournament,
# which could give clearer results on your bot
python3 -m cProfile -o output.pstats tournament.py

# The generated file can displayed in multiple ways. One way is turn 
# this into an image, like this:
python3 -m gprof2dot -f pstats output.pstats | dot -Tpng -o output.png

This will create an image containing a flowchart with blocks representing functions. The redder the block, the more time is taken to process that function. You can use this as direction on where to optimize your code. For example, it showed that in a bot I created the np.clip function was taking the majority of time, which I would never have suspected. I then changed my code to not require the clip function, which significantly sped up mu code.

Important: Premature optimization is the root of all evil. First ensure your bot is functioning properly before attempting optimiziation.

Some Statistics

Below is a histogram created on March 18 showing the distrubution of scores achieved by different bots (ignoring id10plus and RickbrandtVanRijn).

About

A coding challenge where you write the logic for a small bot that needs to fill a canvas with it's own colour. Be weary of opponents who will paint over your hard work!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%