launch-unity 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Masamichi Hatayama
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.ja.md

@@ -0,0 +1,50 @@
+launch-unity
+=================
+
+[English](README.md) | [日本語](README.ja.md)
+
+Unity Hubを仲介せず、コマンドラインからUnityを立ち上げます。
+
+## 使用例
+```bash
+# NPX（推奨 / インストール不要）
+npx launch-unity                    # カレントディレクトリを開く（ビルドターゲット未指定時はプロジェクトの現在のビルドターゲットを使用）
+npx launch-unity /path/to/Proj      # プロジェクトを指定
+npx launch-unity /path Android      # ビルドターゲットを指定
+npx -y launch-unity                 # npx の「Ok to proceed?」確認をスキップ
+
+# `--` 以降は Unity のコマンドライン引数をそのまま転送
+npx launch-unity . -- -batchmode -quit -nographics -logFile -
+npx launch-unity /path Android -- -executeMethod My.Build.Entry
+
+# グローバルインストール後
+launch-unity
+launch-unity /path/to/MyUnityProject Android
+launch-unity . -- -buildTarget iOS -projectPath . # 上書きも可能
+```
+
+指定した Unity プロジェクトの `ProjectSettings/ProjectVersion.txt` から必要な Unity Editor のバージョンを読み取り、
+Unity Hub でインストール済みの該当バージョンを起動する macOS/Windows 向け TypeScript 製 CLI です。`Temp/UnityLockfile` が
+存在する場合は、削除して続行するかをターミナル上で確認します。
+
+既定で想定する Unity のパス:
+- macOS: `/Applications/Unity/Hub/Editor/<version>/Unity.app/Contents/MacOS/Unity`
+- Windows（検索対象）:
+  - `%PROGRAMFILES%/Unity/Hub/Editor/<version>/Editor/Unity.exe`
+  - `%PROGRAMFILES(X86)%/Unity/Hub/Editor/<version>/Editor/Unity.exe`
+  - `%LOCALAPPDATA%/Unity/Hub/Editor/<version>/Editor/Unity.exe`
+  - `C:\\Program Files\\Unity\\Hub\\Editor\\<version>\\Editor\\Unity.exe`
+
+
+## トラブルシューティング
+- エラー: `ProjectVersion.txt not found`
+  - 指定ディレクトリが Unity プロジェクト直下ではありません。プロジェクトのルートを指定してください。
+- エラー: `Unity <version> not found`
+  - 該当バージョンの Unity を Unity Hub でインストールしてください。独自パスの場合は解決ロジックの修正を検討してください。
+
+## プラットフォーム注意事項
+- macOS / Windows: Unity Hub のデフォルトインストールパスを前提にサポート。
+- Linux: 未対応です。対応 PR を歓迎します。
+
+## ライセンス
+- MIT。詳細は `LICENSE` を参照してください。

package/README.md

@@ -0,0 +1,77 @@
+launch-unity
+=================
+
+[English](README.md) | [日本語](README.ja.md)
+
+Without Unity Hub, launch Unity from the command line.
+
+## Usage Examples
+```bash
+# NPX (recommended, zero install)
+npx launch-unity                   # Open the current directory (if PLATFORM is omitted, uses the project's current build target)
+npx launch-unity /path/to/Proj     # Open a specific project
+npx launch-unity /path Android     # Specify build target
+npx -y launch-unity                # Skip npx "Ok to proceed?" prompt
+
+# Pass through Unity CLI args with --
+npx launch-unity . -- -batchmode -quit -nographics -logFile -
+npx launch-unity /path Android -- -executeMethod My.Build.Entry
+
+# Installed globally
+launch-unity
+launch-unity /path/to/MyUnityProject Android
+launch-unity . -- -buildTarget iOS -projectPath . # You can override
+```
+
+A TypeScript CLI for macOS and Windows that reads the required Unity Editor version from
+`ProjectSettings/ProjectVersion.txt`, launches the matching Unity installed via Unity Hub,
+and opens the project. If `Temp/UnityLockfile` exists, it asks in the terminal whether to
+delete it before continuing.
+
+Default Unity paths assumed:
+- macOS: `/Applications/Unity/Hub/Editor/<version>/Unity.app/Contents/MacOS/Unity`
+- Windows (searched):
+  - `%PROGRAMFILES%/Unity/Hub/Editor/<version>/Editor/Unity.exe`
+  - `%PROGRAMFILES(X86)%/Unity/Hub/Editor/<version>/Editor/Unity.exe`
+  - `%LOCALAPPDATA%/Unity/Hub/Editor/<version>/Editor/Unity.exe`
+  - `C:\\Program Files\\Unity\\Hub\\Editor\\<version>\\Editor\\Unity.exe`
+
+
+## Quick Setup
+```bash
+# No install: use npx
+npx launch-unity -h
+
+# Optional: install globally after cloning
+npm i -g .
+```
+
+
+## Detailed Usage
+```bash
+# Basic syntax
+launch-unity [PROJECT_PATH] [PLATFORM]
+
+# Arguments
+# - PROJECT_PATH (optional): Unity project directory. Defaults to current directory
+# - PLATFORM     (optional): Passed to Unity as -buildTarget (e.g., StandaloneOSX, Android, iOS)
+
+# Flags
+# -h, --help  Show help
+```
+
+
+## Troubleshooting
+- Error: `ProjectVersion.txt not found`
+  - The provided directory is not a Unity project. Point to the project root.
+- Error: `Unity <version> not found`
+  - Install the required version via Unity Hub, or adjust Unity path resolution.
+
+
+## Platform Notes
+- macOS, Windows: Supported via Unity Hub default install paths.
+- Linux: Not supported yet. Contributions are welcome.
+
+
+## License
+- MIT. See `LICENSE` for details.

package/dist/cli.js

@@ -0,0 +1,274 @@
+#!/usr/bin/env node
+/*
+  launch-unity: Open a Unity project with the matching Editor version.
+  Platforms: macOS, Windows
+*/
+import { spawn } from "node:child_process";
+import { existsSync, readFileSync, rmSync, createReadStream, createWriteStream } from "node:fs";
+import { join, resolve } from "node:path";
+import readline from "node:readline";
+function parseArgs(argv) {
+    const defaultProjectPath = process.cwd();
+    const args = argv.slice(2);
+    const doubleDashIndex = args.indexOf("--");
+    const cliArgs = doubleDashIndex >= 0 ? args.slice(0, doubleDashIndex) : args;
+    const unityArgs = doubleDashIndex >= 0 ? args.slice(doubleDashIndex + 1) : [];
+    const positionals = [];
+    for (const arg of cliArgs) {
+        if (arg === "--help" || arg === "-h") {
+            printHelp();
+            process.exit(0);
+        }
+        else if (arg.startsWith("-")) {
+            // Unknown flags are ignored to keep CLI permissive
+            continue;
+        }
+        else {
+            positionals.push(arg);
+        }
+    }
+    const projectPath = positionals[0] ? resolve(positionals[0]) : defaultProjectPath;
+    const platform = positionals[1] ? String(positionals[1]) : undefined;
+    const options = { projectPath, platform, unityArgs };
+    return options;
+}
+function printHelp() {
+    const help = `
+Usage: launch-unity [PROJECT_PATH] [PLATFORM] -- [UNITY_ARGS...]
+
+Open a Unity project with the matching Unity Editor version installed by Unity Hub.
+
+Arguments:
+  PROJECT_PATH  Optional. Defaults to current directory
+  PLATFORM      Optional. Passed to Unity as -buildTarget (e.g., StandaloneOSX, Android, iOS)
+
+Forwarding:
+  Everything after -- is forwarded to Unity unchanged.
+  If UNITY_ARGS includes -buildTarget, the PLATFORM argument is ignored.
+
+Flags:
+  -h, --help    Show this help message
+`;
+    process.stdout.write(help);
+}
+function getUnityVersion(projectPath) {
+    const versionFile = join(projectPath, "ProjectSettings", "ProjectVersion.txt");
+    if (!existsSync(versionFile)) {
+        console.error(`Error: ProjectVersion.txt not found at ${versionFile}`);
+        console.error("This does not appear to be a Unity project.");
+        process.exit(1);
+    }
+    const content = readFileSync(versionFile, "utf8");
+    const version = content.match(/m_EditorVersion:\s*([^\s\n]+)/)?.[1];
+    if (!version) {
+        console.error(`Error: Could not extract Unity version from ${versionFile}`);
+        process.exit(1);
+    }
+    return version;
+}
+function getUnityPathWindows(version) {
+    const candidates = [];
+    const programFiles = process.env["PROGRAMFILES"];
+    const programFilesX86 = process.env["PROGRAMFILES(X86)"];
+    const localAppData = process.env["LOCALAPPDATA"];
+    const addCandidate = (base) => {
+        if (!base)
+            return;
+        candidates.push(join(base, "Unity", "Hub", "Editor", version, "Editor", "Unity.exe"));
+    };
+    addCandidate(programFiles);
+    addCandidate(programFilesX86);
+    addCandidate(localAppData);
+    candidates.push(join("C:\\", "Program Files", "Unity", "Hub", "Editor", version, "Editor", "Unity.exe"));
+    for (const candidate of candidates) {
+        if (existsSync(candidate))
+            return candidate;
+    }
+    return candidates[0] ?? join("C:\\", "Program Files", "Unity", "Hub", "Editor", version, "Editor", "Unity.exe");
+}
+function getUnityPath(version) {
+    if (process.platform === "darwin") {
+        return `/Applications/Unity/Hub/Editor/${version}/Unity.app/Contents/MacOS/Unity`;
+    }
+    if (process.platform === "win32") {
+        return getUnityPathWindows(version);
+    }
+    return `/Applications/Unity/Hub/Editor/${version}/Unity.app/Contents/MacOS/Unity`;
+}
+function ensureProjectPath(projectPath) {
+    if (!existsSync(projectPath)) {
+        console.error(`Error: Project directory not found: ${projectPath}`);
+        process.exit(1);
+    }
+}
+function createPromptInterface() {
+    if (process.stdin.isTTY && process.stdout.isTTY) {
+        const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+        const close = () => rl.close();
+        return { rl, close };
+    }
+    try {
+        if (process.platform === "win32") {
+            const inCandidates = ["\\\\.\\CONIN$", "CONIN$"];
+            const outCandidates = ["\\\\.\\CONOUT$", "CONOUT$"];
+            for (const inPath of inCandidates) {
+                for (const outPath of outCandidates) {
+                    try {
+                        const input = createReadStream(inPath);
+                        const output = createWriteStream(outPath);
+                        const rl = readline.createInterface({ input, output });
+                        const close = () => {
+                            rl.close();
+                            input.destroy();
+                            output.end();
+                        };
+                        return { rl, close };
+                    }
+                    catch {
+                        continue;
+                    }
+                }
+            }
+        }
+        else {
+            const input = createReadStream("/dev/tty");
+            const output = createWriteStream("/dev/tty");
+            const rl = readline.createInterface({ input, output });
+            const close = () => {
+                rl.close();
+                input.destroy();
+                output.end();
+            };
+            return { rl, close };
+        }
+    }
+    catch {
+        // fallthrough
+    }
+    return null;
+}
+async function handleUnityLockfilePrompt(lockfilePath) {
+    // Prefer single-key confirmation when a real TTY is available
+    if (process.stdin.isTTY && process.stdout.isTTY && typeof process.stdin.setRawMode === "function") {
+        const confirmedByKey = await promptYesNoSingleKey("Delete UnityLockfile and continue? Type 'y' to continue; anything else aborts: ");
+        if (!confirmedByKey) {
+            console.log("Aborted by user.");
+            return false;
+        }
+        rmSync(lockfilePath, { force: true });
+        console.log("Deleted UnityLockfile. Continuing launch.");
+        return true;
+    }
+    // Fallback to line-based prompt through OS console handles
+    const prompt = createPromptInterface();
+    if (!prompt) {
+        console.error("UnityLockfile exists. No interactive console available for confirmation.");
+        return false;
+    }
+    const confirmed = await new Promise((resolve) => {
+        prompt.rl.question("Delete UnityLockfile and continue? Type 'y' to continue; anything else aborts: ", (answer) => {
+            resolve(answer.trim() === "y");
+        });
+    });
+    prompt.close();
+    if (!confirmed) {
+        console.log("Aborted by user.");
+        return false;
+    }
+    rmSync(lockfilePath, { force: true });
+    console.log("Deleted UnityLockfile. Continuing launch.");
+    return true;
+}
+function stdinSupportsRawMode() {
+    const stdin = process.stdin;
+    return Boolean(stdin && stdin.isTTY && typeof stdin.setRawMode === "function" && process.stdout.isTTY);
+}
+async function promptYesNoSingleKey(message) {
+    if (!stdinSupportsRawMode())
+        return false;
+    const stdin = process.stdin;
+    return await new Promise((resolve) => {
+        const handleData = (data) => {
+            const firstByte = data[0] ?? 0;
+            const char = data.toString();
+            let result = false;
+            if (char === "y") {
+                result = true;
+            }
+            else if (firstByte === 3 /* Ctrl+C */ || firstByte === 27 /* ESC */ || char === "n" || char === "N" || firstByte === 13 /* Enter */) {
+                result = false;
+            }
+            else {
+                result = false;
+            }
+            process.stdout.write("\n");
+            cleanup();
+            resolve(result);
+        };
+        const cleanup = () => {
+            if (typeof stdin.setRawMode === "function")
+                stdin.setRawMode(false);
+            stdin.pause();
+            stdin.removeListener("data", handleData);
+        };
+        process.stdout.write(message);
+        if (typeof stdin.setRawMode === "function")
+            stdin.setRawMode(true);
+        stdin.resume();
+        stdin.once("data", handleData);
+    });
+}
+async function checkUnityRunning(projectPath) {
+    const lockfile = join(projectPath, "Temp", "UnityLockfile");
+    if (!existsSync(lockfile))
+        return true;
+    console.log(`UnityLockfile found: ${lockfile}`);
+    console.log("Another Unity process may be using this project.");
+    return await handleUnityLockfilePrompt(lockfile);
+}
+function hasBuildTargetArg(unityArgs) {
+    for (const arg of unityArgs) {
+        if (arg === "-buildTarget")
+            return true;
+        if (arg.startsWith("-buildTarget="))
+            return true;
+    }
+    return false;
+}
+function launch(opts) {
+    const { projectPath, platform, unityArgs } = opts;
+    const unityVersion = getUnityVersion(projectPath);
+    const unityPath = getUnityPath(unityVersion);
+    console.log(`Detected Unity version: ${unityVersion}`);
+    if (!existsSync(unityPath)) {
+        console.error(`Error: Unity ${unityVersion} not found at ${unityPath}`);
+        console.error("Please install Unity through Unity Hub.");
+        process.exit(1);
+    }
+    console.log("Opening Unity...");
+    console.log(`Project Path: ${projectPath}`);
+    const args = ["-projectPath", projectPath];
+    const unityArgsContainBuildTarget = hasBuildTargetArg(unityArgs);
+    if (platform && platform.length > 0 && !unityArgsContainBuildTarget) {
+        args.push("-buildTarget", platform);
+    }
+    if (unityArgs.length > 0) {
+        args.push(...unityArgs);
+    }
+    const child = spawn(unityPath, args, { stdio: "ignore", detached: true });
+    child.unref();
+}
+async function main() {
+    const options = parseArgs(process.argv);
+    ensureProjectPath(options.projectPath);
+    const ok = await checkUnityRunning(options.projectPath);
+    if (!ok) {
+        process.exit(0);
+        return;
+    }
+    launch(options);
+}
+main().catch((error) => {
+    console.error(error);
+    process.exit(1);
+});

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "launch-unity",
+  "version": "0.1.0",
+  "description": "Open a Unity project with the matching Editor version (macOS/Windows)",
+  "type": "module",
+  "main": "dist/cli.js",
+  "bin": {
+    "launch-unity": "dist/cli.js"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "start": "node dist/cli.js",
+    "lint": "eslint . --ext .ts,.js",
+    "lint:fix": "eslint . --ext .ts,.js --fix",
+    "format": "prettier --write .",
+    "prepack": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/hatayama/LaunchUnityCommand.git"
+  },
+  "keywords": [
+    "unity",
+    "unity-hub",
+    "cli",
+    "macos",
+    "windows"
+  ],
+  "author": "",
+  "license": "MIT",
+  "files": [
+    "dist",
+    "README.md",
+    "README.ja.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "@types/node": "^22.7.4",
+    "@typescript-eslint/eslint-plugin": "^8.6.0",
+    "@typescript-eslint/parser": "^8.6.0",
+    "eslint": "^9.10.0",
+    "eslint-config-prettier": "^9.1.0",
+    "prettier": "^3.3.3",
+    "typescript": "^5.6.2"
+  },
+  "dependencies": {
+    "typescript-eslint": "^8.42.0"
+  }
+}