Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alvarofpp/docker-s2client
This docker image was built to facilitate the development of scripted bots and research using the s2client-proto.
https://github.com/alvarofpp/docker-s2client
docker docker-image hacktoberfest s2client-api starcraft-ii
Last synced: 2 days ago
JSON representation
This docker image was built to facilitate the development of scripted bots and research using the s2client-proto.
- Host: GitHub
- URL: https://github.com/alvarofpp/docker-s2client
- Owner: alvarofpp
- License: bsd-3-clause
- Created: 2021-06-28T21:24:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-24T21:50:15.000Z (9 months ago)
- Last Synced: 2024-02-24T22:38:08.487Z (9 months ago)
- Topics: docker, docker-image, hacktoberfest, s2client-api, starcraft-ii
- Language: Shell
- Homepage: https://hub.docker.com/r/alvarofpp/s2client
- Size: 31.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker for StarCraft II Client
[][docker-hub]
This docker image was built to facilitate the development of scripted bots and research using the [s2client-proto][s2client-proto].
## Tags
This docker image have one tag for each one version listed in [Linux Packages][s2client-proto-linux].
You can see all tags [here][docker-hub-tags].
Example: if you want to take the version 4.9.3, you need to specify this version in the docker pull command:
`docker pull alvarofpp/s2client:4.9.3`.
The `latest` is the same image of the `4.10`, because it's the latest version until this moment.
If you use the `latest` version, you can ignore the `:` in these commands below.
## Getting Started
These instructions will cover usage information and for the docker container.
### Prerequisites
In order to run this container you'll need docker installed.
- [Get Started][docker-get-started]
### Usage
Docker pull command:
```shell
docker pull alvarofpp/s2client:
```
And run the client:
```shell
docker run --rm alvarofpp/s2client: run_client
```
Run your client in a specific port:
```shell
docker run --rm --env CLIENT_PORT=13000 alvarofpp/s2client: run_client
```
#### Environment Variables
- `CLIENT_PORT` - The port the client runs on. By default is `12000`.
## Maps and minigames
This image already comes with the all maps listed in [Map Packs][map-packs]
and the [pysc2's minigames (version 1.2)][minigames].
But if you need add more maps or minigames, you can through the command:
```shell
docker cp :/root/StarCraftII/Maps/
```
All maps and minigames downloaded for the image are listed in `image/maps.txt`.
## Use multi-stage builds
Using Docker's multi-stage, you can copy the StarCraft 2 files
and use it in your own Docker image.
```dockerfile
FROM alvarofpp/s2client:4.10 AS sc2client
FROM python:3.9.10
# ...
COPY --from=sc2client /root/StarCraftII /root/StarCraftII
```
## Display graphics (Linux)
If you want to display graphics during the script execution, you can follow the steps below.
### Step 1
```shell
docker run -i -t -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix:ro alvarofpp/s2client:
```
Description:
- `-i`: sets up an interactive session;
- `-t`: allocates a pseudo tty;
- `-e`: sets the host display to the local machines display (which will usually be `:0`);
- `-v`: bind mounts the `X11` socket residing in `/tmp/.X11-unix` on your
local machine into `/tmp/.X11-unix` in the container and `:ro` makes the socket read only.
### Step 2
In your local machine:
```shell
xhost +
# access control disabled, clients can connect from any host
xhost
# access control disabled, clients can connect from any host
# SI:localuser:username
```
Save the last line of the `xhost` result (in this example it's `SI:localuser:username`)
for use in the next step.
### Step 3
In your docker container:
```shell
xhost +si:localuser:username
# localuser:username being added to access control list
```
Done! After that, you can run your script.
Reference [here][stackoverflow-x11].
## Contributing
Contributions are more than welcome. Fork, improve and make a pull request.
For bugs, ideas for improvement or other, please create an [issue][github-issues].
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
If you use this docker image, you also agree to [AI and Machine Learning License][blizzard-ai-ml-license].
[blizzard-ai-ml-license]: http://blzdistsc2-a.akamaihd.net/AI_AND_MACHINE_LEARNING_LICENSE.html
[docker-get-started]: https://docs.docker.com/get-started/
[docker-hub]: https://hub.docker.com/r/alvarofpp/s2client
[docker-hub-tags]: https://hub.docker.com/r/alvarofpp/s2client/tags
[s2client-proto]: https://github.com/Blizzard/s2client-proto
[s2client-proto-linux]: https://github.com/Blizzard/s2client-proto#linux-packages
[map-packs]: http://blzdistsc2-a.akamaihd.net/MapPacks/Ladder2017Season3_Updated.zip
[minigames]: https://github.com/deepmind/pysc2/releases/tag/v1.2
[stackoverflow-x11]: https://stackoverflow.com/questions/25281992/alternatives-to-ssh-x11-forwarding-for-docker-containers
[github-issues]: https://github.com/alvarofpp/docker-s2client/issues