@ludeo/cli 1.4.8 → 1.4.10

package/README.md

@@ -15,8 +15,16 @@ ludeo version
 
 ## Quick Start
 
+### Getting Your Game ID and Access Token
+Both your **Game ID** and **Access Token** are available in the [Studio Labs](https://studio.ludeo.com) under **Environments**.
+
+- **Access Token:** In Environments, click **Create Token**, name it, then copy and save the token (you won't be able to see it again).
+- **Game ID:** In Environments, it's shown at the top of the page next to the API key.
+
+> **Windows note:** All commands below work in Command Prompt, PowerShell, and terminal emulators. For multi-line commands, replace `\` with `^` in Command Prompt.
+
 ### 1. Authentication
-Get your access token from the Ludeo platform and save it:
+Save your access token:
 ```bash
 ludeo auth set-token --access-token YOUR_ACCESS_TOKEN
 ```
@@ -36,7 +44,7 @@ ludeo builds upload
 
 The interactive mode will guide you through:
 1. **Game ID** - Enter your game's unique identifier
-2. **Build Creation Type** - Choose between `new`, or `sdkFree`
+2. **Build Creation Type** - Choose between `new` or `sdkFree`
 3. **Build Type** - Select `major` or `minor` (with warning for major builds)
 4. **Major Version Selection** - If creating a minor build, select from existing major versions
 5. **Game Version** - Enter the version number (e.g., 1.2.3)
@@ -103,7 +111,6 @@ ludeo builds upload \
 - `minor`: Minor version build (requires major-build-id)
 
 **Additional Flags:**
-- `--runtime-environment`: Runtime environment (windows/proton) - only available for Ludeo admins
 - `--request-id`: Optional request ID for tracking
 - `--no-interactive`: Disable interactive prompts (for CI/CD or scripts)
 - `--dry-run`: Preview the upload without making any changes
@@ -201,6 +208,8 @@ The test suite includes:
 npm update -g @ludeo/cli
 ```
 
+**Windows (standalone exe):** download the latest release from the [GitHub releases](https://github.com/ludeo/cli/releases) page and replace your existing executable.
+
 ## CI/CD Integration
 
 ### GitHub Actions
@@ -235,10 +244,15 @@ npm rebuild @ludeo/cli
 sudo npm install -g @ludeo/cli
 ```
 
-**Windows issues:**
+**Windows (npm):**
 - Run PowerShell as Administrator
 - Ensure Node.js is properly installed
 
+**Windows (standalone exe):**
+- **"ludeo is not recognized"** — Add the folder containing `ludeo.exe` to your PATH.
+- **"Access denied" / "Permission denied"** — Right-click the executable → Properties → Unblock → OK, or run Command Prompt as Administrator.
+- **Antivirus blocking** — Add an exception for the executable in your antivirus software.
+
 ### Common Issues
 
 **Authentication errors:**
@@ -260,7 +274,5 @@ sudo npm install -g @ludeo/cli
 Need help? Here's how to get support:
 
 1. Check this README and troubleshooting section
-2. Run `npm rebuild @ludeo/cli` if you encounter issues
+2. **npm:** run `npm rebuild @ludeo/cli` if you encounter issues. **Windows (standalone):** ensure `ludeo.exe` is in your PATH and see the troubleshooting section above.
 3. Contact the Ludeo platform team for additional assistance
-
-For detailed documentation and advanced usage, visit the [Ludeo Developer Portal](https://developers.ludeo.com).

package/README.npm.md

@@ -15,8 +15,16 @@ ludeo version
 
 ## Quick Start
 
+### Getting Your Game ID and Access Token
+Both your **Game ID** and **Access Token** are available in the [Studio Labs](https://studio.ludeo.com) under **Environments**.
+
+- **Access Token:** In Environments, click **Create Token**, name it, then copy and save the token (you won't be able to see it again).
+- **Game ID:** In Environments, it's shown at the top of the page next to the API key.
+
+> **Windows note:** All commands below work in Command Prompt, PowerShell, and terminal emulators. For multi-line commands, replace `\` with `^` in Command Prompt.
+
 ### 1. Authentication
-Get your access token from the Ludeo platform and save it:
+Save your access token:
 ```bash
 ludeo auth set-token --access-token YOUR_ACCESS_TOKEN
 ```
@@ -36,7 +44,7 @@ ludeo builds upload
 
 The interactive mode will guide you through:
 1. **Game ID** - Enter your game's unique identifier
-2. **Build Creation Type** - Choose between `new`, or `sdkFree`
+2. **Build Creation Type** - Choose between `new` or `sdkFree`
 3. **Build Type** - Select `major` or `minor` (with warning for major builds)
 4. **Major Version Selection** - If creating a minor build, select from existing major versions
 5. **Game Version** - Enter the version number (e.g., 1.2.3)
@@ -103,7 +111,6 @@ ludeo builds upload \
 - `minor`: Minor version build (requires major-build-id)
 
 **Additional Flags:**
-- `--runtime-environment`: Runtime environment (windows/proton) - only available for Ludeo admins
 - `--request-id`: Optional request ID for tracking
 - `--no-interactive`: Disable interactive prompts (for CI/CD or scripts)
 - `--dry-run`: Preview the upload without making any changes
@@ -191,7 +198,7 @@ npm rebuild @ludeo/cli
 sudo npm install -g @ludeo/cli
 ```
 
-**Windows issues:**
+**Windows (npm):**
 - Run PowerShell as Administrator
 - Ensure Node.js is properly installed
 
@@ -218,5 +225,3 @@ Need help? Here's how to get support:
 1. Check this README and troubleshooting section
 2. Run `npm rebuild @ludeo/cli` if you encounter issues
 3. Contact the Ludeo platform team for additional assistance
-
-For detailed documentation and advanced usage, visit the [Ludeo Developer Portal](https://developers.ludeo.com).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ludeo/cli",
-  "version": "1.4.8",
+  "version": "1.4.10",
   "description": "Ludeo CLI - Upload game builds and manage content on the Ludeo platform",
   "main": "index.js",
   "bin": {
@@ -9,7 +9,7 @@
   "scripts": {
     "build": "make build-all",
     "postinstall": "node scripts/postinstall.js",
-    "prepublishOnly": "npm run build",
+    "prepublishOnly": "make npm-build",
     "release": "node scripts/release.js",
     "release:patch": "node scripts/release.js patch",
     "release:minor": "node scripts/release.js minor",

package/scripts/build-readme.js

@@ -1,8 +1,20 @@
 #!/usr/bin/env node
 /**
- * Build README variants from docs/readme/*.md fragments.
- * - README.md = full (repo, includes Testing) — for GitHub
- * - README.npm.md = usage only (no Testing) — for NPM package page
+ * Build README variants from docs/README.template.md.
+ *
+ * Outputs:
+ *   README.md                          — GitHub repo (includes Testing)
+ *   README.npm.md                      — npm package page (no Testing, no standalone exe refs)
+ *   windows-releases/template/README.md — Windows ZIP release (exe install, file info)
+ *
+ * Conditional markers in the template:
+ *   <!-- #if VARIANT -->   Include block only for that variant
+ *   <!-- #if !VARIANT -->  Include block for all variants EXCEPT that one
+ *   <!-- #else -->         Opposite of preceding #if
+ *   <!-- #endif -->        End conditional block
+ *
+ * Supported variant names: repo, npm, windows
+ * Template variable: {{VERSION}} (replaced from package.json)
  *
  * Run: node scripts/build-readme.js
  */
@@ -11,44 +23,90 @@ const fs = require('fs');
 const path = require('path');
 
 const ROOT = path.resolve(__dirname, '..');
-const README_DIR = path.join(ROOT, 'docs', 'readme');
-
-const FRAGMENTS_ORDER = [
-  '01-title-intro.md',
-  '02-installation.md',
-  '03-quick-start.md',
-  '04-features.md',
-  '05-testing.md',
-  '06-updating.md',
-  '07-cicd.md',
-  '08-troubleshooting.md',
-  '09-support.md',
-];
-
-const NPM_EXCLUDE = new Set(['05-testing.md']);
-
-function buildVariant(excludeSet) {
-  const parts = [];
-  for (const name of FRAGMENTS_ORDER) {
-    if (excludeSet && excludeSet.has(name)) continue;
-    const file = path.join(README_DIR, name);
-    if (!fs.existsSync(file)) {
-      console.warn(`Warning: fragment missing: ${name}`);
+const TEMPLATE = path.join(ROOT, 'docs', 'README.template.md');
+
+const VARIANTS = {
+  repo: { flags: { repo: true, npm: false, windows: false } },
+  npm: { flags: { repo: false, npm: true, windows: false } },
+  windows: { flags: { repo: false, npm: false, windows: true } },
+};
+
+function processTemplate(template, flags, vars) {
+  const lines = template.split('\n');
+  const output = [];
+  const stack = []; // { include: boolean, hadElse: boolean }
+
+  for (const line of lines) {
+    const trimmed = line.trim();
+
+    const ifMatch = trimmed.match(/^<!--\s*#if\s+(!?)(\w+)\s*-->$/);
+    if (ifMatch) {
+      const negated = ifMatch[1] === '!';
+      const flag = ifMatch[2];
+      const value = !!flags[flag];
+      const include = negated ? !value : value;
+      const parentInclude = stack.length === 0 || stack[stack.length - 1].include;
+      stack.push({ include: parentInclude && include, hadElse: false });
+      continue;
+    }
+
+    if (trimmed === '<!-- #else -->') {
+      if (stack.length > 0) {
+        const top = stack[stack.length - 1];
+        const parentInclude = stack.length <= 1 || stack[stack.length - 2].include;
+        top.include = parentInclude && !top.include;
+        top.hadElse = true;
+      }
+      continue;
+    }
+
+    if (trimmed === '<!-- #endif -->') {
+      stack.pop();
       continue;
     }
-    parts.push(fs.readFileSync(file, 'utf8').trim());
+
+    const shouldInclude = stack.length === 0 || stack[stack.length - 1].include;
+    if (shouldInclude) {
+      output.push(line);
+    }
+  }
+
+  let result = output.join('\n');
+
+  for (const [key, value] of Object.entries(vars)) {
+    result = result.replace(new RegExp(`\\{\\{${key}\\}\\}`, 'g'), value);
   }
-  return parts.join('\n\n');
+
+  // Collapse 3+ consecutive blank lines into 2
+  result = result.replace(/\n{3,}/g, '\n\n');
+
+  return result.trim() + '\n';
 }
 
 function main() {
-  const repoReadme = buildVariant(null);
-  const npmReadme = buildVariant(NPM_EXCLUDE);
+  const template = fs.readFileSync(TEMPLATE, 'utf8');
+  const version = require(path.join(ROOT, 'package.json')).version;
+  const vars = { VERSION: `v${version}` };
+
+  // Build each variant
+  for (const [name, config] of Object.entries(VARIANTS)) {
+    const content = processTemplate(template, config.flags, vars);
 
-  fs.writeFileSync(path.join(ROOT, 'README.md'), repoReadme + '\n', 'utf8');
-  fs.writeFileSync(path.join(ROOT, 'README.npm.md'), npmReadme + '\n', 'utf8');
+    let outputPath;
+    if (name === 'repo') {
+      outputPath = path.join(ROOT, 'README.md');
+    } else if (name === 'npm') {
+      outputPath = path.join(ROOT, 'README.npm.md');
+    } else if (name === 'windows') {
+      const dir = path.join(ROOT, 'windows-releases', 'template');
+      fs.mkdirSync(dir, { recursive: true });
+      outputPath = path.join(dir, 'README.md');
+    }
+
+    fs.writeFileSync(outputPath, content, 'utf8');
+  }
 
-  console.log('Built README.md (repo, full) and README.npm.md (npm, usage only)');
+  console.log('Built README.md (repo), README.npm.md (npm), windows-releases/template/README.md (windows)');
 }
 
 main();

package/scripts/postinstall.js

@@ -2,60 +2,36 @@ const fs = require('fs');
 const path = require('path');
 const os = require('os');
 
-// Copy the appropriate binary to dist/ directory
 function postinstall() {
   const platform = os.platform();
   const arch = os.arch();
-  
-  // Map Node.js arch to Go arch
-  const archMap = {
-    'x64': 'amd64',
-    'arm64': 'arm64'
-  };
-  
+
+  const archMap = { 'x64': 'amd64', 'arm64': 'arm64' };
+  const platformMap = { 'win32': 'windows', 'darwin': 'darwin', 'linux': 'linux' };
+
   const goArch = archMap[arch] || arch;
-  
-  // Map platform names
-  const platformMap = {
-    'win32': 'windows',
-    'darwin': 'darwin',
-    'linux': 'linux'
-  };
-  
   const goPlatform = platformMap[platform] || platform;
-  
-  // Construct binary names
-  const sourceBinaryName = platform === 'win32' 
+
+  const binaryName = platform === 'win32'
     ? `ludeo-${goPlatform}-${goArch}.exe`
     : `ludeo-${goPlatform}-${goArch}`;
-  
-  const targetBinaryName = platform === 'win32' ? 'ludeo.exe' : 'ludeo';
-  
-  const sourcePath = path.join(__dirname, '..', 'build', sourceBinaryName);
-  const distDir = path.join(__dirname, '..', 'dist');
-  const targetPath = path.join(distDir, targetBinaryName);
-  
-  // Create dist directory if it doesn't exist
-  if (!fs.existsSync(distDir)) {
-    fs.mkdirSync(distDir, { recursive: true });
-  }
-  
-  // Copy the binary
-  if (fs.existsSync(sourcePath)) {
-    fs.copyFileSync(sourcePath, targetPath);
-    
-    // Make executable on Unix systems
+
+  const distPath = path.join(__dirname, '..', 'dist', binaryName);
+
+  if (fs.existsSync(distPath)) {
     if (platform !== 'win32') {
-      fs.chmodSync(targetPath, '755');
+      fs.chmodSync(distPath, '755');
     }
-    
-    console.log(`✅ Ludeo CLI binary installed: ${targetPath}`);
-  } else {
-    console.warn(`⚠️  Warning: Binary not found at ${sourcePath}`);
-    console.warn('This might happen during development. Run "npm run build" first.');
+    return;
+  }
+
+  // Only warn in development (when installing from source with build/ directory)
+  const buildPath = path.join(__dirname, '..', 'build', binaryName);
+  if (!fs.existsSync(buildPath)) {
+    console.warn(`⚠️  Ludeo CLI: binary not found for ${platform}-${arch}.`);
+    console.warn('Try running: npm rebuild @ludeo/cli');
   }
 }
 
-// Run postinstall
 postinstall();
 

package/scripts/release.js

@@ -84,8 +84,6 @@ function createWindowsRelease(version) {
 function updateWindowsDocumentation(version, releaseDir) {
   const files = [
     'README.md',
-    'INSTALL.txt', 
-    'install.bat',
     'PACKAGE_CONTENTS.txt'
   ];
   
@@ -127,21 +125,6 @@ function getBasicFileContent(filename, version) {
 ## Support
 - Email: support@ludeo.com
 - Documentation: https://docs.ludeo.com/cli
-`;
-    case 'INSTALL.txt':
-      return `LUDEO CLI v${version} - WINDOWS INSTALLATION
-
-1. Choose the right executable:
-   - ludeo-windows-amd64.exe (Intel/AMD)
-   - ludeo-windows-arm64.exe (ARM)
-
-2. Rename to "ludeo.exe"
-
-3. Add to PATH:
-   - Copy to C:\\ludeo-cli\\
-   - Add C:\\ludeo-cli\\ to PATH
-
-4. Test: ludeo --version
 `;
     default:
       return `# Ludeo CLI v${version} - ${filename}`;