mirror of
https://github.com/Omni-guides/Jackify.git
synced 2026-01-17 11:37:01 +01:00
cd591c14e3
Jackify provides native Linux support for Wabbajack modlist installation and management with automated Steam integration and Proton configuration. Key Features: - Almost Native Linux implementation (texconv.exe run via proton) - Automated Steam shortcut creation and Proton prefix management - Both CLI and GUI interfaces, with Steam Deck optimization Supported Games: - Skyrim Special Edition - Fallout 4 - Fallout New Vegas - Oblivion, Starfield, Enderal, and diverse other games Technical Architecture: - Clean separation between frontend and backend services - Powered by jackify-engine 0.3.x for Wabbajack-matching modlist installation
406 lines
16 KiB
Python
406 lines
16 KiB
Python
#!/usr/bin/env python3
|
|
"""
|
|
Native Steam Shortcut and Proton Management Service
|
|
|
|
This service replaces STL entirely with native Python VDF manipulation.
|
|
Handles both shortcut creation and Proton version setting reliably.
|
|
"""
|
|
|
|
import os
|
|
import sys
|
|
import time
|
|
import logging
|
|
import hashlib
|
|
import vdf
|
|
from pathlib import Path
|
|
from typing import Optional, Tuple, Dict, Any, List
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
class NativeSteamService:
|
|
"""
|
|
Native Steam shortcut and Proton management service.
|
|
|
|
This completely replaces STL with reliable VDF manipulation that:
|
|
1. Creates shortcuts with proper VDF structure
|
|
2. Sets Proton versions in the correct config files
|
|
3. Never corrupts existing shortcuts
|
|
"""
|
|
|
|
def __init__(self):
|
|
self.steam_path = Path.home() / ".steam" / "steam"
|
|
self.userdata_path = self.steam_path / "userdata"
|
|
self.user_id = None
|
|
self.user_config_path = None
|
|
|
|
def find_steam_user(self) -> bool:
|
|
"""Find the active Steam user directory"""
|
|
try:
|
|
if not self.userdata_path.exists():
|
|
logger.error("Steam userdata directory not found")
|
|
return False
|
|
|
|
# Find the first user directory (usually there's only one)
|
|
user_dirs = [d for d in self.userdata_path.iterdir() if d.is_dir() and d.name.isdigit()]
|
|
if not user_dirs:
|
|
logger.error("No Steam user directories found")
|
|
return False
|
|
|
|
# Use the first user directory
|
|
user_dir = user_dirs[0]
|
|
self.user_id = user_dir.name
|
|
self.user_config_path = user_dir / "config"
|
|
|
|
logger.info(f"Found Steam user: {self.user_id}")
|
|
logger.info(f"User config path: {self.user_config_path}")
|
|
return True
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error finding Steam user: {e}")
|
|
return False
|
|
|
|
def get_shortcuts_vdf_path(self) -> Optional[Path]:
|
|
"""Get the path to shortcuts.vdf"""
|
|
if not self.user_config_path:
|
|
if not self.find_steam_user():
|
|
return None
|
|
|
|
shortcuts_path = self.user_config_path / "shortcuts.vdf"
|
|
return shortcuts_path if shortcuts_path.exists() else shortcuts_path
|
|
|
|
def get_localconfig_vdf_path(self) -> Optional[Path]:
|
|
"""Get the path to localconfig.vdf"""
|
|
if not self.user_config_path:
|
|
if not self.find_steam_user():
|
|
return None
|
|
|
|
return self.user_config_path / "localconfig.vdf"
|
|
|
|
def read_shortcuts_vdf(self) -> Dict[str, Any]:
|
|
"""Read the shortcuts.vdf file safely"""
|
|
shortcuts_path = self.get_shortcuts_vdf_path()
|
|
if not shortcuts_path:
|
|
return {'shortcuts': {}}
|
|
|
|
try:
|
|
if shortcuts_path.exists():
|
|
with open(shortcuts_path, 'rb') as f:
|
|
data = vdf.binary_load(f)
|
|
return data
|
|
else:
|
|
logger.info("shortcuts.vdf does not exist, will create new one")
|
|
return {'shortcuts': {}}
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error reading shortcuts.vdf: {e}")
|
|
return {'shortcuts': {}}
|
|
|
|
def write_shortcuts_vdf(self, data: Dict[str, Any]) -> bool:
|
|
"""Write the shortcuts.vdf file safely"""
|
|
shortcuts_path = self.get_shortcuts_vdf_path()
|
|
if not shortcuts_path:
|
|
return False
|
|
|
|
try:
|
|
# Create backup first
|
|
if shortcuts_path.exists():
|
|
backup_path = shortcuts_path.with_suffix(f".vdf.backup_{int(time.time())}")
|
|
import shutil
|
|
shutil.copy2(shortcuts_path, backup_path)
|
|
logger.info(f"Created backup: {backup_path}")
|
|
|
|
# Ensure parent directory exists
|
|
shortcuts_path.parent.mkdir(parents=True, exist_ok=True)
|
|
|
|
# Write the VDF file
|
|
with open(shortcuts_path, 'wb') as f:
|
|
vdf.binary_dump(data, f)
|
|
|
|
logger.info("Successfully wrote shortcuts.vdf")
|
|
return True
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error writing shortcuts.vdf: {e}")
|
|
return False
|
|
|
|
def generate_app_id(self, app_name: str, exe_path: str) -> Tuple[int, int]:
|
|
"""
|
|
Generate AppID using STL's exact algorithm (MD5-based).
|
|
|
|
This matches STL's generateShortcutVDFAppId and generateSteamShortID functions:
|
|
1. Combine AppName + ExePath
|
|
2. Generate MD5 hash, take first 8 characters
|
|
3. Convert to decimal, make negative, ensure < 1 billion
|
|
4. Convert signed to unsigned for CompatToolMapping
|
|
|
|
Returns:
|
|
(signed_app_id, unsigned_app_id) - Both the signed and unsigned versions
|
|
"""
|
|
# STL's algorithm: MD5 of app_name + exe_path
|
|
input_string = f"{app_name}{exe_path}"
|
|
|
|
# Generate MD5 hash and take first 8 characters
|
|
md5_hash = hashlib.md5(input_string.encode('utf-8')).hexdigest()
|
|
seed = md5_hash[:8]
|
|
|
|
# Convert hex to decimal and make it negative with modulo 1 billion
|
|
seed_decimal = int(seed, 16)
|
|
signed_app_id = -(seed_decimal % 1000000000)
|
|
|
|
# Convert to unsigned using steam-conductor/trentondyck method (signed_app_id + 2^32)
|
|
unsigned_app_id = signed_app_id + 2**32
|
|
|
|
logger.info(f"Generated AppID using STL algorithm for '{app_name}' + '{exe_path}': {signed_app_id} (unsigned: {unsigned_app_id})")
|
|
return signed_app_id, unsigned_app_id
|
|
|
|
def create_shortcut(self, app_name: str, exe_path: str, start_dir: str = None,
|
|
launch_options: str = "%command%", tags: List[str] = None) -> Tuple[bool, Optional[int]]:
|
|
"""
|
|
Create a Steam shortcut using direct VDF manipulation.
|
|
|
|
Args:
|
|
app_name: The shortcut name
|
|
exe_path: Path to the executable
|
|
start_dir: Start directory (defaults to exe directory)
|
|
launch_options: Launch options (defaults to "%command%")
|
|
tags: List of tags to apply
|
|
|
|
Returns:
|
|
(success, unsigned_app_id) - Success status and the AppID
|
|
"""
|
|
if not start_dir:
|
|
start_dir = str(Path(exe_path).parent)
|
|
|
|
if not tags:
|
|
tags = ["Jackify"]
|
|
|
|
logger.info(f"Creating shortcut '{app_name}' for '{exe_path}'")
|
|
|
|
try:
|
|
# Read current shortcuts
|
|
data = self.read_shortcuts_vdf()
|
|
shortcuts = data.get('shortcuts', {})
|
|
|
|
# Generate AppID
|
|
signed_app_id, unsigned_app_id = self.generate_app_id(app_name, exe_path)
|
|
|
|
# Find next available index
|
|
indices = [int(k) for k in shortcuts.keys() if k.isdigit()]
|
|
next_index = max(indices, default=-1) + 1
|
|
|
|
# Get icon path from SteamIcons directory if available
|
|
icon_path = ''
|
|
steamicons_dir = Path(exe_path).parent / "SteamIcons"
|
|
if steamicons_dir.is_dir():
|
|
grid_tall_icon = steamicons_dir / "grid-tall.png"
|
|
if grid_tall_icon.exists():
|
|
icon_path = str(grid_tall_icon)
|
|
logger.info(f"Using icon from SteamIcons: {icon_path}")
|
|
else:
|
|
# Look for any PNG file
|
|
png_files = list(steamicons_dir.glob("*.png"))
|
|
if png_files:
|
|
icon_path = str(png_files[0])
|
|
logger.info(f"Using fallback icon: {icon_path}")
|
|
|
|
# Create the shortcut entry with proper structure
|
|
shortcut_entry = {
|
|
'appid': signed_app_id, # Use signed AppID in shortcuts.vdf
|
|
'AppName': app_name,
|
|
'Exe': f'"{exe_path}"',
|
|
'StartDir': f'"{start_dir}"',
|
|
'icon': icon_path,
|
|
'ShortcutPath': '',
|
|
'LaunchOptions': launch_options,
|
|
'IsHidden': 0,
|
|
'AllowDesktopConfig': 1,
|
|
'AllowOverlay': 1,
|
|
'OpenVR': 0,
|
|
'Devkit': 0,
|
|
'DevkitGameID': '',
|
|
'DevkitOverrideAppID': 0,
|
|
'LastPlayTime': 0,
|
|
'IsInstalled': 1, # Mark as installed so it appears in "Installed locally"
|
|
'FlatpakAppID': '',
|
|
'tags': {}
|
|
}
|
|
|
|
# Add tags
|
|
for i, tag in enumerate(tags):
|
|
shortcut_entry['tags'][str(i)] = tag
|
|
|
|
# Add to shortcuts
|
|
shortcuts[str(next_index)] = shortcut_entry
|
|
data['shortcuts'] = shortcuts
|
|
|
|
# Write back to file
|
|
if self.write_shortcuts_vdf(data):
|
|
logger.info(f"✅ Shortcut created successfully at index {next_index}")
|
|
return True, unsigned_app_id
|
|
else:
|
|
logger.error("❌ Failed to write shortcut to VDF")
|
|
return False, None
|
|
|
|
except Exception as e:
|
|
logger.error(f"❌ Error creating shortcut: {e}")
|
|
return False, None
|
|
|
|
def set_proton_version(self, app_id: int, proton_version: str = "proton_experimental") -> bool:
|
|
"""
|
|
Set the Proton version for a specific app using ONLY config.vdf like steam-conductor does.
|
|
|
|
Args:
|
|
app_id: The unsigned AppID
|
|
proton_version: The Proton version to set
|
|
|
|
Returns:
|
|
True if successful
|
|
"""
|
|
logger.info(f"Setting Proton version '{proton_version}' for AppID {app_id} using STL-compatible format")
|
|
|
|
try:
|
|
# Step 1: Write to the main config.vdf for CompatToolMapping
|
|
config_path = self.steam_path / "config" / "config.vdf"
|
|
|
|
if not config_path.exists():
|
|
logger.error(f"Steam config.vdf not found at: {config_path}")
|
|
return False
|
|
|
|
# Create backup first
|
|
backup_path = config_path.with_suffix(f".vdf.backup_{int(time.time())}")
|
|
import shutil
|
|
shutil.copy2(config_path, backup_path)
|
|
logger.info(f"Created backup: {backup_path}")
|
|
|
|
# Read the file as text to avoid VDF library formatting issues
|
|
with open(config_path, 'r', encoding='utf-8', errors='ignore') as f:
|
|
config_text = f.read()
|
|
|
|
# Find the CompatToolMapping section
|
|
compat_start = config_text.find('"CompatToolMapping"')
|
|
if compat_start == -1:
|
|
logger.error("CompatToolMapping section not found in config.vdf")
|
|
return False
|
|
|
|
# Find the closing brace for CompatToolMapping
|
|
# Look for the opening brace after CompatToolMapping
|
|
brace_start = config_text.find('{', compat_start)
|
|
if brace_start == -1:
|
|
logger.error("CompatToolMapping opening brace not found")
|
|
return False
|
|
|
|
# Count braces to find the matching closing brace
|
|
brace_count = 1
|
|
pos = brace_start + 1
|
|
compat_end = -1
|
|
|
|
while pos < len(config_text) and brace_count > 0:
|
|
if config_text[pos] == '{':
|
|
brace_count += 1
|
|
elif config_text[pos] == '}':
|
|
brace_count -= 1
|
|
if brace_count == 0:
|
|
compat_end = pos
|
|
break
|
|
pos += 1
|
|
|
|
if compat_end == -1:
|
|
logger.error("CompatToolMapping closing brace not found")
|
|
return False
|
|
|
|
# Check if this AppID already exists
|
|
app_id_pattern = f'"{app_id}"'
|
|
app_id_exists = app_id_pattern in config_text[compat_start:compat_end]
|
|
|
|
if app_id_exists:
|
|
logger.info(f"AppID {app_id} already exists in CompatToolMapping, will be overwritten")
|
|
# Remove the existing entry by finding and removing the entire block
|
|
# This is complex, so for now just add at the end
|
|
|
|
# Create the new entry in STL's exact format (tabs between key and value)
|
|
new_entry = f'\t\t\t\t\t"{app_id}"\n\t\t\t\t\t{{\n\t\t\t\t\t\t"name"\t\t"{proton_version}"\n\t\t\t\t\t\t"config"\t\t""\n\t\t\t\t\t\t"priority"\t\t"250"\n\t\t\t\t\t}}\n'
|
|
|
|
# Insert the new entry just before the closing brace of CompatToolMapping
|
|
new_config_text = config_text[:compat_end] + new_entry + config_text[compat_end:]
|
|
|
|
# Write back the modified text
|
|
with open(config_path, 'w', encoding='utf-8') as f:
|
|
f.write(new_config_text)
|
|
|
|
logger.info(f"✅ Successfully set Proton version '{proton_version}' for AppID {app_id} using config.vdf only (steam-conductor method)")
|
|
return True
|
|
|
|
except Exception as e:
|
|
logger.error(f"❌ Error setting Proton version: {e}")
|
|
return False
|
|
|
|
def create_shortcut_with_proton(self, app_name: str, exe_path: str, start_dir: str = None,
|
|
launch_options: str = "%command%", tags: List[str] = None,
|
|
proton_version: str = "proton_experimental") -> Tuple[bool, Optional[int]]:
|
|
"""
|
|
Complete workflow: Create shortcut and set Proton version.
|
|
|
|
This is the main method that replaces STL entirely.
|
|
|
|
Returns:
|
|
(success, app_id) - Success status and the AppID
|
|
"""
|
|
logger.info(f"Creating shortcut with Proton: '{app_name}' -> '{proton_version}'")
|
|
|
|
# Step 1: Create the shortcut
|
|
success, app_id = self.create_shortcut(app_name, exe_path, start_dir, launch_options, tags)
|
|
if not success:
|
|
logger.error("Failed to create shortcut")
|
|
return False, None
|
|
|
|
# Step 2: Set the Proton version
|
|
if not self.set_proton_version(app_id, proton_version):
|
|
logger.error("Failed to set Proton version (shortcut still created)")
|
|
return False, app_id # Shortcut exists but Proton setting failed
|
|
|
|
logger.info(f"✅ Complete workflow successful: '{app_name}' with '{proton_version}'")
|
|
return True, app_id
|
|
|
|
def list_shortcuts(self) -> Dict[str, str]:
|
|
"""List all existing shortcuts (for debugging)"""
|
|
shortcuts = self.read_shortcuts_vdf().get('shortcuts', {})
|
|
shortcut_list = {}
|
|
|
|
for index, shortcut in shortcuts.items():
|
|
app_name = shortcut.get('AppName', 'Unknown')
|
|
shortcut_list[index] = app_name
|
|
|
|
return shortcut_list
|
|
|
|
def remove_shortcut(self, app_name: str) -> bool:
|
|
"""Remove a shortcut by name"""
|
|
try:
|
|
data = self.read_shortcuts_vdf()
|
|
shortcuts = data.get('shortcuts', {})
|
|
|
|
# Find shortcut by name
|
|
to_remove = None
|
|
for index, shortcut in shortcuts.items():
|
|
if shortcut.get('AppName') == app_name:
|
|
to_remove = index
|
|
break
|
|
|
|
if to_remove is None:
|
|
logger.warning(f"Shortcut '{app_name}' not found")
|
|
return False
|
|
|
|
# Remove the shortcut
|
|
del shortcuts[to_remove]
|
|
data['shortcuts'] = shortcuts
|
|
|
|
# Write back
|
|
if self.write_shortcuts_vdf(data):
|
|
logger.info(f"✅ Removed shortcut '{app_name}'")
|
|
return True
|
|
else:
|
|
logger.error("❌ Failed to write updated shortcuts")
|
|
return False
|
|
|
|
except Exception as e:
|
|
logger.error(f"❌ Error removing shortcut: {e}")
|
|
return False |