mirror of
https://github.com/derrod/legendary.git
synced 2024-06-27 02:30:30 +12:00
888d62a96d
Primarily intended to make it easier for third-party applications (mainly Heroic) to handle launch options on their own by simply taking the necessary information from legendary and ignoring user-defined stuff. Also useful for debugging.
164 lines
5.9 KiB
Python
164 lines
5.9 KiB
Python
# coding: utf-8
|
|
|
|
from dataclasses import dataclass, field
|
|
from enum import Enum
|
|
|
|
class GameAsset:
|
|
def __init__(self):
|
|
self.app_name = ''
|
|
self.asset_id = ''
|
|
self.build_version = ''
|
|
self.catalog_item_id = ''
|
|
self.label_name = ''
|
|
self.namespace = ''
|
|
self.metadata = dict()
|
|
|
|
@classmethod
|
|
def from_egs_json(cls, json):
|
|
tmp = cls()
|
|
tmp.app_name = json.get('appName', '')
|
|
tmp.asset_id = json.get('assetId', '')
|
|
tmp.build_version = json.get('buildVersion', '')
|
|
tmp.catalog_item_id = json.get('catalogItemId', '')
|
|
tmp.label_name = json.get('labelName', '')
|
|
tmp.namespace = json.get('namespace', '')
|
|
tmp.metadata = json.get('metadata', {})
|
|
return tmp
|
|
|
|
@classmethod
|
|
def from_json(cls, json):
|
|
tmp = cls()
|
|
tmp.app_name = json.get('app_name', '')
|
|
tmp.asset_id = json.get('asset_id', '')
|
|
tmp.build_version = json.get('build_version', '')
|
|
tmp.catalog_item_id = json.get('catalog_item_id', '')
|
|
tmp.label_name = json.get('label_name', '')
|
|
tmp.namespace = json.get('namespace', '')
|
|
tmp.metadata = json.get('metadata', {})
|
|
return tmp
|
|
|
|
|
|
class Game:
|
|
def __init__(self, app_name='', app_title='', asset_info=None, app_version='', metadata=None):
|
|
self.metadata = dict() if metadata is None else metadata # store metadata from EGS
|
|
self.asset_info = asset_info if asset_info else GameAsset() # asset info from EGS
|
|
|
|
self.app_version = app_version
|
|
self.app_name = app_name
|
|
self.app_title = app_title
|
|
self.base_urls = [] # base urls for download, only really used when cached manifest is current
|
|
|
|
@property
|
|
def is_dlc(self):
|
|
return self.metadata and 'mainGameItem' in self.metadata
|
|
|
|
@property
|
|
def supports_cloud_saves(self):
|
|
return self.metadata and (self.metadata.get('customAttributes', {}).get('CloudSaveFolder') is not None)
|
|
|
|
@classmethod
|
|
def from_json(cls, json):
|
|
tmp = cls()
|
|
tmp.metadata = json.get('metadata', dict())
|
|
tmp.asset_info = GameAsset.from_json(json.get('asset_info', dict()))
|
|
tmp.app_name = json.get('app_name', 'undefined')
|
|
tmp.app_title = json.get('app_title', 'undefined')
|
|
tmp.app_version = json.get('app_version', 'undefined')
|
|
tmp.base_urls = json.get('base_urls', list())
|
|
return tmp
|
|
|
|
@property
|
|
def __dict__(self):
|
|
"""This is just here so asset_info gets turned into a dict as well"""
|
|
return dict(metadata=self.metadata, asset_info=self.asset_info.__dict__,
|
|
app_name=self.app_name, app_title=self.app_title,
|
|
app_version=self.app_version, base_urls=self.base_urls)
|
|
|
|
|
|
class InstalledGame:
|
|
def __init__(self, app_name='', title='', version='', manifest_path='', base_urls=None,
|
|
install_path='', executable='', launch_parameters='', prereq_info=None,
|
|
can_run_offline=False, requires_ot=False, is_dlc=False, save_path=None,
|
|
needs_verification=False, install_size=0, egl_guid='', install_tags=None):
|
|
self.app_name = app_name
|
|
self.title = title
|
|
self.version = version
|
|
|
|
self.manifest_path = manifest_path
|
|
self.base_urls = list() if not base_urls else base_urls
|
|
self.install_path = install_path
|
|
self.executable = executable
|
|
self.launch_parameters = launch_parameters
|
|
self.prereq_info = prereq_info
|
|
self.can_run_offline = can_run_offline
|
|
self.requires_ot = requires_ot
|
|
self.is_dlc = is_dlc
|
|
self.save_path = save_path
|
|
self.needs_verification = needs_verification
|
|
self.install_size = install_size
|
|
self.egl_guid = egl_guid
|
|
self.install_tags = install_tags if install_tags else []
|
|
|
|
@classmethod
|
|
def from_json(cls, json):
|
|
tmp = cls()
|
|
tmp.app_name = json.get('app_name', '')
|
|
tmp.version = json.get('version', '')
|
|
tmp.title = json.get('title', '')
|
|
|
|
tmp.manifest_path = json.get('manifest_path', '')
|
|
tmp.base_urls = json.get('base_urls', list())
|
|
tmp.install_path = json.get('install_path', '')
|
|
tmp.executable = json.get('executable', '')
|
|
tmp.launch_parameters = json.get('launch_parameters', '')
|
|
tmp.prereq_info = json.get('prereq_info', None)
|
|
|
|
tmp.can_run_offline = json.get('can_run_offline', False)
|
|
tmp.requires_ot = json.get('requires_ot', False)
|
|
tmp.is_dlc = json.get('is_dlc', False)
|
|
tmp.save_path = json.get('save_path', None)
|
|
tmp.needs_verification = json.get('needs_verification', False) is True
|
|
tmp.install_size = json.get('install_size', 0)
|
|
tmp.egl_guid = json.get('egl_guid', '')
|
|
tmp.install_tags = json.get('install_tags', [])
|
|
return tmp
|
|
|
|
|
|
class SaveGameFile:
|
|
def __init__(self, app_name='', filename='', manifest='', datetime=None):
|
|
self.app_name = app_name
|
|
self.filename = filename
|
|
self.manifest_name = manifest
|
|
self.datetime = datetime
|
|
|
|
|
|
class SaveGameStatus(Enum):
|
|
LOCAL_NEWER = 0
|
|
REMOTE_NEWER = 1
|
|
SAME_AGE = 2
|
|
NO_SAVE = 3
|
|
|
|
|
|
class VerifyResult(Enum):
|
|
HASH_MATCH = 0
|
|
HASH_MISMATCH = 1
|
|
FILE_MISSING = 2
|
|
OTHER_ERROR = 3
|
|
|
|
|
|
@dataclass
|
|
class LaunchParameters:
|
|
# game-supplied parameters
|
|
game_parameters: list = field(default_factory=list)
|
|
game_executable: str = ''
|
|
game_directory: str = ''
|
|
# EGL parameters (auth, ovt, etc.)
|
|
egl_parameters: list = field(default_factory=list)
|
|
# command line before executable (WINE, gamemode, etc.)
|
|
launch_command: list = field(default_factory=list)
|
|
# working directory for launched process
|
|
working_directory: str = ''
|
|
# user and environment supplied options
|
|
user_parameters: list = field(default_factory=list)
|
|
environment: dict = field(default_factory=dict)
|