Dependencies:

• Python 3
• pyglet

Rolympics requires Python 3. On Linux, use pyenv (recommended) or your package manager, to install Python 3. On Mac and Windows, it is recommended to install the Anaconda environment.

Before starting the program, pyglet must be installed. The easiest way to achieve this is through pip.

pip install pyglet

Read on to find out how to run pip in your terminal in Mac/Windows.

This assumes you have Anaconda (see above) installed. Start the Anaconda Prompt. At the command prompt, type:

C:\Users\S> pip install pyglet

(You have to typ pip install pyglet only, then press ; the C:\Users\S> is part of the prompt).

Open a Terminal and install pyglet typing:

$ pip install pyglet

(You have to type pip install piglet only, then press ; the $ sign is part of Terminal).

To run the simulation, open a terminal (see above), navigate into the project directory, and type

python run.py

The simulation should appear.

On Windows, the terminal to use is called Anaconda Prompt; in Mac, use the Terminal App; in Linux, you know where the terminal is... ;)

To change into the project directory in a terminal, use the cd command.

For example, in Windows, after opening the terminal the prompt may read C:\Users\S\Documents. You are in the directory Documents, which itself is inside S, which itself is inside Users.

C:
  |-- Users
      |-- S
          |-- Documents
          |-- Desktop
              |-- rolympics-master

To get into the project directory rolympics-master, you need to type:

C:\Users\S\Documents> cd ..
C:\Users\S> cd Desktop
C:\Users\S\Desktop> cd rolympics-master
C:\Users\S\Desktop\rolympics-master>  python run.py

You are now inside the project directory, type python run.py to start!

All robots can be found in lib/rolympics/robots/. When the program starts, each robot will be assigned to either team A or team B and placed at a random position.

To create your own robot, copy an existing robot and rename the file. Make sure to place the new file in lib/rolympics/robots/. Make sure the files ends with .py.

Assuming you created the file lib/rolympics/robots/my_robot.py, edit that file as follows:

 class MyRobot(Robot):  # The name after class must be the same as the file name, in camel-case.
   def __init__(self,*args,**kwargs):
      self.name('My Robot') # Set the name/label of your new robot to a name you choose!
      
   def adjust(self, bx, by):
      # Adjust the robots target self.tx/self.ty, given the position of the ball bx/by.
      # The robots current position can be found in self.x/self.y.
      pass