[WSL-SUPPORT] Update README.md
Adds notes on running the game from WSL.
@@ -54,6 +54,8 @@ After installing the library, a StarCraft II executable, and some maps, you're r
python3 examples/protoss/cannon_rush.py
```
+#### WINE and Lutris
+
If you installed StarCraft II on Linux with Wine or Lutris, set the following environment variables (either globally or within your development environment, e.g. Pycharm: `Run -> Edit Configurations -> Environment Variables`):
```sh
@@ -65,6 +67,19 @@ WINE=usr/bin/wine
SC2PATH=/home/burny/Games/battlenet/drive_c/Program Files (x86)/StarCraft II/
```
+#### WSL
+
+To run from a WSL1 instance, set `SC2PF=WSL1`. You may be asked to allow Python through your firewall.
+
+To run from a WSL2 instance, set `SC2PF=WSL2`. You also must supply
+
+```sh
+SC2CLIENTHOST=<your windows IP>
+SC2SERVERHOST=0.0.0.0
+```
+
+You can find your Windows IP using `ipconfig /all` from `PowerShell.exe` or `CMD.exe`.
+
## Example
As promised, worker rush in less than twenty lines:
