Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Dentosal committed Aug 16, 2017
1 parent 950679f commit 90915a4
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
@@ -1,6 +1,20 @@
# Phyton - A StarCraft II bot api client library for Python 3
# A StarCraft II bot api client library for Python 3

Phyton is an easy-to-use library for wrting AI Bots for StarCraft II in Python 3. The ultimate goal is simplicity and ease of use, while still preserving all funcionality. A really simple worker rush bot should be no more than twenty lines of code, not two hundred. This library covers only the scripted (raw) interface.
An easy-to-use library for wrting AI Bots for StarCraft II in Python 3. The ultimate goal is simplicity and ease of use, while still preserving all funcionality. A really simple worker rush bot should be no more than twenty lines of code, not two hundred.

**This library (currently) covers only the raw scripted interface.** At this time I don't ident to add support for graphics-based iterfaces.

## Installation

```
pip3 install --upgrade git+https://github.com/Dentosal/python-sc2
```

You'll also need an StarCraft II executable. If you are running Windows or macOS, just install the normal SC2 from blizzard app. [The free starter edition works too.](https://us.battle.net/account/sc2/starter-edition/). Linux users must use the [Linux binary](https://github.com/Blizzard/s2client-proto#downloads).

You probably want some maps too. Offical map downloads are available from [Blizzard/s2client-proto](https://github.com/Blizzard/s2client-proto#downloads),

## Example

As promised, worker rush in less than twenty lines:

Expand All @@ -25,3 +39,5 @@ run_game(maps.get("Abyssal Reef LE"), [
Computer(Race.Protoss, Difficulty.Medium)
], realtime=True)
```

This is probably the simplest bot that has any realistic chances of winning the game. I have ran it against the medium AI quite a few times, and once in a while it wins.

0 comments on commit 90915a4

Please sign in to comment.