sc2.paths module
import os from pathlib import Path import platform import re import logging logger = logging.getLogger(__name__) BASEDIR = { "Windows": "C:/Program Files (x86)/StarCraft II", "Darwin": "/Applications/StarCraft II", "Linux": "~/StarCraftII", "WineLinux": "~/.wine/drive_c/Program Files (x86)/StarCraft II", } USERPATH = { "Windows": "\\Documents\\StarCraft II\\ExecuteInfo.txt", "Darwin": "/Library/Application Support/Blizzard/StarCraft II/ExecuteInfo.txt", "Linux": None, "WineLinux": None, } BINPATH = { "Windows": "SC2_x64.exe", "Darwin": "SC2.app/Contents/MacOS/SC2", "Linux": "SC2_x64", "WineLinux": "SC2_x64.exe", } CWD = { "Windows": "Support64", "Darwin": None, "Linux": None, "WineLinux": "Support64", } PF = os.environ.get("SC2PF", platform.system()) def get_env(): # TODO: Linux env conf from: https://github.com/deepmind/pysc2/blob/master/pysc2/run_configs/platforms.py return None def latest_executeble(versions_dir): latest = max((int(p.name[4:]), p) for p in versions_dir.iterdir() if p.is_dir() and p.name.startswith("Base")) version, path = latest if version < 55958: logger.critical(f"Your SC2 binary is too old. Upgrade to 3.16.1 or newer.") exit(1) return path / BINPATH[PF] class _MetaPaths(type): """"Lazily loads paths to allow importing the library even if SC2 isn't installed.""" def __setup(self): if PF not in BASEDIR: logger.critical(f"Unsupported platform '{PF}'") exit(1) try: base = os.environ.get("SC2PATH") if base is None and USERPATH[PF] is not None: einfo = str(Path.home().expanduser()) + USERPATH[PF] if os.path.isfile(einfo): with open(einfo) as f: content = f.read() if content: base = re.search(r" = (.*)Versions", content).group(1) if not os.path.exists(base): base = None if base is None: base = BASEDIR[PF] self.BASE = Path(base).expanduser() self.EXECUTABLE = latest_executeble(self.BASE / "Versions") self.CWD = self.BASE / CWD[PF] if CWD[PF] else None self.REPLAYS = self.BASE / "Replays" if (self.BASE / "maps").exists(): self.MAPS = self.BASE / "maps" else: self.MAPS = self.BASE / "Maps" except FileNotFoundError as e: logger.critical(f"SC2 installation not found: File '{e.filename}' does not exist.") exit(1) def __getattr__(self, attr): self.__setup() return getattr(self, attr) class Paths(metaclass=_MetaPaths): """Paths for SC2 folders, lazily loaded using the above metaclass."""
Module variables
var BASEDIR
var BINPATH
var CWD
var PF
var USERPATH
var logger
Functions
def get_env(
)
def get_env(): # TODO: Linux env conf from: https://github.com/deepmind/pysc2/blob/master/pysc2/run_configs/platforms.py return None
def latest_executeble(
versions_dir)
def latest_executeble(versions_dir): latest = max((int(p.name[4:]), p) for p in versions_dir.iterdir() if p.is_dir() and p.name.startswith("Base")) version, path = latest if version < 55958: logger.critical(f"Your SC2 binary is too old. Upgrade to 3.16.1 or newer.") exit(1) return path / BINPATH[PF]
Classes
class Paths
Paths for SC2 folders, lazily loaded using the above metaclass.
Ancestors (in MRO)
- Paths
- builtins.object