Skip to content

Commit 2b27613

Browse files
committed
Added README and img/.
1 parent cf84ba5 commit 2b27613

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

README.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# robots
2+
3+
AI-controlled teams of robots battle it out on a 2D battlefield.
4+
5+
<img src="img/robots.png" alt="robots" width="200"/>
6+
7+
## Overview
8+
9+
**robots** is a real-time 2D game where teams of robots compete to destroy each other.
10+
Robots are controlled by AIs running over network connections.
11+
Players compete by writing an AI to control robots.
12+
13+
## The robots
14+
15+
Each robot is identical and is fitted with two weapons:
16+
17+
* **laser**: this has unlimited ammunition, but has a limited range and will overheat if overused (requiring a cool-down period). Lasers do a small amount of damage.
18+
* **missile**: this can be fired only once. It has unlimtied range and will travel indefinitely until it hits a robot. A missile hit will destroy a robot.
19+
20+
Robots act independently, but may communicate to nearby robots through a system of coloured signals.
21+
22+
## Usage
23+
24+
Start a game world server:
25+
```shell
26+
./main.py
27+
```
28+
29+
Start a single robot running AI/ExampleAI, joining team 3, on a server running at localhost port 12345:
30+
```shell
31+
./Client.py --ai=ExampleAI --team=3 --server=localhost:12345
32+
```
33+
34+
Once robots successfully connect to the game world they immediately start to act autonomously according to their AI.
35+
36+
## Writing an AI
37+
38+
TODO
39+
40+
## Known issues
41+
42+
* Very messy graphics code.
43+
* Game world server/port currently cannot be specified.
44+
* Laser cooldown is wrong.
45+

img/robots.png

19.1 KB
Loading

0 commit comments

Comments
 (0)