Latest version
Released:
A StarCraft II bot gym env library over python-sc2
Project description
This library provide python-sc2 as a gym environment.So you benefits both from the sc2.BotAI and gym.Env classes to train your bot using existing algorithms.
- Basically just drag and drop the.SC2Map file onto the SC2Switcher.exe file in the Starcraft II/Support folder.
- Official map downloads are available from Blizzard/s2client-proto. Notice: the map files are to be extracted into subdirectories of the install-dir/Maps directory. After installing the library, a StarCraft II executable, and some maps, you're ready to get started. Simply run a bot file to fire up an instance of StarCraft II with the.
Download free maps and mods for StarCraft 2! StarCraft II: Wings of Liberty is a military science fiction real-time strategy video game developed and released by Blizzard Entertainment.
This library (currently) covers only the raw scripted interface. At this time I don't intend to add support for graphics-based interfaces.
Documentation
How To Install Starcraft 2 Maps
class Sc2Env(gym.Env)
def init(self, map, bot_race, get_opponents, **kwargs):
map
strupper camel case name of an installed map (ex: KingsCoveLE)bot_race
strrace of the bot (ex: Zerg)get_opponents
Callablethe opponents of the bot- returns a
listofAbstractPlayer(BotAI, Player...)
- returns a
initializer
CallableCalled on start, must set BotAI.action_space and BotAI.observation_space.The defined spaces must inherit from gym.spaces.space.Space.example:
''pythondef initializer(bot):bot.action_space = gym.spaces.Box(5,10)bot.observation_space = gym.spaces.Box(3,11)''
observer:
asyncCallableCalled on step takes asc2.BotAIinstance, must return an observation and a reward.An observation is anumpy.arraymatching the observation space and a reward isnumber.actuator:
asyncCallableCalled on step, takes asc2.BotAIinstance and an action.An action is anumpy.arraymatching the action space.Used to run actions using in sc2.**kwargs
anysc2.run_game extra arguments
More on sc2.BotAI here.
Installation
By installing this library you agree to be bound by the terms of the AI and Machine Learning License.
You'll need Python 3.6 or newer.
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.. Linux users get the best experience by installing the Windows version of StarCraft II with Wine. Linux user can also use the Linux binary, but it's headless so you cannot actually see the game.
You probably want some maps too. Official map downloads are available from Blizzard/s2client-proto. Notice: the map files are to be extracted into subdirectories of the install-dir/Maps directory.
Running
After installing the library, a StarCraft II executable, and some maps, you're ready to get started. Look at the dummy bot example!
If you installed StarCraft II on Linux with Wine, set the SC2PF environment variable to WineLinux:
Release historyRelease notifications | RSS feed
0.11.1.2
0.11.1.1
0.11.1
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size sc2_env-0.11.1.2-py3-none-any.whl (89.9 kB) | File type Wheel | Python version py3 | Upload date | Hashes |
| Filename, size sc2-env-0.11.1.2.tar.gz (78.4 kB) | File type Source | Python version None | Upload date | Hashes |
Starcraft 2 Map Creator
Hashes for sc2_env-0.11.1.2-py3-none-any.whl
| Algorithm | Hash digest |
|---|---|
| SHA256 | ed289b6cdb6d22e437a98eb6989ace605aef7a0a14492260b906851fe7b71a4b |
| MD5 | fbe2eb6eb35a5b0015fc8d891406080b |
| BLAKE2-256 | 87842cb5795f110834009d75886e0df5076987ffc660dda2baefdf01acf8d229 |
Hashes for sc2-env-0.11.1.2.tar.gz
By installing this library you agree to be bound by the terms of the AI and Machine Learning License.
You'll need Python 3.6 or newer.
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.. Linux users get the best experience by installing the Windows version of StarCraft II with Wine. Linux user can also use the Linux binary, but it's headless so you cannot actually see the game.
You probably want some maps too. Official map downloads are available from Blizzard/s2client-proto. Notice: the map files are to be extracted into subdirectories of the install-dir/Maps directory.
Running
After installing the library, a StarCraft II executable, and some maps, you're ready to get started. Look at the dummy bot example!
If you installed StarCraft II on Linux with Wine, set the SC2PF environment variable to WineLinux:
Release historyRelease notifications | RSS feed
0.11.1.2
0.11.1.1
0.11.1
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size sc2_env-0.11.1.2-py3-none-any.whl (89.9 kB) | File type Wheel | Python version py3 | Upload date | Hashes |
| Filename, size sc2-env-0.11.1.2.tar.gz (78.4 kB) | File type Source | Python version None | Upload date | Hashes |
Starcraft 2 Map Creator
Hashes for sc2_env-0.11.1.2-py3-none-any.whl
| Algorithm | Hash digest |
|---|---|
| SHA256 | ed289b6cdb6d22e437a98eb6989ace605aef7a0a14492260b906851fe7b71a4b |
| MD5 | fbe2eb6eb35a5b0015fc8d891406080b |
| BLAKE2-256 | 87842cb5795f110834009d75886e0df5076987ffc660dda2baefdf01acf8d229 |
Hashes for sc2-env-0.11.1.2.tar.gz
| Algorithm | Hash digest |
|---|---|
| SHA256 | 7c09d990e965d9262aa47b12117187ab9bf7f77f5869f399ed774bdf0ae90484 |
| MD5 | 827c43832b1f5fa837ae12ac0ecd2229 |
| BLAKE2-256 | 657729954ccd79868c61ee17fc551acf341c30175a17939401d30b72e87c2f96 |
