@bf6mods/cli 1.6.0 → 1.7.0

package/README.md

@@ -4,7 +4,7 @@ Create Battlefield 6 mods quickly with a vite like development experience.
 
 ## Getting Started
 
-To create a new project, simply run the following command and answer the questions, ensure that you are using Node v22 and above.
+To create a new project, simply run the following command and answer the questions, ensure that you are using Node v22 and above, and if on Linux install `libsecret-1-0`.
 
 ```
 npx @bf6mods/cli init
@@ -20,20 +20,9 @@ Already have a project? Just export your currently existing project in [portal.b
 npx @bf6mods/cli import <export file> <output directory>
 ```
 
-## Deploying Project to Portal
+## Full Documentation
 
-There are two different ways of deploying a project to portal.
-
-### Manually Import
-
-Just run `npm run build` in your project dir, open [portal.battlefield.com](https://portal.battlefield.com), click import, and select the `dist/mod.json` file.
-
-### `npx @bf6mods/cli deploy`
-
-To use this, you must first install puppeteer via `npm -g i puppeteer`, but after doing so you can just run this command, and you will
-have your project deploy automatically for you.
-
-Important note on this. The [portal.battlefield.com](https://portal.battlefield.com) will not update showing the changes from the deployed code. This is due to the browsers cache.
+The full documentation can be found [here](https://bf6mods.github.io/bf6mods/guide/getting-started.html)!
 
 ## Features
 
@@ -43,47 +32,16 @@ Important note on this. The [portal.battlefield.com](https://portal.battlefield.
 - Extended standard library (still in progress)
 - Hot reload
 - Automatic string injection
+- **Automatic thumbnail resizing** - Add any image to your project and it will be automatically resized and optimized to meet BF6 Portal requirements (352x248, max 78KB)
 - Logging from BF6! (Only when in hosting locally)
 
-## Structure
-
-`bf6mods` is very configurable, but the following structure is what can be expected from any mod.
-
-```
-my-mod/
-├─ src/
-│  ├─ index.ts
-│  ├─ scenes/
-│  │  └─ MyMap.spatial.json
-├─ bf6.config.ts
-├─ package.json
-└─ dist/
-   └─ mod.json
-```
-
-## `bf6.config.ts`
-
-Here is a short example of a `bf6.config.ts`.
-
-```ts
-export default defineBf6Config({
-	name: "AcePursuit",
-	description: "A fast-paced race mod",
-	outDir: "dist",
-	entrypoint: "src/index.ts",
-	scenes: [[MapId.LiberationPeak, "src/scenes/AcePursuit.spatial.json"]],
-	game: {
-		mutators: {
-			// ...
-		},
-	},
-});
-````
-
 ## @bf6mods/sdk
 
 This is a seperate library that exports the `PortalSdk`'s `mod` and `modlib`. Additionally it exports some stdlib helper functions and classes to help accelerate development.
 
-## Join the discord with fellow modders!
+## Links
 
-You can join the discord by clicking this [link](https://discord.gg/2gJ9fheYYK)!
+- [Documentation](https://bf6mods.github.io/bf6mods/)
+- [Contributing Guide](https://bf6mods.github.io/bf6mods/contributing/how-to-contribute.html)
+- [Discord](https://discord.gg/2gJ9fheYYK)
+- [Portal](https://portal.battlefield.com/bf6/en-gb/)

package/dist/cli/index.js

@@ -8,6 +8,7 @@ import { AttachmentType } from "@bf6mods/sdk";
 import { createJiti } from "jiti";
 import { rolldown } from "rolldown";
 import stripAnsi from "strip-ansi";
+import sharp from "sharp";
 import { Clients, Generated_pb } from "@bf6mods/portal";
 import os from "node:os";
 import keytar from "keytar";
@@ -19,7 +20,7 @@ import * as prompts from "@clack/prompts";
 import { genExport, genInlineTypeImport } from "knitwork";
 
 //#region package.json
-var version$1 = "1.6.0";
+var version$1 = "1.7.0";
 var description = "CLI and library for bundling BF6 mods";
 var bin = { "bf6mods": "./dist/cli/index.js" };
 
@@ -68,6 +69,49 @@ const readableList = (initialValues) => {
 	return values[0];
 };
 
+//#endregion
+//#region src/cli/build/any-params.ts
+function addAnyToParams() {
+	return {
+		name: "add-any-to-params",
+		generateBundle(_options, bundle) {
+			for (const [_file, output] of Object.entries(bundle)) {
+				if (output.type !== "chunk") continue;
+				const program$1 = this.parse(output.code, {
+					lang: "js",
+					astType: "js",
+					range: true
+				});
+				const edits = [];
+				function walk(node) {
+					if (!node || typeof node !== "object") return;
+					if (node.type === "FunctionDeclaration" || node.type === "FunctionExpression" || node.type === "ArrowFunctionExpression") for (const param of node.params) {
+						if (param.type === "Identifier" && param.range) edits.push({
+							pos: param.range[1],
+							insert: ": any"
+						});
+						if (param.type === "AssignmentPattern" && param.left?.type === "Identifier" && param.left.range) edits.push({
+							pos: param.left.range[1],
+							insert: ": any"
+						});
+						if (param.type === "RestElement" && param.argument?.type === "Identifier" && param.argument.range) edits.push({
+							pos: param.argument.range[1],
+							insert: ": any"
+						});
+					}
+					for (const val of Object.values(node)) if (Array.isArray(val)) val.forEach(walk);
+					else if (val && typeof val === "object" && "type" in val) walk(val);
+				}
+				for (const item of program$1.body) walk(item);
+				edits.sort((a, b) => b.pos - a.pos);
+				let result = output.code;
+				for (const edit of edits) result = result.slice(0, edit.pos) + edit.insert + result.slice(edit.pos);
+				output.code = result;
+			}
+		}
+	};
+}
+
 //#endregion
 //#region src/cli/build/generated-strings.ts
 function extractBf6Strings(bf6Strings, generateFromLiterals) {
@@ -166,6 +210,131 @@ function extractBf6Strings(bf6Strings, generateFromLiterals) {
 	};
 }
 
+//#endregion
+//#region src/cli/build/thumbnail.ts
+/**
+* BF6 Portal thumbnail requirements:
+* - Max file size: 78KB
+* - Dimensions: 352x248 pixels
+* - Format: JPEG or PNG
+*/
+const THUMBNAIL_REQUIREMENTS = {
+	maxSizeBytes: 78 * 1024,
+	width: 352,
+	height: 248,
+	supportedFormats: [
+		".jpg",
+		".jpeg",
+		".png"
+	]
+};
+/**
+* Validates that an image buffer meets BF6 Portal requirements
+*/
+function validateThumbnail(buffer, filename) {
+	const errors = [];
+	if (buffer.length > THUMBNAIL_REQUIREMENTS.maxSizeBytes) errors.push(`File size is ${(buffer.length / 1024).toFixed(2)}KB, must be less than 78KB`);
+	const ext = path.extname(filename).toLowerCase();
+	if (!THUMBNAIL_REQUIREMENTS.supportedFormats.includes(ext)) errors.push(`File format ${ext} is not supported. Must be ${THUMBNAIL_REQUIREMENTS.supportedFormats.join(" or ")}`);
+	const dimensions = getImageDimensions(buffer, ext);
+	if (dimensions) {
+		if (dimensions.width !== THUMBNAIL_REQUIREMENTS.width || dimensions.height !== THUMBNAIL_REQUIREMENTS.height) errors.push(`Image dimensions are ${dimensions.width}x${dimensions.height}, must be ${THUMBNAIL_REQUIREMENTS.width}x${THUMBNAIL_REQUIREMENTS.height}`);
+	}
+	return {
+		valid: errors.length === 0,
+		errors
+	};
+}
+/**
+* Gets image dimensions from buffer by reading image headers
+*/
+function getImageDimensions(buffer, ext) {
+	try {
+		if (ext === ".png") {
+			if (buffer.length >= 24 && buffer.toString("ascii", 1, 4) === "PNG") return {
+				width: buffer.readUInt32BE(16),
+				height: buffer.readUInt32BE(20)
+			};
+		} else if (ext === ".jpg" || ext === ".jpeg") {
+			let offset = 2;
+			while (offset < buffer.length) {
+				if (buffer[offset] !== 255) break;
+				const marker = buffer[offset + 1];
+				offset += 2;
+				if (marker >= 192 && marker <= 207 && marker !== 196 && marker !== 200 && marker !== 204) {
+					const height = buffer.readUInt16BE(offset + 3);
+					return {
+						width: buffer.readUInt16BE(offset + 5),
+						height
+					};
+				}
+				const segmentLength = buffer.readUInt16BE(offset);
+				offset += segmentLength;
+			}
+		}
+	} catch (_error) {}
+	return null;
+}
+/**
+* Processes a thumbnail file for BF6 Portal
+* Saves the resized thumbnail to the output directory
+*/
+async function processThumbnail(thumbnailPath, workingDir, outDir) {
+	const fullPath = path.resolve(workingDir, thumbnailPath);
+	if (!fs.existsSync(fullPath)) {
+		printToConsole(colors.yellow(`⚠️  Thumbnail file not found: ${thumbnailPath}`));
+		return false;
+	}
+	let buffer = await fs.promises.readFile(fullPath);
+	const filename = path.basename(fullPath);
+	const ext = path.extname(fullPath);
+	if (!validateThumbnail(buffer, filename).valid) {
+		printToConsole(colors.yellow(`⚠️  Thumbnail doesn't meet requirements, attempting to resize and optimize...`));
+		try {
+			buffer = Buffer.from(await resizeThumbnail(buffer, fullPath));
+			printToConsole(colors.green(`✓ Thumbnail resized and optimized: ${filename} (${(buffer.length / 1024).toFixed(2)}KB)`));
+		} catch (error) {
+			printToConsole(colors.red(`✗ Failed to resize thumbnail: ${error instanceof Error ? error.message : "Unknown error"}`));
+			printToConsole(colors.yellow(`\nThumbnail requirements:\n  - Size: max 78KB\n  - Dimensions: 352x248 pixels\n  - Format: JPEG or PNG`));
+			return false;
+		}
+	} else printToConsole(`${colors.green.bold("✓")} Thumbnail validated: ${filename} (${(buffer.length / 1024).toFixed(2)}KB)`);
+	const outputPath = path.resolve(outDir, `thumbnail${ext}`);
+	await fs.promises.writeFile(outputPath, buffer);
+	printToConsole(colors.green(`✓ Thumbnail saved to: ${path.relative(workingDir, outputPath)}`));
+	return true;
+}
+/**
+* Resizes and optimizes an image to meet BF6 Portal thumbnail requirements
+*/
+async function resizeThumbnail(buffer, originalPath) {
+	const ext = path.extname(originalPath).toLowerCase();
+	const isJpeg = ext === ".jpg" || ext === ".jpeg";
+	let result = await sharp(buffer).resize(THUMBNAIL_REQUIREMENTS.width, THUMBNAIL_REQUIREMENTS.height, {
+		fit: "cover",
+		position: "center"
+	}).toBuffer();
+	if (isJpeg || result.length > THUMBNAIL_REQUIREMENTS.maxSizeBytes) for (let quality = 90; quality >= 60; quality -= 10) {
+		result = await sharp(buffer).resize(THUMBNAIL_REQUIREMENTS.width, THUMBNAIL_REQUIREMENTS.height, {
+			fit: "cover",
+			position: "center"
+		}).jpeg({
+			quality,
+			progressive: true
+		}).toBuffer();
+		if (result.length <= THUMBNAIL_REQUIREMENTS.maxSizeBytes) break;
+	}
+	else result = await sharp(buffer).resize(THUMBNAIL_REQUIREMENTS.width, THUMBNAIL_REQUIREMENTS.height, {
+		fit: "cover",
+		position: "center"
+	}).png({
+		compressionLevel: 9,
+		quality: 90
+	}).toBuffer();
+	if (result.length > THUMBNAIL_REQUIREMENTS.maxSizeBytes) throw new Error(`Unable to compress image below 78KB (current: ${(result.length / 1024).toFixed(2)}KB). Try using a simpler image or pre-compressing it.`);
+	return result;
+}
+
 //#endregion
 //#region src/cli/build/index.ts
 /**
@@ -204,6 +373,7 @@ async function build() {
 		tsAttachment = createTsAttachment(entryAbs, await buildEntrypoint(entryAbs, generatedStrings, config.generateStrings ?? true));
 	}
 	const { attachments, mapRotation } = await collectAttachments(config, workingDir, tsAttachment, generatedStrings);
+	if (config.thumbnail) await processThumbnail(config.thumbnail, workingDir, outDir);
 	await writeModJson(config, outDir, attachments, mapRotation, minifyJson);
 	printToConsole(`${colors.green.bold("✓")} Built mod: ${config.name}`);
 }
@@ -213,7 +383,7 @@ async function build() {
 async function buildEntrypoint(entry, bf6Strings, generateStringsFromLiterals) {
 	return (await (await rolldown({
 		input: entry,
-		plugins: [extractBf6Strings(bf6Strings, generateStringsFromLiterals)],
+		plugins: [extractBf6Strings(bf6Strings, generateStringsFromLiterals), addAnyToParams()],
 		logLevel: "debug",
 		resolve: { alias: { modlib: "@bf6mods/sdk" } }
 	})).generate({
@@ -291,7 +461,7 @@ function createTsAttachment(filePath, compiled) {
 	return {
 		id: crypto.randomUUID(),
 		version: "1.0",
-		filename: `${path.parse(filePath).name}.js`,
+		filename: `${path.parse(filePath).name}.ts`,
 		isProcessable: true,
 		processingStatus: 2,
 		attachmentType: AttachmentType.TypeScript,
@@ -347,7 +517,7 @@ function toBase64(input) {
 async function getSessionIdFromCookies() {
 	let puppeteer;
 	try {
-		puppeteer = await import("../puppeteer-u5zMrFnK.js");
+		puppeteer = await import("../puppeteer-BzRJX4NM.js");
 	} catch (_error) {
 		printToConsole(`${colors.red.bold("✗")} Puppeteer could not be loaded.`);
 		console.error("It looks like Puppeteer is not installed in this environment.");
@@ -371,7 +541,7 @@ async function getSessionIdFromCookies() {
 		return document.cookie.includes("bf6sessionId");
 	}, { timeout: 0 });
 	console.log(`${colors.green.bold("✓")} Login detected!`);
-	const cookies = await page.cookies();
+	const cookies = await browser.cookies();
 	await browser.close();
 	return cookies.find((cookie) => cookie.name === "bf6sessionId")?.value;
 }
@@ -413,15 +583,14 @@ async function authenticate(sessionIdParam) {
 	printToConsole(`${colors.red("✗")} Authentication failed. Session may have expired immediately.`, true);
 	return false;
 }
-async function alwaysAuthenticatedRequest(method, request, sessionId, options) {
-	const fn = clients.play[method];
+async function alwaysAuthenticatedRequest(method, sessionId) {
 	try {
-		return await fn(request, options);
+		return await method();
 	} catch (error) {
 		if (error instanceof Error && error.message === "[unauthenticated]") {
 			printToConsole("🔄 Session expired. Re-authenticating…");
 			if (!await authenticate(sessionId)) throw error;
-			return await fn(request, options);
+			return await method();
 		}
 		throw error;
 	}
@@ -431,30 +600,28 @@ async function alwaysAuthenticatedRequest(method, request, sessionId, options) {
 //#region src/cli/deploy/index.ts
 const clients = new Clients();
 async function deploy({ input, sessionIdParam, modId }) {
-	printToConsole("To be implemented in a future release");
-	process.exit(0);
 	const rootDir = path.resolve(".");
 	if (!input) input = path.resolve(rootDir, "dist", "mod.json");
 	printToConsole(`🚀 Starting deploy for ${colors.cyan(input)}…`);
 	if (!fs.existsSync(input)) return printToConsole(`${colors.red.bold("✗")} File ${colors.cyan(input)} does not exist!`, true);
 	const mod = JSON.parse(fs.readFileSync(input, { encoding: "utf-8" }));
-	const blueprints = await alwaysAuthenticatedRequest("getScheduledBlueprints", {}, sessionIdParam);
+	const blueprints = await alwaysAuthenticatedRequest(() => clients.play.getScheduledBlueprints({}), sessionIdParam);
 	console.log("blueprints", blueprints.blueprintIds);
-	await alwaysAuthenticatedRequest("getBlueprintsById", { blueprintIds: blueprints.blueprintIds }, sessionIdParam);
+	await alwaysAuthenticatedRequest(() => clients.play.getBlueprintsById({ blueprintIds: blueprints.blueprintIds }), sessionIdParam);
 	const config = await getBf6Config(rootDir);
 	let id = modId;
 	if (!config) printToConsole(`Cannot find bf6mods config in dir ${rootDir}, proceeding without it.`);
 	else if (config?.id) id = config.id;
 	else printToConsole(`No id specified in bf6.config.ts! Defaulting to experience with same name!`);
 	if (!id) {
-		const owned = await alwaysAuthenticatedRequest("getOwnedPlayElementsV2", {
+		const owned = await alwaysAuthenticatedRequest(() => clients.play.getOwnedPlayElementsV2({
 			includeDenied: true,
 			publishStates: [
 				Generated_pb.PublishStateType.Draft,
 				Generated_pb.PublishStateType.Published,
 				Generated_pb.PublishStateType.Error
 			]
-		}, sessionIdParam);
+		}), sessionIdParam);
 		console.log("owned:", owned.playElements.map((owned$1) => owned$1.playElement));
 		const found = owned.playElements.find((element) => element?.playElement?.name === mod.name);
 		if (found?.playElement?.id) id = found.playElement.id;
@@ -463,13 +630,43 @@ async function deploy({ input, sessionIdParam, modId }) {
 		printToConsole(`${colors.red.bold("✗")} Cannot find an id for your mod to deploy with! Please specify the id explicitly with \`--id\` or by having a mod with the same name!`);
 		process.exit(0);
 	}
-	const playElementResponse = await alwaysAuthenticatedRequest("getPlayElement", {
+	const playElementResponse = await alwaysAuthenticatedRequest(() => clients.play.getPlayElement({
 		id,
 		includeDenied: true
-	}, sessionIdParam);
+	}), sessionIdParam);
 	if (!playElementResponse.playElement || !playElementResponse.playElementDesign || !playElementResponse.progressionMode) throw new Error("Cannot find essential attribute in mod, please report to GitHub!");
 	if (!mod.mapRotation) throw new Error("You must specify at least one map!");
 	console.log("playElementResponse:", playElementResponse);
+	const thumbnailExtensions = [
+		".jpg",
+		".jpeg",
+		".png"
+	];
+	let thumbnailPath;
+	let thumbnailExt;
+	for (const ext of thumbnailExtensions) {
+		const testPath = path.resolve(rootDir, "dist", `thumbnail${ext}`);
+		if (fs.existsSync(testPath)) {
+			thumbnailPath = testPath;
+			thumbnailExt = ext;
+			break;
+		}
+	}
+	if (thumbnailPath && thumbnailExt) try {
+		printToConsole(colors.blue("📸 Uploading thumbnail..."));
+		const thumbnailBuffer = await fs.promises.readFile(thumbnailPath);
+		const mimeType = thumbnailExt === ".png" ? "image/png" : "image/jpeg";
+		const uploadResponse = await alwaysAuthenticatedRequest(() => clients.play.uploadExperienceThumbnail({
+			image: thumbnailBuffer,
+			mimeType
+		}), sessionIdParam);
+		printToConsole(colors.green(`✓ Thumbnail uploaded successfully: ${uploadResponse.assetId}`));
+		printToConsole(colors.dim(`  URL: ${uploadResponse.url}`));
+	} catch (error) {
+		printToConsole(colors.yellow(`⚠ Failed to upload thumbnail: ${error instanceof Error ? error.message : "Unknown error"}`));
+		printToConsole(colors.dim("  Continuing deployment without thumbnail"));
+	}
+	else printToConsole(colors.dim("  No thumbnail found in dist folder, skipping upload"));
 }
 
 //#endregion
@@ -628,7 +825,7 @@ async function dev() {
 
 //#endregion
 //#region ../sdk/package.json
-var version = "1.6.0";
+var version = "1.7.0";
 
 //#endregion
 //#region src/cli/init.ts
@@ -665,14 +862,12 @@ const templates = [
 	"Basic",
 	"Complete",
 	"AcePursuit",
-	"BombSquad",
 	"Exfil",
 	"Vertigo"
 ];
 async function startProject(destination, template, name) {
 	if ([
 		"AcePursuit",
-		"BombSquad",
 		"Exfil",
 		"Vertigo"
 	].includes(template)) await importFile(path.resolve(templatesDir, `${template}.json`), destination, name);