Lugo - The Dummies Py

The Dummies Py is a Python implementation of a player (bot) for Lugo game.

This bot was made using the Python Client Player.

Use this bot as a starting point to a new one.

Dependencies

Docker (https://docs.docker.com/get-docker/)
Docker Compose (https://docs.docker.com/compose/install/)

Before starting

Are you familiar with Lugo? If not, before continuing, please visit the project website and read about the game.

Quick setup (if you do not want to download or clone the code)

You may use the SetupEnvPy Docker image to set up the environment for you:

Open the terminal on an empty directory that will host your bot's source code (Use Powershell on Windows)

Run the following command to set up the project quick start kit

# on Lunix or Mac
docker run -v $(pwd):/output lugobots/setup-env-py:latest

# on Windows
docker run -v ${PWD}:/output lugobots/setup-env-py:latest

(only Linux and Mac) Fix the file permissions running chown $USER -R .

How to use this source code

(optional to speed up next steps) Download the images that you will need

docker pull lugobots/server
docker pull lugobots/the-dummies-go:latest
docker pull python:3.9-slim-buster

Run the builder service that will install the depencencies you need (wait for the service to finish):
```
docker compose up builder
```
Test it out: Before any change, make the Dummies Py play to ensure you are not working on a broken code.
```
docker compose up
```
and open http://localhost:8080/ to watch the game.
Now, make your changes: (see ❓How to change the bot)
Play again to see your changes results:
```
docker compose up
```

Are you ready to compete? Build your Docker image:

docker build -t repo.lugobots.dev/[bot handle]:[version] .

How to edit the bot

Main file main.py

You will not change this file. It only initializes the bot.

Settings file settings.py

Settings file only stores configurations that will affect the player behaviour, e.g. positions, tactic, etc.

My bot my_bot.py

👀 This is the most important file!

There will be 5 important methods that you must edit to change the bot behaviour.

    def on_disputing (self, orderSet: lugo4py.OrderSet, snapshot: GameSnapshot) -> OrderSet:
        # on_disputing is called when no one has the ball possession
        pass

    @abstractmethod
    def on_defending (self, orderSet: OrderSet, snapshot: GameSnapshot) -> OrderSet:
        # OnDefending is called when an opponent player has the ball possession
        pass

    @abstractmethod
    def on_holding (self, orderSet: OrderSet, snapshot: GameSnapshot) -> OrderSet:
        # OnHolding is called when this bot has the ball possession
        pass

    @abstractmethod
    def on_supporting (self, orderSet: OrderSet, snapshot: GameSnapshot) -> OrderSet:
        # OnSupporting is called when a teammate player has the ball possession
        pass

    @abstractmethod
    def as_goalkeeper (self, orderSet: OrderSet, snapshot: GameSnapshot, state: PLAYER_STATE) -> OrderSet:
        # AsGoalkeeper is only called when this bot is the goalkeeper (number 1). This method is called on every turn,
        # and the player state is passed at the last parameter.
        pass

    @abstractmethod
    def getting_ready (self, snapshot: GameSnapshot):
        # getting_ready will be called before the game starts and after a goal event. You will only need to implement
        # this method in very rare cases.
        pass

Running directly in your machine (:ninja: advanced)

If you want to run the Python code in your machine instead of inside the container, you definitely can do this.

The command to start locally is BOT_TEAM=home BOT_NUMBER=1 python3.9 main.py. However, when you run the Docker compose file, all players from both teams will start. Then, if you run another bot directly from your machine, it will not be allowed to join the game.

But you also cannot start your bot before the game server has started.

You have two options to run your bot locally.

Option 1 - comment out the bot from the Docker compose file

You can edit the file docker-compose.yml and comment out the player 2 of the home team.

The game server will wait all 11 players from both teams to connect before starting the game.

Option 2 - starting the game server first

You can start only the game server with the command docker compose up -d game_server. The game will wait for the players. Then, you start your local bot (BOT_TEAM=home BOT_NUMBER=1 python3.9 main.py), and finally start the rest of the players with the command docker compose up

diksown/the-dummies-py