bf6mods

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.

npx @bf6mods/cli init

Import from JSON

Already have a project? Just export your currently existing project in portal.battlefield.com, by editing your mod, clicking the three dots on the top right, click export. Finally just run...

npx @bf6mods/cli import <export file> <output directory>

Deploying Project to Portal

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, 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 will not update showing the changes from the deployed code. This is due to the browsers cache.

Features

• Use multiple different files, instead of just one large TypeScript file!
• Use a programatic interface for defining your gamemode.
• Extensive documentation
• Extended standard library (still in progress)
• Hot reload
• Automatic string injection
• 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.

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!

You can join the discord by clicking this link!