mirror of
https://github.com/valentderah/totk-pc-recomp.git
synced 2026-11-18 12:08:38 +00:00
The branch forked 79 commits before main and 98 before dev. Resolutions: 1. Aspect ratio: dev's implementation stays (camera patch at page +56 on 1.4.3, tools/ultrawide_layout.py layouts per size in romfs-patches-<w>x<h>, the aspect = fit|stretch setting). The PR's second implementation is dropped: the aspect sets of patches-v121.txt and patches-v143.txt (the 1.4.3 one patched the same viewport sites as dev's), tools/aspect_layouts.py, the resolution.c shapes that limited game resolutions to 16:9, 16:10 and 21:9, and the picture_fit setting. Its letterbox code (gfx_fit_rect) is kept and reads TOTK_ASPECT. 2. Code dev changed where the PR moved it: the stick dead zone, the test gamepad and the paddles go to input.c; the DPI awareness, keep-awake and IME detach of gfx_window.c go to gfx_window_win.c; device fault reports and GPU breadcrumbs to gfx_present.c. gfx_window_dpi gets an SDL version. 3. dev's Win32 calls in shared code go through platform.h: the shader cache pack reader (PlatFile), the romfs overlay checks, the audio pacing waits, the motion, ASTC and device fault locks. plat_cpu_usable and plat_commit_info get Linux versions; plat_cpu_count counts the machine's processors on both. dpi_probe.c becomes dpi_probe_win.c. 4. assume_focus defaults to 1 as the PR has it (a load interrupted by a focus loss can stop for good) and stays live, with dev's Game tab row. 5. The frame limits 40 and 45 join dev's list. The BC 3D storage fallback for Vega only runs with TOTK_BLOCK_VIEWS_3D=1, since dev makes 3D BC images without block views by default. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
165 lines
8.5 KiB
Python
165 lines
8.5 KiB
Python
"""Where the installer finds what it runs: the one place that maps the release folder and a repository checkout.
|
|
|
|
Release (docs/installer.md "Release layout"), root = the unpacked folder:
|
|
|
|
python/python.exe runs every tool (numpy, lz4, cryptography, compression.zstd); its ._pth puts .., ../tools
|
|
and ../recomp on sys.path, so `python -m installer` imports from the release folder
|
|
recomp/, tools/ the lifter and the scripts; recomp/patches-<v>.txt, tools/data/expected-v<version>.json for
|
|
each supported update (SUPPORTED)
|
|
llvm/ llvm-mingw (bin/clang.exe)
|
|
runtime/ libtotkrt.a, the headers, install-side sources (romfs.c, patches.c, ov_zstd.c) and totk.ico; runtime/deps/ holds
|
|
include/ + lib/ of Vulkan, SDL3, Opus, libvpx and VMA (build_game.py --deps)
|
|
bin/ totk_xlate.exe (+ totk_xlate.id), hactool.exe, ninja.exe, SDL3.dll, libopus-0.dll
|
|
data/shader_list.tsv the MacNativeGames shader list
|
|
totk.ini.example
|
|
VERSION the release version, one line
|
|
temp/ the default temp folder (created)
|
|
|
|
Linux release (the AppImage's folder, docs/installer.md "Linux release"): python/bin/python3 (python-build-standalone,
|
|
with tkinter), llvm/ with clang, lld and llvm-ar plus llvm/sysroot (the glibc headers and libraries the game links
|
|
against), runtime/deps/ with include/ and the static Opus, libvpx and zstd, bin/ without .exe and with libSDL3.so.0.
|
|
|
|
Dev mode, root = a repository checkout (no python/python.exe): build/py314-embed/py/python.exe (the embeddable
|
|
Python the release ships, with the same packages), else this Python; toolchain/llvm-mingw-*/ and toolchain/deps-mingw;
|
|
runtime/ as the sources with build/install-rtlib/libtotkrt.a (tools/build_game.py --make-runtime-lib --out
|
|
build/install-rtlib); MSYS2 UCRT64 ninja.exe; toolchain/hactool; build/xlate/totk_xlate.exe; the shader list from
|
|
refs/MacNativeGames; build/install-temp. The version is VERSION with -dev and the commit: 0.1.0-dev+973c626. On Linux,
|
|
dev mode takes clang, lld and ninja from PATH and the system's libraries (no deps folder, no SDL3 copy).
|
|
"""
|
|
import os
|
|
import shutil
|
|
import subprocess
|
|
import sys
|
|
from dataclasses import dataclass, field
|
|
from pathlib import Path
|
|
|
|
WIN = os.name == 'nt'
|
|
EXE = '.exe' if WIN else ''
|
|
UCRT = Path(r'C:\msys64\ucrt64\bin')
|
|
SUPPORTED = ('1.2.1', '1.4.3') # updates the installer builds; the check identifies the player's by hash
|
|
|
|
|
|
def version_tag(version):
|
|
"""'1.4.3' -> 'v143': the version name of build_game.py, make_romfs_patches.py and the patch tables."""
|
|
return 'v' + version.replace('.', '')
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class Layout:
|
|
root: Path
|
|
dev: bool
|
|
release: str
|
|
python: Path # runs the tools
|
|
tools: Path
|
|
recomp: Path
|
|
llvm: Path # llvm-mingw tree; on Linux the tree with bin/clang (a release's, or the system's /usr)
|
|
deps: Path | None # include/ and lib/ for the link; None: the system's (Linux dev mode)
|
|
runtime: Path # runtime headers and install-side sources
|
|
runtime_lib: Path # libtotkrt.a
|
|
ninja: Path
|
|
hactool: Path
|
|
xlate: Path # totk_xlate.exe; a totk_xlate.id beside it is copied too
|
|
dlls: tuple = field(default_factory=tuple)
|
|
shader_list: Path | None = None # None: dev, read from refs/MacNativeGames through git
|
|
ini_example: Path | None = None
|
|
temp: Path | None = None
|
|
sysroot: Path | None = None # Linux release: what the game links against, instead of the host's
|
|
|
|
@property
|
|
def clang(self):
|
|
return self.llvm / 'bin' / ('clang' + EXE)
|
|
|
|
def patches(self, version):
|
|
"""The code patch table for recomp/gen.py."""
|
|
return self.recomp / f'patches-{version_tag(version)}.txt'
|
|
|
|
def expected(self, version):
|
|
"""The expected hashes of the update."""
|
|
return self.tools / 'data' / f'expected-v{version}.json'
|
|
|
|
def missing(self):
|
|
"""Paths the steps need that do not exist."""
|
|
need = [self.python, self.tools / 'extract.py', self.tools / 'build_game.py', self.tools / 'prepare_shaders.py',
|
|
self.tools / 'pack_shader_cache.py', self.tools / 'make_romfs_patches.py', self.tools / 'ultrawide_layout.py',
|
|
self.recomp / 'gen.py',
|
|
self.clang,
|
|
*((self.deps / 'include', self.deps / 'lib') if self.deps else ()), self.runtime, self.runtime_lib, self.ninja, self.hactool,
|
|
self.xlate, *self.dlls, *(f(v) for v in SUPPORTED for f in (self.patches, self.expected))]
|
|
if self.shader_list:
|
|
need.append(self.shader_list)
|
|
if self.sysroot:
|
|
need.append(self.sysroot)
|
|
return [str(p) for p in need if not p.exists()]
|
|
|
|
|
|
def release_python(root):
|
|
return root / 'python' / ('python.exe' if WIN else 'bin/python3')
|
|
|
|
|
|
def is_release(root):
|
|
return release_python(root).is_file()
|
|
|
|
|
|
def release_layout(root):
|
|
version = root / 'VERSION'
|
|
return Layout(
|
|
root=root, dev=False,
|
|
release=version.read_text(encoding='utf-8').strip() if version.is_file() else 'unknown',
|
|
python=release_python(root),
|
|
tools=root / 'tools', recomp=root / 'recomp',
|
|
llvm=root / 'llvm', deps=root / 'runtime' / 'deps', runtime=root / 'runtime',
|
|
runtime_lib=root / 'runtime' / 'libtotkrt.a',
|
|
ninja=root / 'bin' / ('ninja' + EXE), hactool=root / 'bin' / ('hactool' + EXE),
|
|
xlate=root / 'bin' / ('totk_xlate' + EXE),
|
|
dlls=(root / 'bin' / 'SDL3.dll', root / 'bin' / 'libopus-0.dll') if WIN else (root / 'bin' / 'libSDL3.so.0',),
|
|
shader_list=root / 'data' / 'shader_list.tsv', ini_example=root / 'totk.ini.example',
|
|
# Linux: None, the install folder's .setup-temp (installer/cli.py): the AppImage is mounted read-only, and on
|
|
# a Steam Deck /home is often too full for the generated C while the install folder is on the SD card
|
|
temp=root / 'temp' if WIN else None,
|
|
sysroot=None if WIN else root / 'llvm' / 'sysroot')
|
|
|
|
|
|
def dev_layout(root):
|
|
if not WIN:
|
|
return dev_layout_posix(root)
|
|
commit = subprocess.run(['git', '-C', str(root), 'rev-parse', '--short', 'HEAD'], capture_output=True,
|
|
text=True).stdout.strip()
|
|
embed = root / 'build' / 'py314-embed' / 'py' / ('python' + EXE)
|
|
trees = sorted(p.parent.parent for p in (root / 'toolchain').glob('llvm-mingw-*/llvm-mingw-*/bin/clang' + EXE))
|
|
deps = root / 'toolchain' / 'deps-mingw'
|
|
semver = (root / 'VERSION').read_text(encoding='utf-8').strip()
|
|
return Layout(
|
|
root=root, dev=True, release=f'{semver}-dev+{commit or "unknown"}',
|
|
python=embed if embed.is_file() else Path(sys.executable),
|
|
tools=root / 'tools', recomp=root / 'recomp',
|
|
llvm=trees[-1] if trees else root / 'toolchain' / 'llvm-mingw-missing', deps=deps,
|
|
runtime=root / 'runtime', runtime_lib=root / 'build' / 'install-rtlib' / 'libtotkrt.a',
|
|
ninja=UCRT / ('ninja' + EXE), hactool=root / 'toolchain' / 'hactool' / ('hactool' + EXE),
|
|
xlate=root / 'build' / 'xlate' / ('totk_xlate' + EXE),
|
|
dlls=tuple(sorted((deps / 'bin').glob('*.dll'))),
|
|
shader_list=None, ini_example=root / 'totk.ini.example', temp=root / 'build' / 'install-temp')
|
|
|
|
|
|
def dev_commit(root):
|
|
return subprocess.run(['git', '-C', str(root), 'rev-parse', '--short', 'HEAD'], capture_output=True,
|
|
text=True).stdout.strip()
|
|
|
|
|
|
def dev_layout_posix(root):
|
|
clang, ninja = shutil.which('clang'), shutil.which('ninja')
|
|
semver = (root / 'VERSION').read_text(encoding='utf-8').strip()
|
|
return Layout(
|
|
root=root, dev=True, release=f'{semver}-dev+{dev_commit(root) or "unknown"}',
|
|
python=Path(sys.executable), tools=root / 'tools', recomp=root / 'recomp',
|
|
llvm=Path(clang).parent.parent if clang else root / 'toolchain' / 'clang-missing', deps=None,
|
|
runtime=root / 'runtime', runtime_lib=root / 'build' / 'install-rtlib' / 'libtotkrt.a',
|
|
ninja=Path(ninja) if ninja else root / 'toolchain' / 'ninja-missing',
|
|
hactool=root / 'toolchain' / 'hactool' / 'hactool', xlate=root / 'build' / 'xlate' / 'totk_xlate',
|
|
shader_list=None, ini_example=root / 'totk.ini.example', temp=root / 'build' / 'install-temp')
|
|
|
|
|
|
def find(root=None):
|
|
"""The layout of root (default: the folder above this package)."""
|
|
root = Path(root or Path(__file__).resolve().parent.parent).resolve()
|
|
return release_layout(root) if is_release(root) else dev_layout(root)
|