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.

feat(editor): a Steam build says where its checklist is

esengine9c0718124a4f
diff --git a/CHANGELOG.md b/CHANGELOG.md
index b3c30aea7..e1b36fcb1 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -216,6 +216,17 @@ published separately; it ships inside the editor.
movement, clipboard and Enter/Escape are the model's. Keys still reach the game
as well as the field, which is what a browser does and what keeps play == ship.
+- **The Steam checklist the export writes was never mentioned in the editor.**
+ `STEAM.md` carries the values only the Steamworks backend can be told — the
+ depot ids, the launch string, the Auto-Cloud paths, the achievement ids to
+ create — and the Package dialog finished a Steam build by telling you to
+ double-click the app. It now says what is beside it and offers to open it.
+
+- **A desktop export reported writing a host page it never wrote.** The phase
+ fired for every target; a native one has no browser to boot the game and writes
+ no page. A progress line is a report of work, and one that reports work nothing
+ did is read while looking for what actually happened.
+
- **A Windows game shipped with the default executable icon.** The assembler
wrote the macOS `.icns` and had nothing for the PE, so every Windows build
carried whatever icon the runtime template's executable happened to have. The
diff --git a/desktop/electron/exportGame.ts b/desktop/electron/exportGame.ts
index b67603b63..67ba086b4 100644
--- a/desktop/electron/exportGame.ts
+++ b/desktop/electron/exportGame.ts
@@ -665,10 +665,11 @@ async function produceExport(opts: ExportGameOptions): Promise<ExportGameResult>
// it stages nothing and says so.
warnings.push(...await stageProjectModules(projectModules, path.join(payloadDir, 'wasm'), platform));
- // 5. Host page + entry-scene config. Web pins orientation (rotate-to-fit overlay);
- // desktop omits it — the Electron shell sizes its own window to the orientation.
- progress({ phase: 'Writing host page' });
+ // 5. Host page + entry-scene config. Only where a BROWSER boots the game: a
+ // native target has no page, and saying it wrote one is a progress line that
+ // reports work nothing did.
if (!nativeContent) {
+ progress({ phase: 'Writing host page' });
await writeFile(path.join(payloadDir, 'index.html'), indexHtml(title, platform === 'web' ? orientation : undefined));
}
// Typed against the SDK's contract, so a field the runtimes read can never be
diff --git a/desktop/src/components/BuildDialog.tsx b/desktop/src/components/BuildDialog.tsx
index 3071ef2c9..09169dd7f 100644
--- a/desktop/src/components/BuildDialog.tsx
+++ b/desktop/src/components/BuildDialog.tsx
@@ -65,6 +65,10 @@ interface Result {
apkFile?: string;
/** Android: the App Bundle, when the project asked for one. */
aabFile?: string;
+ /** Desktop, Steam channel: the checklist naming this build's depot ids, launch
+ * string, cloud paths and achievement ids — the values only the partner
+ * backend can be told, and the reason a Steam build is not just a folder. */
+ steamChecklist?: string;
/** What the package weighs, measured by the export (electron/sizeReport.ts). */
size?: BuildSizeReport;
}
@@ -982,7 +986,9 @@ export function BuildDialog() {
</span>
{result.size && <BuildSizePanel report={result.size} />}
<div className="build__next selectable">
- {result.xcodeProject
+ {result.steamChecklist
+ ? t('build.next.steam', { out: result.outDir })
+ : result.xcodeProject
? t('build.next.iosProject')
: result.androidProject
? t('build.next.androidProject')
@@ -1016,6 +1022,11 @@ export function BuildDialog() {
<FolderOpen size={13} /> {t('build.showApk')}
</Button>
)}
+ {result.steamChecklist && (
+ <Button variant="primary" onClick={() => void window.estella.shell?.openPath?.(result.steamChecklist!)}>
+ <ExternalLink size={13} /> {t('build.openSteamChecklist')}
+ </Button>
+ )}
<Button onClick={() => void window.estella.shell?.openPath?.(result.outDir)}>
<FolderOpen size={13} /> {t('build.openFolder')}
</Button>
diff --git a/desktop/src/i18n/messages/project.ts b/desktop/src/i18n/messages/project.ts
index a90f76ca8..deb388c7c 100644
--- a/desktop/src/i18n/messages/project.ts
+++ b/desktop/src/i18n/messages/project.ts
@@ -165,6 +165,14 @@ export const projectMessages = defineMessages({
en: 'Signed APK: {apk} (install it with adb install -r). App Bundle for Google Play: {aab} — upload it; a bundle cannot be installed directly.',
zh: '已签名 APK:{apk}(用 adb install -r 安装)。Google Play 上传用 App Bundle:{aab} —— 直接上传即可,bundle 本身无法安装。',
},
+ 'build.next.steam': {
+ en: 'The app is in {out}/ — double-click it. The depot scripts are beside it, and STEAM.md '
+ + 'lists what only the Steamworks backend can be told: the depot ids, the launch string, '
+ + 'the cloud-save paths and the achievement ids to create.',
+ zh: '应用就在 {out}/ 中——双击即可运行。depot 脚本在它旁边,而 STEAM.md 列出了只能在 Steamworks '
+ + '后台填写的那些值:depot id、启动项、云存档路径,以及要去建的成就 id。',
+ },
+ 'build.openSteamChecklist': { en: 'Open STEAM.md', zh: '打开 STEAM.md' },
'build.showApk': { en: 'Show APK', zh: '显示 APK' },
'build.appBundle': { en: 'Google Play App Bundle (.aab)', zh: 'Google Play App Bundle(.aab)' },
'build.appBundleTip': {
diff --git a/desktop/tests/export-progress.test.ts b/desktop/tests/export-progress.test.ts
index 7d67b6d21..230036155 100644
--- a/desktop/tests/export-progress.test.ts
+++ b/desktop/tests/export-progress.test.ts
@@ -62,4 +62,26 @@ describe('export progress', () => {
// Cooking is first; writing the host page is among the last.
expect(phases.indexOf('Cooking assets')).toBeLessThan(phases.indexOf('Writing host page'));
}, 60_000);
+
+ it('does not claim a step a native target never takes', async () => {
+ // A progress line is a report of work. Desktop writes no host page — there is
+ // no browser to boot the game — and a log that says it did is one a developer
+ // reads while looking for what actually happened.
+ const phases: string[] = [];
+ const res = await exportGame({
+ root,
+ entryScene: 'scenes/main.esscene',
+ gameHostEntry: GAME_HOST,
+ scriptsEntry: 'src/main.ts',
+ sdkDistDir: path.join(root, '_sdk'),
+ wasmDir: path.join(root, '_wasm'),
+ outDir: path.join(root, 'out-desktop'),
+ platform: 'desktop',
+ onProgress: (p: ExportProgress) => phases.push(p.phase),
+ });
+
+ expect(res.ok).toBe(true);
+ expect(phases).toContain('Cooking assets');
+ expect(phases).not.toContain('Writing host page');
+ }, 60_000);
});