@idajs/create-mod 0.1.44-dev.51

package/_project.config/sync.js

@@ -0,0 +1,100 @@
+const { execSync } = require("child_process");
+const path = require("path");
+const fs = require("fs");
+const os = require("os");
+
+// Function to read IdaJS installation directory from .idajs.json
+function getIdaJsPath() {
+  // Try local config first, then user home config
+  const configPaths = [path.join(__dirname, ".idajs.json"), path.join(os.homedir(), ".idajs.json")];
+
+  for (const configPath of configPaths) {
+    if (fs.existsSync(configPath)) {
+      try {
+        const config = JSON.parse(fs.readFileSync(configPath, "utf8"));
+        if (config.installDir) {
+          return config.installDir;
+        }
+      } catch (err) {
+        // Ignore parse errors and try next config
+      }
+    }
+  }
+
+  return null;
+}
+
+// Get package name from command line argument
+const packageName = process.argv[2];
+
+if (!packageName) {
+  console.error("Error: Package name is required as an argument");
+  console.error("Usage: node sync.js <package-name>");
+  process.exit(1);
+}
+
+// Get IdaJS installation path
+const idaJsPath = getIdaJsPath();
+if (!idaJsPath) {
+  console.error("Error: .idajs.json not found in current directory or user home directory.");
+  console.error("Please build IdaJS first or create .idajs.json with 'installDir' property.");
+  process.exit(1);
+}
+
+if (!fs.existsSync(idaJsPath)) {
+  console.error(`Error: IdaJS installation directory does not exist: ${idaJsPath}`);
+  console.error("Please build IdaJS first.");
+  process.exit(1);
+}
+
+const isTypeScriptProject = (() => {
+  // Check if tsconfig.json exists
+  if (!fs.existsSync("tsconfig.json")) {
+    return false;
+  }
+
+  // Check if there are any .ts files in src/
+  if (!fs.existsSync("src")) {
+    return false;
+  }
+
+  const files = fs.readdirSync("src");
+  return files.some((file) => file.endsWith(".ts"));
+})();
+
+const targetBase = path.join(idaJsPath, "GameRun", "mods", packageName);
+const deleteExcludeArgs = '--delete-exclude "*.ida" --delete-exclude "*.md5"';
+
+console.log(`Syncing ${packageName}...`);
+
+// If TypeScript project, compile first
+if (isTypeScriptProject) {
+  console.log("TypeScript project detected, compiling...");
+
+  // Clean dist folder
+  if (fs.existsSync("dist")) {
+    console.log("Cleaning dist folder...");
+    fs.rmSync("dist", { recursive: true, force: true });
+  }
+
+  // Compile TypeScript
+  execSync("tsc", { stdio: "inherit" });
+  console.log("Compilation complete!");
+}
+
+// Sync media folder if it exists
+if (fs.existsSync("media")) {
+  const mediaSyncCmd = `idasync media ${path.join(targetBase, "media")} ${deleteExcludeArgs}`;
+  console.log(`Running: ${mediaSyncCmd}`);
+  execSync(mediaSyncCmd, { stdio: "inherit" });
+} else {
+  console.log("No media folder found, skipping media sync");
+}
+
+// Sync src folder
+const sourceFolder = isTypeScriptProject ? "dist" : "src";
+const srcSyncCmd = `idasync ${sourceFolder} ${targetBase} ${deleteExcludeArgs} --delete-exclude "media/*"`;
+console.log(`Running: ${srcSyncCmd}`);
+execSync(srcSyncCmd, { stdio: "inherit" });
+
+console.log("Sync completed!");

package/_project.config/template.prettierrc.json

@@ -0,0 +1,11 @@
+{
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": false,
+  "trailingComma": "es5",
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "endOfLine": "lf"
+}

package/_project.config/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES2021",
+    "module": "CommonJS",
+    "lib": ["ES2021", "DOM"],
+    "outDir": "dist",
+    "removeComments": true,
+    "allowJs": true,
+    "checkJs": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "baseUrl": ".",
+    "types": ["@idajs/types"],
+    "typeRoots": ["./node_modules/@types", "./node_modules"],
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*.ts", "src/**/*.js"],
+  "exclude": ["node_modules"]
+}

package/_project.config/watch.js

@@ -0,0 +1,76 @@
+/**
+ * Watches for file changes in the src/ and media/ directories
+ * and runs the sync script to copy changed files to the game mod directory.
+ * Exits when the LBA2.exe process is no longer running.
+ */
+
+const chokidar = require("chokidar");
+const { spawn, exec } = require("child_process");
+const { promisify } = require("util");
+
+const execAsync = promisify(exec);
+const PROC_NAME = "LBA2.exe";
+
+let syncing = null;
+function runSync() {
+  if (syncing) return; // prevent overlapping syncs
+  syncing = spawn("npm", ["run", "sync"], { stdio: "inherit", shell: true });
+  syncing.on("exit", () => (syncing = null));
+}
+
+const watcher = chokidar.watch(["src/**/*.js", "media/**/*.png"], {
+  ignoreInitial: true,
+});
+
+watcher.on("all", () => runSync());
+
+async function isProcRunning() {
+  try {
+    const { stdout } = await execAsync(
+      `powershell -Command "Get-Process | Where-Object {$_.ProcessName -eq '${PROC_NAME.replace(".exe", "")}'} | Select-Object -First 1"`,
+      {
+        timeout: 5000,
+      }
+    );
+    return stdout.trim().length > 0;
+  } catch (error) {
+    // Process not found or command failed
+    return false;
+  }
+}
+
+async function killGameProc() {
+  try {
+    await execAsync(
+      `powershell -Command "Stop-Process -Name '${PROC_NAME.replace(".exe", "")}' -Force -ErrorAction SilentlyContinue"`
+    );
+  } catch (e) {
+    // Process may already be stopped
+  }
+}
+
+const interval = setInterval(async () => {
+  try {
+    const alive = await isProcRunning();
+    if (!alive) {
+      console.log(`${PROC_NAME} not running. Exiting watcher.`);
+
+      clearInterval(interval);
+      await watcher.close();
+      process.exit(0);
+    }
+  } catch (e) {
+    // if process listing fails, you can decide to ignore or stop
+  }
+}, 1000);
+
+// Ctrl+C cleanup
+process.on("SIGINT", async () => {
+  console.log("Caught interrupt signal. Exiting watcher.");
+
+  clearInterval(interval);
+  await watcher.close();
+  await killGameProc();
+
+  process.exit(0);
+});

package/_project.template/media/README.md

@@ -0,0 +1,26 @@
+# Media Assets
+
+This folder contains custom media assets for your mod.
+
+## Directory Structure
+
+You can create `images` and `sprites` folders here to have custom PNG files for your IdaJS mod:
+
+```
+media/
+├── images/
+│   ├── my-dialog-bg.png
+│   ├── cutscene-01.png
+│   └── ...
+└── sprites/
+    ├── item-icon.png
+    ├── character-portrait.png
+    └── ...
+```
+
+## Usage
+
+- **`images/`** - Full-screen dialog backgrounds and standalone images
+- **`sprites/`** - In-dialog pictures and smaller graphics used within dialogs
+
+All PNG files will be automatically synced to your IdaJS installation when you run `npm start` or `npm run sync`.

package/_project.template/package.template.json

@@ -0,0 +1,4 @@
+{
+  "name": "PROJECT_NAME",
+  "description": "Do not run the code in this folder. It's a template for creating new IdaJS projects."
+}

package/_project.template/src/index.js

@@ -0,0 +1,63 @@
+/**
+ * Welcome to IdaJS modding!
+ * Read the documentation here: https://ida.innerbytes.com
+ */
+console.log("Welcome to the IdaJS project!\n");
+
+/**
+ * Start with this event handler to setup every scene, the mod needs to modify
+ */
+scene.addEventListener(scene.Events.afterLoadScene, (sceneId, sceneLoadMode) => {
+  // Setup initial behavior for the Twinsen house scene here
+  if (sceneId === 0) {
+    // Do something with Twinsen and Zoe objects here.
+    // See Samples for mod examples
+    const twinsen = scene.getObject(0);
+    const zoe = scene.getObject(4);
+
+    // Handle move script if you will run custom coroutines on the object
+    // twinsen.handleMoveScript();
+
+    // Handle life script if you want to have custom behavior on the object
+    // twinsen.handleLifeScript(myLifeScriptFunction);
+
+    // Register your coroutines
+    registerCoroutine("myCoroutine", myCoroutineFunction);
+
+    // Do more setup - add and modify Zones, Waypoints, Objects, etc - as needed
+
+    // If new game started, do initialization of your game variables here as well, as needed:
+    if (sceneLoadMode === scene.LoadModes.NewGameStarted) {
+      const gameStore = useGameStore();
+      gameStore.myVariable = "some value";
+    }
+
+    // If it's any other load mode, except loading from saved state, do scene state initialization here - init scene variables, start some coroutines, that should run from scene start, etc
+    if (sceneLoadMode !== scene.LoadModes.WillLoadSavedState) {
+      const sceneStore = useSceneStore();
+      sceneStore.mySceneVariable = 42;
+
+      // Start the previously registered "myCoroutine" on object 0 (Twinsen), with some arguments
+      // startCoroutine(0, "myCoroutine", 1, 2, 3, 4);
+    }
+  }
+  // Setup initial behavior for the outside Twinsen house scene here
+  else if (sceneId === 49) {
+    // Scene setup
+  }
+
+  // Etc
+  // Look at https://lba2remake.net to see the needed scene ids
+  // Teleport to the desired scene in the Editor, the id will be shown in the inspector
+  /* 
+  else if (sceneId === 1) {
+    // Scene setup
+  }
+  */
+});
+
+// Example of a coroutine function with some arguments
+function* myCoroutineFunction(arg1, arg2, arg3, etc) {
+  // Your coroutine code goes here
+  yield doMove(ida.Move.TM_ANIM, 0);
+}

package/_project.template/src/index.ts

@@ -0,0 +1,66 @@
+import { SceneLoadMode } from "@idajs/types";
+
+/**
+ * Welcome to IdaJS modding!
+ * Read the documentation here: https://ida.innerbytes.com
+ */
+console.log("Welcome to the IdaJS project!\n");
+
+/**
+ * Start with this event handler to setup every scene, the mod needs to modify
+ */
+scene.addEventListener(
+  scene.Events.afterLoadScene,
+  (sceneId: number, sceneLoadMode: SceneLoadMode) => {
+    // Setup initial behavior for the Twinsen house scene here
+    if (sceneId === 0) {
+      // Do something with Twinsen and Zoe objects here.
+      // See Samples for mod examples
+      const twinsen = scene.getObject(0);
+      const zoe = scene.getObject(4);
+
+      // Handle move script if you will run custom coroutines on the object
+      // twinsen.handleMoveScript();
+
+      // Handle life script if you want to have custom behavior on the object
+      // twinsen.handleLifeScript(myLifeScriptFunction);
+
+      // Register your coroutines
+      registerCoroutine("myCoroutine", myCoroutineFunction);
+
+      // Do more setup - add and modify Zones, Waypoints, Objects, etc - as needed
+
+      // If new game started, do initialization of your game variables here as well, as needed:
+      if (sceneLoadMode === scene.LoadModes.NewGameStarted) {
+        const gameStore = useGameStore();
+        gameStore.myVariable = "some value";
+      }
+
+      // If it's any other load mode, except loading from saved state, do scene state initialization here - init scene variables, start some coroutines, that should run from scene start, etc
+      if (sceneLoadMode !== scene.LoadModes.WillLoadSavedState) {
+        const sceneStore = useSceneStore();
+        sceneStore.mySceneVariable = 42;
+
+        // Start the previously registered "myCoroutine" on object 0 (Twinsen), with some arguments
+        // startCoroutine(0, "myCoroutine", 1, true, "three", [4]);
+      }
+    }
+    // Setup initial behavior for the outside Twinsen house scene here
+    else if (sceneId === 49) {
+      // Scene setup
+    }
+
+    // Etc
+    // Look at https://lba2remake.net to see the needed scene ids
+    // Teleport to the desired scene in the Editor, the id will be shown in the inspector
+    // else if (sceneId === <neededSceneId>) {
+    //   // Scene setup
+    // }
+  }
+);
+
+// Example of a coroutine function with some arguments
+function* myCoroutineFunction(arg1: number, arg2: boolean, arg3: string, etc: number[]) {
+  // Your coroutine code goes here
+  yield doMove(ida.Move.TM_ANIM, 0);
+}

package/index.js

@@ -0,0 +1,292 @@
+#!/usr/bin/env node
+
+const fs = require("fs");
+const path = require("path");
+const os = require("os");
+const { execSync } = require("child_process");
+const IdaSync = require("@idajs/sync");
+
+// Parse command line arguments
+const args = process.argv.slice(2);
+
+// Helper to get argument value
+function getArgValue(argName) {
+  const index = args.findIndex((arg) => arg === argName || arg.startsWith(`${argName}=`));
+  if (index === -1) return null;
+  const arg = args[index];
+  if (arg.includes("=")) {
+    return arg.split("=")[1];
+  }
+  return args[index + 1];
+}
+
+const projectName = args.find((arg) => !arg.startsWith("--"));
+const targetDirectory = getArgValue("--dir") || getArgValue("--directory");
+const idajsDir = getArgValue("--idajs-dir") || getArgValue("--idajs");
+const useTypeScript = args.includes("--typescript") || args.includes("--ts");
+const useJavaScript = args.includes("--javascript") || args.includes("--js");
+const skipInstall = args.includes("--skip-install");
+const helpRequested = args.includes("--help") || args.includes("-h");
+
+// Show help if requested
+if (helpRequested) {
+  console.log(`
+Usage: npx @idajs/create-mod [project-name] [options]
+
+Arguments:
+  project-name                    Name of your mod project (default: my-ida-mod)
+
+Options:
+  --dir, --directory <path>       Target directory (default: project name)
+  --idajs-dir, --idajs <path>     IdaJS installation directory
+  --typescript, --ts              Use TypeScript
+  --javascript, --js              Use JavaScript
+  --skip-install                  Skip npm install
+  -h, --help                      Show this help message
+
+Examples:
+  npx @idajs/create-mod
+  npx @idajs/create-mod my-awesome-mod
+  npx @idajs/create-mod my-mod --typescript
+  npx @idajs/create-mod my-mod --dir ./projects/my-mod --idajs C:/Projects/idajs --js
+  npx @idajs/create-mod my-mod --skip-install
+`);
+  process.exit(0);
+}
+
+// Function to read IdaJS directory from config file
+function getIdaJsDirFromConfig() {
+  const configPath = path.join(os.homedir(), ".idajs.json");
+  try {
+    if (fs.existsSync(configPath)) {
+      const config = JSON.parse(fs.readFileSync(configPath, "utf8"));
+      if (config.installDir) {
+        return config.installDir;
+      }
+    }
+  } catch (err) {
+    // Ignore errors, will prompt user
+  }
+  return null;
+}
+
+async function main() {
+  console.log("Welcome to IdaJS Mod Creator!\n");
+
+  // Determine if we need prompts
+  const needsPrompts =
+    !projectName || (!useTypeScript && !useJavaScript) || (!idajsDir && !getIdaJsDirFromConfig());
+
+  let config = {
+    projectName: projectName || "my-ida-mod",
+    targetDirectory: targetDirectory,
+    idajsDir: idajsDir,
+    language: useTypeScript ? "ts" : useJavaScript ? "js" : null,
+    install: !skipInstall,
+  };
+
+  // Try to get IdaJS directory from config if not provided via CLI
+  if (!config.idajsDir) {
+    const configDir = getIdaJsDirFromConfig();
+    if (configDir) {
+      config.idajsDir = configDir;
+      console.log(`Found IdaJS installation: ${configDir}\n`);
+    } else {
+      console.log("⚠️  Warning: ~/.idajs.json not found. Make sure you have built IdaJS first.\n");
+    }
+  }
+
+  // Use prompts only if needed
+  if (needsPrompts) {
+    const prompts = require("prompts");
+
+    const questions = [];
+
+    if (!projectName) {
+      questions.push({
+        type: "text",
+        name: "projectName",
+        message: "Project name:",
+        initial: "my-ida-mod",
+        validate: (value) => (value.length > 0 ? true : "Project name cannot be empty"),
+      });
+    }
+
+    if (!config.targetDirectory) {
+      questions.push({
+        type: "text",
+        name: "targetDirectory",
+        message: "Target directory:",
+        initial: (prev) => prev || config.projectName,
+      });
+    }
+
+    if (!config.idajsDir) {
+      questions.push({
+        type: "text",
+        name: "idajsDir",
+        message: "IdaJS installation directory:",
+        validate: (value) => {
+          if (!value || value.length === 0) {
+            return "IdaJS installation directory is required";
+          }
+          if (!fs.existsSync(value)) {
+            return `Directory does not exist: ${value}`;
+          }
+          return true;
+        },
+      });
+    }
+
+    if (!config.language) {
+      questions.push({
+        type: "select",
+        name: "language",
+        message: "Select language:",
+        choices: [
+          { title: "JavaScript", value: "js" },
+          { title: "TypeScript", value: "ts" },
+        ],
+        initial: 0,
+      });
+    }
+
+    const response = await prompts(questions, {
+      onCancel: () => {
+        console.log("\nCancelled by user");
+        process.exit(1);
+      },
+    });
+
+    config = { ...config, ...response };
+  }
+
+  // Set target directory to project name if not specified
+  if (!config.targetDirectory) {
+    config.targetDirectory = config.projectName;
+  }
+
+  const targetDir = path.isAbsolute(config.targetDirectory)
+    ? config.targetDirectory
+    : path.join(process.cwd(), config.targetDirectory);
+
+  // Validate IdaJS directory exists
+  if (!fs.existsSync(config.idajsDir)) {
+    console.error(`\n❌ Error: IdaJS installation directory does not exist: ${config.idajsDir}`);
+    process.exit(1);
+  }
+
+  // Check if directory already exists
+  if (fs.existsSync(targetDir)) {
+    console.error(`\n❌ Error: Directory already exists: ${targetDir}`);
+    process.exit(1);
+  }
+
+  console.log(`\nCreating IdaJS mod in ${targetDir}...`);
+  console.log(`Language: ${config.language === "js" ? "JavaScript" : "TypeScript"}`);
+  console.log(`IdaJS: ${config.idajsDir}\n`);
+
+  try {
+    // Create project directory
+    fs.mkdirSync(targetDir, { recursive: true });
+
+    // Get paths
+    const templatesDir = path.join(__dirname, "_project.template");
+
+    // Copy all files and folders from _project.template using IdaSync
+    console.log("Copying template files...");
+
+    // Exclude files based on selected language
+    const copyExclusions =
+      config.language === "js"
+        ? ["src/index.ts", "tsconfig.json"]
+        : ["src/index.js", "jsconfig.json"];
+
+    const sync = new IdaSync({
+      verbose: false,
+      copyExclusions: copyExclusions,
+    });
+
+    await sync.sync(templatesDir, targetDir);
+    console.log("✓ Copied template structure");
+
+    // Modify package.template.json
+    const packageTemplatePath = path.join(targetDir, "package.template.json");
+    const packageTemplate = JSON.parse(fs.readFileSync(packageTemplatePath, "utf8"));
+    packageTemplate.name = config.projectName;
+    packageTemplate.description = "This is a new IdaJS project";
+    fs.writeFileSync(packageTemplatePath, JSON.stringify(packageTemplate, null, 2) + "\n");
+    console.log("✓ Updated package.template.json");
+
+    // Create .idajs.json config file
+    const idajsConfig = {
+      installDir: config.idajsDir,
+    };
+    fs.writeFileSync(
+      path.join(targetDir, ".idajs.json"),
+      JSON.stringify(idajsConfig, null, 2) + "\n"
+    );
+    console.log("✓ Created .idajs.json");
+
+    // Call Samples/install.js to set up the project
+    console.log("\nSetting up development environment...");
+    const installScript = path.join(__dirname, "install.js");
+    const installArgs = [installScript, targetDir];
+
+    if (!config.install) {
+      installArgs.push("--skip-install");
+    }
+
+    execSync(`node ${installArgs.map((arg) => `"${arg}"`).join(" ")}`, {
+      stdio: "inherit",
+    });
+
+    // Post-process package.json to remove setup script, author, and private properties
+    const finalPackageJsonPath = path.join(targetDir, "package.json");
+    const finalPackageJson = JSON.parse(fs.readFileSync(finalPackageJsonPath, "utf8"));
+
+    if (finalPackageJson.scripts && finalPackageJson.scripts.setup) {
+      delete finalPackageJson.scripts.setup;
+    }
+    if (finalPackageJson.author !== undefined) {
+      delete finalPackageJson.author;
+    }
+    if (finalPackageJson.private !== undefined) {
+      delete finalPackageJson.private;
+    }
+
+    // Remove TypeScript from devDependencies if it's a JavaScript project
+    if (
+      config.language === "js" &&
+      finalPackageJson.devDependencies &&
+      finalPackageJson.devDependencies.typescript
+    ) {
+      delete finalPackageJson.devDependencies.typescript;
+    }
+
+    fs.writeFileSync(finalPackageJsonPath, JSON.stringify(finalPackageJson, null, 2) + "\n");
+    console.log("✓ Configured package.json");
+
+    // Remove package.template.json as it's no longer needed
+    fs.unlinkSync(packageTemplatePath);
+    console.log("✓ Cleaned up template files");
+
+    // Success message
+    console.log(`\n✅ Successfully created "${config.projectName}"!\n`);
+    console.log("Next steps:");
+    console.log(`  cd ${path.relative(process.cwd(), targetDir) || config.targetDirectory}`);
+    if (!config.install) {
+      console.log("  npm install");
+    }
+    console.log("  npm start\n");
+    console.log("Happy modding! 🎮");
+  } catch (error) {
+    console.error(`\n❌ Error creating project: ${error.message}`);
+    process.exit(1);
+  }
+}
+
+main().catch((error) => {
+  console.error("Unexpected error:", error);
+  process.exit(1);
+});