Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

1.1 KB
Raw Blame
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
//
// Types for steamChannel.js, which is plain ESM so the CLI runs it unbuilt.

export const STEAM_DIR: string;

/** The OSes a Steam depot is written for — the desktop OSes, spelled as the
 *  runtime templates are. */
export type SteamDepotOs = 'windows' | 'macos' | 'linux';

/** `appId + 1` (windows), `+ 2` (macos), `+ 3` (linux) — the usual shape of what
 *  Valve assigns, never a fact. */
export function defaultDepotId(appId: number, os: SteamDepotOs): number;

export function emitSteamBuild(options: {
    /** The export directory, which is also the depot's content root. */
    outDir: string;
    appId: number;
    /** Names the executable a depot maps and Steam launches. */
    appName: string;
    depots: { os: SteamDepotOs; depotId: number }[];
    /** Ids the game unlocks; each must be created by hand in the backend. */
    achievements?: string[];
    /** Whether the packages carry Steam's redistributable. */
    steamLibrary?: boolean;
    description?: string;
}): Promise<{ scripts: string[]; checklist: string }>;