spplice-api 0.1.0 → 0.2.0

package/src/SteamTools.ts

@@ -1,195 +0,0 @@
-import SteamworksSDK from "steamworks-ffi-node";
-import path from "node:path";
-import fs from "node:fs";
-import os from "node:os";
-import { execSync, execFile } from "node:child_process";
-import psList from "ps-list";
-
-type UserDetails = {
-  steamid: BigInt,
-  name: string
-};
-
-class SteamClient {
-
-  steamworksClient: SteamworksSDK;
-  appID: number;
-
-  /**
-   * Initialize Steamworks API.
-   * @param appID Game's Steam AppID (default 620 = Portal 2)
-   * Note: This makes Steam think that the specified game (Portal 2) is running.
-   */
-  constructor (appID: number = 620) {
-    this.appID = appID;
-    // HACK: Temporarily use AppID of Spacewar - Steam otherwise won't let us launch Portal 2
-    // Fixed by implementing manual startup of Portal 2
-    appID = 480;
-    // The Steamworks SDK requires steam_appid.txt in the working directory when
-    // the app is not launched through Steam, regardless of the envvar.
-    fs.writeFileSync(path.join(process.cwd(), "steam_appid.txt"), appID.toString());
-    this.steamworksClient = SteamworksSDK.getInstance();
-    const success = this.steamworksClient.init({ appId: appID });
-    if (!success) throw "Failed to initialize Steam API";
-  }
-
-  /**
-   * @returns {string} Absolute path to game directory.
-   */
-  getGameDir (): string {
-    const pathString = this.steamworksClient.apps.getAppInstallDir(this.appID) as string;
-    return path.resolve(pathString);
-  }
-
-  /**
-   * @returns {UserDetails} Current user's SteamID64 and username.
-   */
-  getUserDetails (): UserDetails {
-    const steamid = BigInt(this.steamworksClient.getStatus().steamId);
-    const name = this.steamworksClient.friends.getPersonaName();
-    return { steamid, name };
-  }
-
-  /**
-   * Checks whether the currently logged-in user has access to the game on Steam.
-   * @returns {boolean} true if current user has the game, false otherwise.
-   */
-  doesUserOwnGame (): boolean {
-    return this.steamworksClient.apps.isSubscribed();
-  }
-
-  /**
-   * Searches for Steam binaries and returns all that were found. Output is
-   * sorted by how relevant the results are. The most useful result is first.
-   *
-   * @returns {string[]} Array of absolute paths to found Steam executables,
-   * sorted by descending relevance.
-   */
-  static async findSteam (): Promise<string[]> {
-
-    const candidates: string[] = [];
-
-    /**
-     * First pass:
-     *
-     * Start by looking at the list of running system processes.
-     * The most relevant binary is likely one that is currently running.
-     */
-    const processList = await psList();
-    // Sort the process list, putting the most recent processes first.
-    // The more relevant process is the one that was last opened.
-    processList.sort((a, b) => Number(b.startTime) - Number(a.startTime));
-    // Filter for processes with name "steam".
-    const steamProcesses = processList.filter(p =>
-      p.name === "steam" ||
-      p.name === "steam.exe"
-    );
-
-    // TODO: Read registry on Windows
-
-    /**
-     * Second pass:
-     *
-     * Look for processes listening on port 27036. Steam uses this port to do
-     * game streaming, making it a fairly reliable way to fingerprint Steam.
-     */
-    try {
-      let steamPortPIDs: number[] = [];
-      // There's no neat package for this, so we use OS-dependent shells.
-      if (process.platform === "win32") {
-        const stdout = execSync("netstat -ano | findstr :27036");
-        const matches = stdout.toString().match(/\s+(\d+)$/gm);
-        if (matches) steamPortPIDs = [...new Set(matches.map(m => Number(m.trim())))];
-      } else {
-        const stdout = execSync("lsof -i :27036 -t");
-        const result = stdout.toString();
-        steamPortPIDs = result.split("\n").map(Number);
-      }
-      // Filter for processes with the PIDs we found.
-      const steamPortProcesses = processList.filter(p => steamPortPIDs.includes(p.pid));
-      steamProcesses.push(...steamPortProcesses);
-    } catch (_) { }
-
-    // Push process paths to candidate list.
-    for (const process of steamProcesses) {
-      if (process.path) candidates.push(process.path);
-      else if (process.cmd) candidates.push(process.cmd.split(" ")[0]!);
-    }
-
-    /**
-     * Third pass:
-     *
-     * Blindly push common Steam installation paths as a last resort.
-     * These will get validated in the final filtering step.
-     */
-    candidates.push(
-      `C:\\Program Files (x86)\\Steam\\steam.exe`,
-      `${os.homedir()}/.steam/steam/ubuntu12_32/steam`,
-      `${os.homedir()}/.local/share/Steam/ubuntu12_32/steam`,
-      `${os.homedir()}/.var/app/com.valvesoftware.Steam/.local/share/Steam/ubuntu12_32/steam`
-    );
-
-    // Filter and normalize candidate list.
-    for (let i = candidates.length - 1; i >= 0; i--) {
-      // Remove any empty entries
-      if (!candidates[i]?.trim()) {
-        candidates.splice(i, 1);
-        continue;
-      }
-      // Resolve candidate path
-      candidates[i] = path.resolve(candidates[i]!);
-      const candidate = candidates[i]!;
-      // Check that the path actually points to something
-      if (!fs.existsSync(candidate)) {
-        candidates.splice(i, 1);
-        continue;
-      }
-      // Check that the destination is a file
-      const stat = fs.lstatSync(candidate);
-      if (!stat.isFile()) {
-        candidates.splice(i, 1);
-        continue;
-      }
-    }
-
-    // Return list of candidates without duplicates
-    return [...new Set(candidates)];
-
-  }
-
-  /**
-   * Runs the Steam executable with the given command-line arguments.
-   * Can be used to start Steam, or to start a Steam game by using "-applaunch".
-   *
-   * TODO: Replace with manual game launch, hooking virtual file system.
-   *
-   * @param args Command-line arguments for Steam.
-   */
-  static async launchSteam (args: string[] = []) {
-
-    // Get list of canidate Steam executables
-    // TODO: Use Steamworks for this somehow?
-    const steamExes = await SteamClient.findSteam();
-
-    // Try each executable until one works, i.e. doesn't fail before `timeout`
-    const timeout = 5000;
-    for (const steam of steamExes) {
-      const error = await Promise.all([
-        new Promise(resolve => {
-          execFile(steam, args, (error) => {
-            resolve(error);
-          });
-        }),
-        new Promise(resolve => setTimeout(resolve, timeout, false))
-      ]);
-      if (!error) break;
-    }
-
-  }
-
-}
-
-export {
-  type UserDetails,
-  SteamClient
-};

package/test/extract.test.ts

@@ -1,11 +0,0 @@
-import { expect, test } from "bun:test";
-import fs from "node:fs/promises";
-import * as Spplice from "../index";
-
-test("repository package extraction", async () => {
-  const repo = await Spplice.Repository.fromURL("https://p2r3.github.io/spplice-repo/index.json");
-  const pkg = Array.from(repo.packages)[0]!;
-  await pkg.extract(".tmp");
-  expect(await Bun.file(".tmp/scripts/vscripts/mapspawn.nut").exists()).toBeTrue();
-  await fs.rm(".tmp", { recursive: true, force: true });
-});

package/tsconfig.json

@@ -1,29 +0,0 @@
-{
-  "compilerOptions": {
-    // Environment setup & latest features
-    "lib": ["ESNext"],
-    "target": "ESNext",
-    "module": "Preserve",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
-
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
-
-    // Best practices
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
-
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false
-  }
-}