Merge branch 'maintenance/Documentation_fixes'

Author: innerbytes

Ida/.env.example

@@ -1,11 +1,15 @@
 # Environment Variables example 
+# This file is used to generate and deploy the documentation site.
 # Copy this file to .env and fill in your actual values
 
+# Main repository URL, for example https://github.com/innerbytes/idajs
+MAIN_REPO_URL=
+
 # Documentation deployment repository URL. 
 # This repo has to be setup to automatically publish to the documentation site folder.
 # Example: ssh://user@example.com/path/to/repo.git
 DEPLOY_REPO_URL=
 
 # Documentation site host URL
-# Example: https://docs.example.com/
+# Example: https://ida.innerbytes.com/
 DOC_HOST_URL=

Ida/README.template.md

@@ -485,7 +485,7 @@ This way you can combine your custom life script logic with the original LBA 2 b
 **What are Move Scripts?**
 
 Move scripts are **coroutines** that execute animation and movement sequences over multiple frames.
-Unlike life scripts that run completely each frame, move scripts pause and resume their execution across many frames.
+Unlike life scripts that run completely each frame, move scripts continue their execution across many frames.
 
 **Key Characteristics:**
 
@@ -933,7 +933,7 @@ Your mod project contains a small set of folders and files:
 - `src/` — your mod code. Start with `src/index.js` (or `.ts` for TS template). This is the entry point loaded by {{{ida}}}.
 - `media/` — assets used by your mod. {{{ida}}} will convert media assets to LBA2 formats automatically.
   - `media/sprites/` — small PNGs used as dialog sprites and similar inline images.
-  - `media/images/` — full‑screen PNGs for dialogs/backgrounds. 
+  - `media/images/` — full‑screen PNGs (640x480) for dialogs/backgrounds. 
 - Root files — tooling and configuration; not part of gameplay logic:
   - `package.json` — metadata (name, description, author) and handy scripts.
   - `.idajs.json` — {{{ida}}} config (the path to {{{ida}}} project).

Ida/generate-readme.js

@@ -1,12 +1,21 @@
 #!/usr/bin/env node
 
+require("dotenv").config();
+
 const { execSync } = require("child_process");
 const fs = require("fs");
 const path = require("path");
 const os = require("os");
 
 // Configuration
-const GIT_URL = "https://github.com/innerbytes/idajs";
+const GIT_URL =
+  process.env.MAIN_REPO_URL ||
+  (() => {
+    console.warn(
+      "⚠️  Warning: MAIN_REPO_URL not set in .env file. Using default: https://example.com/repo"
+    );
+    return "https://example.com/repo";
+  })().replace(/\/$/, "");
 
 /**
  * Executes a shell command and returns the output

Ida/generate-typedoc-config.js

@@ -2,8 +2,11 @@ const fs = require("fs");
 const { execSync } = require("child_process");
 const path = require("path");
 
+require("dotenv").config();
+
 const TYPEDOC_CONFIG = "./typedoc.json";
 const FOOTER_FILE = "./typedoc-footer.html";
+const GIT_URL = (process.env.MAIN_REPO_URL || "").replace(/\/$/, "");
 
 // Check if typedoc-footer.html exists
 if (!fs.existsSync(FOOTER_FILE)) {
@@ -59,6 +62,7 @@ try {
 const footerContent = fs
   .readFileSync(FOOTER_FILE, "utf8")
   .trim()
+  .replace(/\$\(currentYear\)/g, new Date().getFullYear())
   .replace(/\n/g, "")
   .replace(/\s+/g, " ");
 
@@ -67,6 +71,9 @@ const typedocConfig = JSON.parse(fs.readFileSync(TYPEDOC_CONFIG, "utf8"));
 
 // Inject footer content
 typedocConfig.customFooterHtml = footerContent;
+if (GIT_URL) {
+  typedocConfig.sourceLinkTemplate = `${GIT_URL}/blob/{gitRevision}/{path}#L{line}`;
+}
 
 // Write updated config
 fs.writeFileSync(TYPEDOC_CONFIG, JSON.stringify(typedocConfig, null, 2) + "\n");

Ida/package.json

@@ -17,7 +17,7 @@
     "minor": "npm version minor --no-git-tag-version && git add package.json package-lock.json && node version-commit.js && node release.js",
     "major": "npm version major --no-git-tag-version && git add package.json package-lock.json && node version-commit.js && node release.js",
     "push": "git push --follow-tags",
-    "docs": "node generate-readme.js && npx typedoc && npx open-cli ./docs/index.html",
+    "docs": "node generate-readme.js && node generate-typedoc-config.js && npx typedoc && npx open-cli ./docs/index.html && rm README.md && node generate-typedoc-config.js --reset",
     "create": "node srcjs/create-mod/index.js",
     "publish:types": "node check-publish.js srcjs/types && node publish-package.js srcjs/types",
     "publish:types:dev": "node check-publish.js srcjs/types --dev-publish && node publish-package.js srcjs/types --dev",

Ida/typedoc.json

@@ -17,6 +17,7 @@
   "excludeInternal": false,
   "excludePrivate": false,
   "excludeProtected": false,
+  "customFooterHtmlDisableWrapper": true,
   "highlightLanguages": ["typescript", "javascript", "cpp", "bash", "json", "powershell", "cmd"],
   "navigationLinks": {
     "❤️ Support IdaJS ❤️": "https://innerbytes.com/#about",