Files
Triforce-Source/builder/HookshotBuilder/Runner.cs
ruckus7382sfgsgdf 6c7117635c Triforce v0.6.0 "Sage Of Power"
Faster frames (the replay's memory work, held submits, helper threads, collection and capture cuts), the game letting old areas go (QueryMemoryInfo), the 0.5.2 stutter fixed, AMD RX 5000/6000 and integrated-GPU fixes, the GPU device chosen by name, the in-game menus and launcher reworked, controller, Linux and benchmark fixes.
2026-11-20 17:06:21 -06:00

209 lines
10 KiB
C#

using System.Diagnostics;
using System.IO;
namespace HookshotBuilder;
/// Where nx2/make_game.py and its Python are: a "tools" folder beside the app when packaged, or the source tree it sits in.
sealed record Tools(string Root, string Python, string[]? PythonArgs = null)
{
/// Which release these tools are (tools/version.txt, written when the release is packed); null from the source tree
public string? Version => File.Exists(Path.Combine(Root, "version.txt")) ? File.ReadAllText(Path.Combine(Root, "version.txt")).Trim() : null;
public static Tools? Find()
{
var at = AppContext.BaseDirectory;
var bundled = Path.Combine(at, "tools");
if (File.Exists(Path.Combine(bundled, "nx2", "make_game.py")))
{
var py = Path.Combine(bundled, "python", "python.exe");
return new Tools(bundled, File.Exists(py) ? py : "python");
}
// (the source tree the app was built in: its builder\ folder holds the app. Not any parent folder with an nx2\
// folder, such as one another user of the PC made at the drive's root)
for (var d = new DirectoryInfo(at); d != null; d = d.Parent)
if (File.Exists(Path.Combine(d.FullName, "nx2", "make_game.py")) &&
at.StartsWith(Path.Combine(d.FullName, "builder") + Path.DirectorySeparatorChar, StringComparison.OrdinalIgnoreCase))
{
var (exe, args) = PythonOnPath();
return new Tools(d.FullName, exe, args);
}
return null;
}
/// The Python for a source tree: Windows' Store shortcut is not an interpreter (it only opens the Store), so the py
/// launcher is tried when "python" is that. CONTRIBUTING: Python 3 from python.org, not the Microsoft Store build.
static (string Exe, string[]? Args) PythonOnPath()
{
var python = FirstOnPath("python.exe");
if (python != null && !IsStoreShortcut(python)) return (python, null);
var py = FirstOnPath("py.exe");
if (py != null) return (py, new[] { "-3" });
var later = AllOnPath("python.exe").FirstOrDefault(p => !IsStoreShortcut(p));
return (later ?? python ?? "python", null);
}
static IEnumerable<string> AllOnPath(string name)
{
foreach (var dir in (Environment.GetEnvironmentVariable("PATH") ?? "").Split(Path.PathSeparator))
if (!string.IsNullOrWhiteSpace(dir))
{
var path = Path.Combine(dir.Trim('"'), name);
if (File.Exists(path)) yield return path;
}
}
static string? FirstOnPath(string name) => AllOnPath(name).FirstOrDefault();
static bool IsStoreShortcut(string path) => path.Contains(@"\Microsoft\WindowsApps\", StringComparison.OrdinalIgnoreCase);
}
/// nx2/make_game.py as a child process: its lines as they come, and how it ended.
sealed class Runner
{
readonly Tools tools;
readonly List<string> args;
readonly int? workers;
readonly string? ngxSdk;
Process? process;
string? error;
bool cancelled;
public event Action<string>? Line;
public event Action<string?>? Finished;
/// ngxSdk: NVIDIA DLSS (the builder's tick): the folder of NVIDIA's DLSS SDK, as HOOKSHOT_NGX_SDK; null builds without it
public Runner(Tools tools, List<string> args, int? workers = null, string? ngxSdk = null)
{
this.tools = tools;
this.args = args;
if (workers is <= 0) throw new ArgumentOutOfRangeException(nameof(workers), "Build workers must be positive.");
this.workers = workers;
this.ngxSdk = ngxSdk;
}
/// (Triforce, 11-18) The event this run's game opens while it prepares its shaders (gpu/vk/vk_main.cpp PrepareStopWatch),
/// named for this run alone: a Cancel here never stops another builder's preparation
readonly string stopEvent = @"Local\TriforcePrepareStop." + Guid.NewGuid().ToString("N");
static ProcessStartInfo Info(Tools tools, IEnumerable<string> args, int? workers = null, string? ngxSdk = null,
string? stopEvent = null)
{
var si = new ProcessStartInfo(tools.Python)
{
WorkingDirectory = tools.Root,
UseShellExecute = false,
CreateNoWindow = true,
RedirectStandardOutput = true,
RedirectStandardError = true,
};
si.Environment["PYTHONIOENCODING"] = "utf-8";
BuildWorkers.Apply(si, workers);
// (written into the game folder's hookshot_version.txt: the game starts this app again to update, host/hos_update.c)
if (Environment.ProcessPath != null) si.Environment["HOOKSHOT_BUILDER_EXE"] = Environment.ProcessPath;
// (NVIDIA DLSS: only when ticked. Without it, one set on the PC is not passed on either: a build is with DLSS only when asked)
if (ngxSdk != null) si.Environment["HOOKSHOT_NGX_SDK"] = ngxSdk;
else si.Environment.Remove("HOOKSHOT_NGX_SDK");
// (not a HOOKSHOT_ name: make_game.py's game_env keeps it for the game)
if (stopEvent != null) si.Environment["TRIFORCE_PREPARE_STOP"] = stopEvent;
else si.Environment.Remove("TRIFORCE_PREPARE_STOP");
// (the folder's own compiler, headers and libraries, when it has them: nothing of the PC's but Windows' own)
var sets = new[] { ("EMSDK", "emsdk"), ("RX_CPM", "cpm"), ("WGPU_NATIVE", "wgpu-native") };
foreach (var (name, folder) in sets)
{
var path = Path.Combine(tools.Root, folder);
if (Directory.Exists(path)) si.Environment[name] = path;
}
foreach (var a in tools.PythonArgs ?? Array.Empty<string>()) si.ArgumentList.Add(a);
si.ArgumentList.Add("-I");
si.ArgumentList.Add(Path.Combine(tools.Root, "nx2", "make_game.py"));
foreach (var a in args) si.ArgumentList.Add(a);
return si;
}
public void Start()
{
Task.Run(() =>
{
try
{
using var p = Process.Start(Info(tools, args, workers, ngxSdk, stopEvent))!;
process = p;
p.ErrorDataReceived += (_, e) => { if (e.Data != null) Line?.Invoke(e.Data); };
p.BeginErrorReadLine();
try { p.PriorityClass = ProcessPriorityClass.BelowNormal; } catch (Exception) { }
while (p.StandardOutput.ReadLine() is { } line)
{
if (line.StartsWith("@@error ")) error = line[8..];
Line?.Invoke(line);
}
p.WaitForExit();
Finished?.Invoke(cancelled ? "cancelled" : p.ExitCode == 0 ? null : error ?? "The build tools stopped without saying why. See the details.");
}
catch (Exception e)
{
Finished?.Invoke("The build tools could not start: " + e.Message);
}
});
}
/// (Triforce, 11-18) The game's --prepare-shaders run, when that is the step under way, is asked to stop first (the event
/// gpu/vk/vk_main.cpp PrepareStopWatch waits on): it ends its driver's part cleanly and keeps what it made, where a kill
/// used one of that part's three tries and left shaders out for good. Killed as before when it has not ended in 30 s,
/// and at once when no preparation is under way. The wait is not on the caller's thread
public Task Cancel()
{
cancelled = true;
var p = process;
var asked = false;
try
{
if (EventWaitHandle.TryOpenExisting(stopEvent, out var stop))
using (stop) asked = stop.Set();
}
catch (Exception) { }
return Task.Run(() =>
{
try { if (asked && p != null && p.WaitForExit(30000)) return; } catch (Exception) { }
try { p?.Kill(entireProcessTree: true); } catch (Exception) { }
});
}
/// Is this the supported game and version? The answer in plain words.
public static async Task<(bool Ok, string Text)> Check(Tools tools, IEnumerable<string> args)
{
try
{
using var p = Process.Start(Info(tools, args))!;
string? lastError = null;
p.ErrorDataReceived += (_, e) => { if (!string.IsNullOrWhiteSpace(e.Data)) lastError = e.Data; };
p.BeginErrorReadLine();
var result = (false, "The game files could not be read.");
var answered = false;
while (await p.StandardOutput.ReadLineAsync() is { } line)
{
if (line.StartsWith("@@check ok ")) { result = (true, line[11..]); answered = true; }
else if (line.StartsWith("@@check bad ")) { result = (false, line[12..]); answered = true; }
else if (line.StartsWith("@@error ")) { result = (false, line[8..]); answered = true; }
}
await p.WaitForExitAsync();
// (a step that stopped before it could say why: the reason is on stderr, which used to be dropped here)
if (!answered)
{
if (lastError != null && lastError.Contains("Microsoft Store", StringComparison.OrdinalIgnoreCase))
return (false, "Python 3 was not found: the 'python' command on this PC is the Microsoft Store shortcut, which only opens " +
"the Store. Install Python 3 from python.org (not the Store version), or use the full Hookshot Builder package.");
return (false, lastError ?? "The game tools stopped without saying why (exit code " + p.ExitCode + ").");
}
return result;
}
catch (Exception)
{
// (the package's own Python missing: an antivirus took it, most often, after a false alarm on the download)
if (tools.Python == "python" && Directory.Exists(Path.Combine(tools.Root, "python")))
return (false, "The builder's own Python (tools/python/python.exe) is missing. Your antivirus probably removed it: restore it " +
"from quarantine, or unpack the zip again into a folder your antivirus allows, then try again.");
return (false, "Python 3 was not found. Install it from python.org (not the Microsoft Store build), or use the full Hookshot Builder package.");
}
}
}