This repository contains fully working StarCraft game running in Wine inside of docker image.
UPDATE (2018-01-10): the final dev version will be merged into master in a few days, current master might not work as expected.
We are pleased to publish StarCraft I - BroodWar docker images!
This means the end of complicated game setup for newcomers, or people who would like to simply play SC1 game against some bot.
You can also develop your bots on your favorite platform instead of relying on Windows.
There are still many things to do, and we will be working on improvements.
We have more things cooking: It is a part of our ongoing effor to create environment for reinforcement learning bots (bots that improve through self-play).
If you'd like to support our effort on Patreon, we would be very grateful! [link]
Install VNC viewer (for viewing headful modes) - we used TigerVNC
It should run on all operating systems (but was tested only on
Linux 4.10.0-40-generic x86_64 with Docker version 17.09.0-ce, build afdb6d4).
There might be problems with docker container networking on Mac/Windows, because these use virtualization of docker images and has to pass through special docker gateway.
- StarCraft 1.16.1 game from ICCUP (no need for special installs!)
- BWAPI 4.1.2
- BWTA 2.2
- SSCAI maps pack
- 32bit Java
- bwheadless
- wine 2.20.0~xenial
- base image
ubuntu:xenial
$ chmod 777 bots logs
Launch a headless play of PurpleWave (P as Protoss) against Example Bot on default map.
$ ./run_bots.sh ExampleBot:T PurpleWave:P
f463e69d-7bbd-4638-a9a4
Let's watch logs to see what is happenning in headless mode.
You will need to have tmux installed.
$ ./watch_logs.sh f46
(you don't need to specify the whole game name, just few chars)
After a moment, PurpleWave should win the game and you'll get similar output to this:
Stop all running games (docker containers):
$ docker stop $(docker ps -a -q)
Play against a bot (follow instructions)
./play_against_bots.sh PurpleWave:P
To watch headful game between bots (with gui):
$ ./run_bots.sh ExampleBot:T PurpleWave:P
$ tigervnc
Set tigervnc port to 5900, IP address 172.18.0.3 and password starcraft.
You have to join the game manually - via multiplayer.
IP address troubleshooting: you may need to find container IP address, try something like
$ docker inspect -f '{{range .NetworkSss}}{{end}}' f73e612e-efb4-4b14-97e2_cfd8_bot_PurpleWave
Use proper container name.
./run_bots.sh --help
./play_against_bots.sh --help
Simply place your java bot to bots/ directory.
You can see logs from the games in logs/ directory.
Images are also available on Dockerhub.
You can use:
ggaic/starcraft:wine
ggaic/starcraft:bwapi
ggaic/starcraft:java
ggaic/starcraft:play
These are development images, and are subject to change. Stable images have version postfix, and correspond to git tags.
The run_bots.sh and play_against_bots.sh use docker image starcraft:play
PRs are welcome!
Especially from todo list.
Build images:
./build_images.sh
The run_bots.sh and play_against_bots.sh have special flags --local
which will lead to use of local instead of dockerhub images.
- add support for C/C++ bots
- set custom game speed, see how we could integrate bwapi.ini?
- benchmark simulations on top game speed
- add option to launch starcraft game, and bots can connect to it repeatedly (save time for repeated plays)
- add some UUID for human games
- add support for singularity containers
- add cached parsed maps: https://github.com/vjurenka/BWMirror/tree/master/bwapi-data/BWTA2
- save replays after game is done into logs folder (or maybe some other one)
- output winner - X vs Y, if Y wins -> output "Y"
- viewing headful via VNC, simplify the process. Maybe use bwapi.ini for hosts?
- sound support (ALSA) :-)
This will go into another repo:
- support "tournament" mode, where a pool of bots can play against each other. Calculate ELO ratings.
- Distributed play - pool of workers which will receive info about who is to play with whom and they would run the simulation. Probably will use RabbitMQ.
If you use sc-docker in your (academic) work, please cite us:
@misc{sustr2018multi,
Author = {Michal \v{S}ustr and Jan Mal\'{y} and Michal \v{C}ertick\'{y}},
Title = {{Multi-platform Version of StarCraft: Brood War in a Docker Container: Technical Report}},
Year = {2018},
Eprint = {arXiv:1801.02193},
}