@next2d/builder 0.1.5 → 0.1.6

package/README.md

@@ -39,6 +39,17 @@ With Next2D Framework, you can efficiently develop and deploy applications optim
 | web             | Export minfy'd JS files             |
 | iOS             | open Xcode, and Export ipa          |
 | iOS             | open Android Studio, and Export apk |
+| Xbox            | GDK native title (V8 + Dawn/WebGPU) |
+
+Xbox exports a GDK native title that runs the Next2D JavaScript on the V8 engine and
+renders with Dawn (WebGPU → D3D12), packaged as a C++ executable (no Electron/WebView).
+Building the GDK package requires Windows + Visual Studio 2022 + Microsoft GDK + a devkit.
+On other platforms the builder scaffolds the host project and stages assets only.
+See the generated `xbox/README.md` for full build steps.
+
+```bat
+npx @next2d/builder --platform xbox --env prd --v8-root C:\path\to\v8
+```
 
 ### Scheduled introduction
 

package/dist/index.js

@@ -2,6 +2,8 @@
 "use strict";
 import pc from "picocolors";
 import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
 import cp from "child_process";
 import { loadConfigFromFile } from "vite";
 import { api } from "@electron-forge/core";
@@ -19,6 +21,7 @@ let hasHelp = false;
 let preview = false;
 let open = false;
 let build = false;
+let v8Root = "";
 for (let idx = 0; idx < process.argv.length; ++idx) {
     switch (process.argv[idx]) {
         case "--preview":
@@ -40,6 +43,10 @@ for (let idx = 0; idx < process.argv.length; ++idx) {
         case "--env":
             environment = process.argv[++idx];
             break;
+        case "--v8-root":
+            // Xbox ビルドで使う prebuilt V8 monolith のパス (環境変数 V8_ROOT より優先)
+            v8Root = process.argv[++idx] || "";
+            break;
         default:
             break;
     }
@@ -60,7 +67,7 @@ if (!platform || !environment) {
  */
 const echoHelp = () => {
     console.log();
-    console.log(pc.green("`--platform` can be specified for macOS, Windows, iOS, Android, and Web"));
+    console.log(pc.green("`--platform` can be specified for macOS, Windows, iOS, Android, Xbox, and Web"));
     console.log(pc.green("It is not case sensitive."));
     console.log();
     console.log("For build example:");
@@ -69,6 +76,9 @@ const echoHelp = () => {
     console.log("For preview example:");
     console.log("npx @next2d/builder --preview --platform web --env prd");
     console.log();
+    console.log("For Xbox build example (prebuilt V8 monolith path):");
+    console.log("npx @next2d/builder --platform xbox --env prd --v8-root C:\\path\\to\\v8");
+    console.log();
     process.exit(1);
 };
 if (hasHelp) {
@@ -86,6 +96,7 @@ switch (platform) {
     case "steam:linux":
     case "ios":
     case "android":
+    case "xbox":
     case "web":
         break;
     default:
@@ -434,6 +445,239 @@ const buildNative = async () => {
         ], { "stdio": "inherit" });
     });
 };
+/**
+ * @type {string}
+ * @constant
+ */
+const XBOX_DIR_NAME = "xbox";
+/**
+ * @description builder パッケージに同梱したテンプレートの絶対パスを取得
+ *              Get the absolute path of a template shipped with the builder package
+ *
+ * @param  {string} name
+ * @return {string}
+ * @method
+ * @public
+ */
+const getTemplateDir = (name) => {
+    // dist/index.js から見た templates/ (パッケージルート直下)
+    const currentDir = path.dirname(fileURLToPath(import.meta.url));
+    return path.resolve(currentDir, "..", "templates", name);
+};
+/**
+ * @type {string}
+ * @constant
+ */
+const XBOX_CONFIG_NAME = "MicrosoftGame.config";
+/**
+ * @description ゲーム側の `xbox/` へスキャフォールドしないテンプレート内ファイル。
+ *              - MicrosoftGame.config : ゲーム固有設定 (injectGameConfig が注入)
+ *              - tests / .v8_headers  : builder リポジトリ側の開発用テスト・キャッシュ
+ *              - build 系             : テンプレート内でビルドした場合の生成物
+ *              Template entries excluded from the per-game `xbox/` scaffold.
+ *
+ * @type {Set<string>}
+ * @constant
+ */
+const XBOX_SCAFFOLD_EXCLUDES = new Set([
+    XBOX_CONFIG_NAME,
+    "tests",
+    ".v8_headers",
+    "build",
+    "out",
+    "_deps",
+    "CMakeCache.txt",
+    "CMakeFiles"
+]);
+/**
+ * @description XboxホストのC++/CMake一式をbuilder同梱テンプレートから毎回更新する。
+ *              ホストは「エンジン相当」でユーザーは編集しない前提のため、常に最新へ上書きする。
+ *              ただし各ゲーム固有の `MicrosoftGame.config` は対象外(injectGameConfigが扱う)。
+ *              Refresh the Xbox host (C++/CMake) from the builder's bundled template on every build.
+ *              The host is engine-like and not user-edited, so it is always overwritten,
+ *              excluding the per-game `MicrosoftGame.config` (handled by injectGameConfig).
+ *
+ * @return {Promise}
+ * @method
+ * @public
+ */
+const refreshXboxHost = () => {
+    return new Promise((resolve, reject) => {
+        const projectDir = `${process.cwd()}/${XBOX_DIR_NAME}`;
+        const templateDir = getTemplateDir("xbox");
+        if (!fs.existsSync(templateDir)) {
+            return reject(`Xbox template not found: ${templateDir}`);
+        }
+        try {
+            fs.cpSync(templateDir, projectDir, {
+                "recursive": true,
+                // ゲーム固有設定と builder 側の開発用ファイルはスキャフォールドしない
+                "filter": (src) => !XBOX_SCAFFOLD_EXCLUDES.has(path.basename(src))
+            });
+            console.log(pc.green(`Successfully refreshed \`${XBOX_DIR_NAME}\` host.`));
+            resolve();
+        }
+        catch (error) {
+            reject(`Failed to refresh ${XBOX_DIR_NAME} host. ${error}`);
+        }
+    });
+};
+/**
+ * @description ゲームルートの `MicrosoftGame.config` をXboxホストへ注入する。
+ *              capacitor.config.json と同様、各ゲーム固有の設定(TitleId/StoreId/名称/ロゴ)は
+ *              プロジェクトルートで管理し、それをホストのビルド対象へ配置する。
+ *              未配置ならbuilder同梱の既定をフォールバックとして使い、作成を促す。
+ *              Inject the game-root `MicrosoftGame.config` into the Xbox host.
+ *
+ * @return {Promise}
+ * @method
+ * @public
+ */
+const injectGameConfig = () => {
+    return new Promise((resolve, reject) => {
+        const rootConfig = `${process.cwd()}/${XBOX_CONFIG_NAME}`;
+        const hostConfig = `${process.cwd()}/${XBOX_DIR_NAME}/${XBOX_CONFIG_NAME}`;
+        try {
+            if (fs.existsSync(rootConfig)) {
+                fs.cpSync(rootConfig, hostConfig);
+                console.log(pc.green(`Applied project \`${XBOX_CONFIG_NAME}\`.`));
+            }
+            else {
+                // フォールバック: builder同梱の既定を配置し、ルートへの作成を促す
+                fs.cpSync(`${getTemplateDir("xbox")}/${XBOX_CONFIG_NAME}`, hostConfig);
+                console.log(pc.yellow(`\`${XBOX_CONFIG_NAME}\` not found at project root. Using the default template.`));
+                console.log(pc.yellow(`Create \`${XBOX_CONFIG_NAME}\` at your project root (like capacitor.config.json) to set TitleId/StoreId/logos.`));
+            }
+            resolve();
+        }
+        catch (error) {
+            reject(`Failed to apply ${XBOX_CONFIG_NAME}. ${error}`);
+        }
+    });
+};
+/**
+ * @description ビルド済みWeb資材(JS/HTML/アセット)をXboxホストのassetsへ配置
+ *              Deploy built web resources (JS/HTML/assets) into the Xbox host assets
+ *
+ * @return {Promise}
+ * @method
+ * @public
+ */
+const copyXboxResources = () => {
+    return new Promise((resolve, reject) => {
+        const assetsDir = `${process.cwd()}/${XBOX_DIR_NAME}/assets/app`;
+        try {
+            // reset
+            fs.rmSync(assetsDir, { "recursive": true, "force": true });
+            fs.mkdirSync(assetsDir, { "recursive": true });
+            // copy built web resources (JS/HTML/assets)
+            fs.cpSync(`${$buildDir}/`, assetsDir, { "recursive": true });
+            console.log(pc.green("Successfully copy built resources to Xbox host."));
+            resolve();
+        }
+        catch (error) {
+            reject(`Failed to copy built resources to Xbox host. ${error}`);
+        }
+    });
+};
+/**
+ * @description Xbox(GDKネイティブ)用アプリの書き出し関数。
+ *              V8にNext2DのJSを載せ、Dawn(WebGPU/D3D12)で描画するC++ホストをビルドする。
+ *              Export function for Xbox (GDK native) apps.
+ *              Builds a C++ host that runs Next2D's JS on V8 and renders via Dawn (WebGPU/D3D12).
+ *
+ * @return {Promise}
+ * @method
+ * @public
+ */
+const buildXbox = async () => {
+    // C++/CMake ホストを最新へ更新 (ゲーム固有設定は除外)
+    await refreshXboxHost();
+    // ゲームルートの MicrosoftGame.config を注入
+    await injectGameConfig();
+    // ビルド済みWeb資材を配置
+    await copyXboxResources();
+    /**
+     * GDK ビルドは Windows + Visual Studio + Microsoft GDK が必須。
+     * それ以外の環境ではスキャフォールドと資材配置のみを行い、手順を案内する。
+     * The GDK build requires Windows + Visual Studio + Microsoft GDK.
+     * On other platforms we only scaffold and copy assets, then guide the next steps.
+     */
+    if (process.platform !== "win32") {
+        console.log();
+        console.log(pc.yellow("Xbox host project has been generated and assets were copied."));
+        console.log(pc.yellow("The GDK build must run on Windows with Visual Studio and the Microsoft GDK installed."));
+        console.log(pc.yellow(`See ${XBOX_DIR_NAME}/README.md for the build steps.`));
+        console.log();
+        return;
+    }
+    /**
+     * @type {string}
+     * GDK の対象コンソール世代。既定は Xbox Series X|S (Scarlett)。
+     * 必要に応じて `Gaming.Xbox.XboxOne.x64` / `Gaming.Desktop.x64` を選択。
+     */
+    const gdkArch = process.env.NEXT2D_XBOX_ARCH || "Gaming.Xbox.Scarlett.x64";
+    const cmakeBuildDir = `${process.cwd()}/${$outDir}/${platformDir}/build`;
+    /**
+     * prebuilt V8 monolith のパス。優先順: `--v8-root` 引数 > 環境変数 V8_ROOT。
+     * どちらも無い場合は CMake (FindV8.cmake) が明確なエラーで停止するため、
+     * ここでは事前に分かりやすく案内だけする。
+     */
+    const resolvedV8Root = v8Root
+        ? path.resolve(process.cwd(), v8Root)
+        : process.env.V8_ROOT || "";
+    if (!resolvedV8Root) {
+        console.log(pc.red("V8 path is not specified."));
+        console.log(pc.red("Pass `--v8-root <path>` (or set the V8_ROOT environment variable):"));
+        console.log(pc.red("  npx @next2d/builder --platform xbox --env prd --v8-root C:\\path\\to\\v8"));
+        console.log(pc.red(`The path must contain \`include/v8.h\` and \`lib/v8_monolith.lib\`. See ${XBOX_DIR_NAME}/README.md.`));
+        return;
+    }
+    if (!fs.existsSync(`${resolvedV8Root}/include/v8.h`)) {
+        console.log(pc.red(`\`include/v8.h\` not found under: ${resolvedV8Root}`));
+        console.log(pc.red(`Check the \`--v8-root\` path. See ${XBOX_DIR_NAME}/README.md for how to prepare the prebuilt V8.`));
+        return;
+    }
+    const configure = () => {
+        return new Promise((resolve, reject) => {
+            const stream = cp.spawn("cmake", [
+                "-S", `${process.cwd()}/${XBOX_DIR_NAME}`,
+                "-B", cmakeBuildDir,
+                "-G", "Visual Studio 17 2022",
+                "-A", gdkArch,
+                "-D", `V8_ROOT=${resolvedV8Root}`
+            ], { "stdio": "inherit" });
+            stream.on("close", (code) => {
+                if (code !== 0) {
+                    return reject("Failed to configure the Xbox (CMake/GDK) project.");
+                }
+                resolve();
+            });
+        });
+    };
+    await configure();
+    if (open || preview) {
+        // Visual Studio ソリューションを開く (実機/エミュレータでの実行はVS側で行う)
+        cp.spawn("cmake", [
+            "--open", cmakeBuildDir
+        ], { "stdio": "inherit" });
+        return;
+    }
+    // フルビルド (Release パッケージまで)
+    const stream = cp.spawn("cmake", [
+        "--build", cmakeBuildDir,
+        "--config", "Release"
+    ], { "stdio": "inherit" });
+    stream.on("close", (code) => {
+        if (code !== 0) {
+            console.log(pc.red("Export of the Xbox (GDK) package failed."));
+            return;
+        }
+        console.log();
+        console.log(pc.green(`Finished building the Xbox (GDK) package for ${gdkArch}.`));
+        console.log();
+    });
+};
 /**
  * @description ビルドの実行関数
  *              Build Execution Functions
@@ -468,8 +712,8 @@ const multiBuild = async () => {
                     break;
             }
             break;
-        case "open:ios":
-            await openNative();
+        case "xbox":
+            await buildXbox();
             break;
         case "web":
             console.log();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next2d/builder",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "Multi-platform builder for Next2d Framework, supporting export to various platforms such as macOS, Windows, iOS, Android and Web(HTML)",
   "author": "Toshiyuki Ienaga <ienaga@next2d.app>",
   "license": "MIT",
@@ -17,6 +17,7 @@
     "JavaScript for iOS",
     "JavaScript for Android",
     "JavaScript for Steam",
+    "JavaScript for Xbox",
     "Multi-platform builder"
   ],
   "scripts": {
@@ -24,7 +25,8 @@
     "release": "tsc"
   },
   "files": [
-    "dist"
+    "dist",
+    "templates"
   ],
   "repository": {
     "type": "git",
@@ -35,18 +37,18 @@
   },
   "dependencies": {
     "@electron-forge/core": "^7.11.2",
-    "@types/node": "^25.9.2",
+    "@types/node": "^26.1.0",
     "picocolors": "^1.1.1",
-    "vite": "^8.0.16"
+    "vite": "^8.1.2"
   },
   "devDependencies": {
     "@eslint/eslintrc": "^3.3.5",
     "@eslint/js": "^10.0.1",
-    "@typescript-eslint/eslint-plugin": "^8.60.1",
-    "@typescript-eslint/parser": "^8.60.1",
-    "eslint": "^10.4.1",
+    "@typescript-eslint/eslint-plugin": "^8.62.1",
+    "@typescript-eslint/parser": "^8.62.1",
+    "eslint": "^10.6.0",
     "eslint-plugin-unused-imports": "^4.4.1",
-    "globals": "^17.6.0",
+    "globals": "^17.7.0",
     "typescript": "^6.0.3"
   }
 }

package/templates/xbox/CMakeLists.txt

@@ -0,0 +1,121 @@
+# =============================================================================
+# Next2D Xbox (GDK native) host
+#
+# V8 に Next2D の JavaScript を載せ、Dawn(WebGPU/D3D12) で描画する
+# ネイティブタイトルをビルドする CMake プロジェクト。
+#
+# 対象トリプレット (builder が -A に渡す):
+#   - Gaming.Xbox.Scarlett.x64  : Xbox Series X|S
+#   - Gaming.Xbox.XboxOne.x64   : Xbox One
+#   - Gaming.Desktop.x64        : PC(GDK) / ローカル検証
+#
+# 必須:
+#   - Windows + Visual Studio 2022 (v143)
+#   - Microsoft GDK (June 2024 以降)
+#   - V8 の prebuilt ライブラリ (V8_ROOT で指定)
+#   - Dawn (FetchContent で取得・ビルド)
+# =============================================================================
+cmake_minimum_required(VERSION 3.26)
+
+project(Next2DXboxHost LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
+# GDK target platform (Gaming.Xbox.* / Gaming.Desktop.*) の判定
+if(NOT DEFINED CMAKE_GENERATOR_PLATFORM)
+    message(WARNING "CMAKE_GENERATOR_PLATFORM が未設定です。builder は -A Gaming.Xbox.Scarlett.x64 等を渡します。")
+endif()
+
+string(FIND "${CMAKE_GENERATOR_PLATFORM}" "Gaming.Xbox" _is_console)
+if(_is_console GREATER_EQUAL 0)
+    set(NEXT2D_IS_CONSOLE ON)
+else()
+    set(NEXT2D_IS_CONSOLE OFF)
+endif()
+
+# -----------------------------------------------------------------------------
+# 依存: Dawn (WebGPU 実装 / D3D12 バックエンド)
+# -----------------------------------------------------------------------------
+include(cmake/FetchDawn.cmake)
+
+# -----------------------------------------------------------------------------
+# 依存: V8 (prebuilt)
+#   V8 はソースからのビルドが重いため prebuilt を前提とする。
+#   cmake -D V8_ROOT=<path> で monolith ビルド (v8_monolith.lib) を指す。
+# -----------------------------------------------------------------------------
+include(cmake/FindV8.cmake)
+
+# -----------------------------------------------------------------------------
+# ソース
+# -----------------------------------------------------------------------------
+file(GLOB_RECURSE NEXT2D_HOST_SOURCES
+    "${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp"
+    "${CMAKE_CURRENT_SOURCE_DIR}/src/*.h"
+)
+
+add_executable(Next2DXboxHost WIN32 ${NEXT2D_HOST_SOURCES})
+
+target_include_directories(Next2DXboxHost PRIVATE
+    "${CMAKE_CURRENT_SOURCE_DIR}/src"
+)
+
+target_link_libraries(Next2DXboxHost PRIVATE
+    v8::v8
+    dawn::webgpu_dawn
+)
+
+# WebGPU / D3D12 / GameInput / WIC / XAudio2 / GDK
+target_link_libraries(Next2DXboxHost PRIVATE
+    d3d12
+    dxgi
+    dxguid
+    windowscodecs   # WIC: 画像デコード
+)
+
+if(NEXT2D_IS_CONSOLE)
+    # コンソール用ライブラリ (GDK が提供)
+    target_link_libraries(Next2DXboxHost PRIVATE
+        xgameruntime
+        gameinput
+        xaudio2_9      # コンソールは XAudio2.9
+    )
+    target_compile_definitions(Next2DXboxHost PRIVATE NEXT2D_XBOX_CONSOLE=1)
+else()
+    # PC(GDK) / ローカル検証
+    target_link_libraries(Next2DXboxHost PRIVATE
+        xgameruntime
+        gameinput
+        xaudio2
+    )
+    target_compile_definitions(Next2DXboxHost PRIVATE NEXT2D_XBOX_CONSOLE=0)
+endif()
+
+# V8 のプラットフォーム要件
+target_compile_definitions(Next2DXboxHost PRIVATE
+    V8_COMPRESS_POINTERS
+    V8_ENABLE_SANDBOX
+    NOMINMAX
+    WIN32_LEAN_AND_MEAN
+    UNICODE
+    _UNICODE
+)
+
+# -----------------------------------------------------------------------------
+# ランタイム資材のステージング
+#   builder が assets/app に JS/HTML/アセットを配置する。
+#   js/bootstrap.js はブラウザ相当グローバルを整える起動スクリプト。
+# -----------------------------------------------------------------------------
+add_custom_command(TARGET Next2DXboxHost POST_BUILD
+    COMMAND ${CMAKE_COMMAND} -E copy_directory
+        "${CMAKE_CURRENT_SOURCE_DIR}/assets"
+        "$<TARGET_FILE_DIR:Next2DXboxHost>/assets"
+    COMMAND ${CMAKE_COMMAND} -E copy_directory
+        "${CMAKE_CURRENT_SOURCE_DIR}/js"
+        "$<TARGET_FILE_DIR:Next2DXboxHost>/js"
+    COMMAND ${CMAKE_COMMAND} -E copy_if_different
+        "${CMAKE_CURRENT_SOURCE_DIR}/MicrosoftGame.config"
+        "$<TARGET_FILE_DIR:Next2DXboxHost>/MicrosoftGame.config"
+    COMMENT "Staging Next2D assets, bootstrap JS and MicrosoftGame.config"
+)

package/templates/xbox/MicrosoftGame.config

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  Microsoft GDK ゲーム構成ファイル。
+  ID@Xbox で発行される TitleId / StoreId / MSAAppId 等を Partner Center の値に置き換えること。
+  詳細: https://learn.microsoft.com/gaming/gdk/_content/gc/system/overviews/microsoft-game-config
+-->
+<Game configVersion="1">
+
+  <Identity Name="Next2DGame"
+            Publisher="CN=Next2D"
+            Version="1.0.0.0" />
+
+  <ExecutableList>
+    <Executable Name="Next2DXboxHost.exe"
+                Id="Game"
+                TargetDeviceFamily="XboxOne;Scarlett" />
+  </ExecutableList>
+
+  <ShellVisuals DefaultDisplayName="Next2D Game"
+                PublisherDisplayName="Next2D"
+                StoreLogo="assets\StoreLogo.png"
+                Square150x150Logo="assets\Square150x150Logo.png"
+                Square44x44Logo="assets\Square44x44Logo.png"
+                SplashScreenImage="assets\SplashScreen.png"
+                Description="A game built with Next2D." />
+
+  <!-- ID@Xbox 発行値に置き換える -->
+  <MSAAppId>00000000000000000000000000000000</MSAAppId>
+  <TitleId>00000000</TitleId>
+  <StoreId>0000000000000000</StoreId>
+
+  <VirtualMachineList>
+    <VirtualMachine SandboxId="XDKS.1" TitleId="00000000" />
+  </VirtualMachineList>
+
+</Game>