@bf6mods/cli 1.6.0 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -51
- package/dist/cli/index.js +215 -20
- package/dist/cli/index.js.map +1 -1
- package/dist/{puppeteer-u5zMrFnK.js → puppeteer-BzRJX4NM.js} +72 -48
- package/dist/puppeteer-BzRJX4NM.js.map +1 -0
- package/dist/resources/prepare/types/config.ts +17 -0
- package/dist/resources/templates/All/README.md +22 -0
- package/dist/resources/templates/All/placeholder.jpg +0 -0
- package/dist/resources/templates/Basic/bf6.config.ts +1 -0
- package/dist/resources/templates/Complete/bf6.config.ts +1 -0
- package/package.json +2 -1
- package/dist/puppeteer-u5zMrFnK.js.map +0 -1
- package/dist/resources/templates/BombSquad.json +0 -1
|
@@ -92,6 +92,23 @@ export type Bf6Config = {
|
|
|
92
92
|
*/
|
|
93
93
|
generateStrings?: boolean;
|
|
94
94
|
|
|
95
|
+
/**
|
|
96
|
+
* Path to a thumbnail image for the mod.
|
|
97
|
+
*
|
|
98
|
+
* The image must meet BF6 Portal requirements:
|
|
99
|
+
* - Max file size: 78KB
|
|
100
|
+
* - Dimensions: 352x248 pixels
|
|
101
|
+
* - Format: JPEG or PNG
|
|
102
|
+
*
|
|
103
|
+
* @example
|
|
104
|
+
* ```ts
|
|
105
|
+
* thumbnail: "assets/thumbnail.png"
|
|
106
|
+
* // or
|
|
107
|
+
* thumbnail: "thumbnail.jpg"
|
|
108
|
+
* ```
|
|
109
|
+
*/
|
|
110
|
+
thumbnail?: string;
|
|
111
|
+
|
|
95
112
|
/**
|
|
96
113
|
* Controls whether build output should be minified.
|
|
97
114
|
*
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Bf6mods
|
|
2
|
+
|
|
3
|
+
[Bf6mods](https://github.com/bf6mods/bf6mods) makes modding for bf6 much easier! To get started, read our [docs](https://bf6mods.github.io/bf6mods).
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Run `npm install` in this directory.
|
|
8
|
+
|
|
9
|
+
## Deploying Project to Portal
|
|
10
|
+
|
|
11
|
+
There are two different ways of deploying a project to portal.
|
|
12
|
+
|
|
13
|
+
### Manually Import
|
|
14
|
+
|
|
15
|
+
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.
|
|
16
|
+
|
|
17
|
+
### `npx @bf6mods/cli deploy`
|
|
18
|
+
|
|
19
|
+
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
|
|
20
|
+
have your project deploy automatically for you.
|
|
21
|
+
|
|
22
|
+
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.
|
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bf6mods/cli",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.7.0",
|
|
4
4
|
"description": "CLI and library for bundling BF6 mods",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -38,6 +38,7 @@
|
|
|
38
38
|
"keytar": "^7.9.0",
|
|
39
39
|
"knitwork": "^1.2.0",
|
|
40
40
|
"rolldown": "^1.0.0-beta.44",
|
|
41
|
+
"sharp": "^0.34.5",
|
|
41
42
|
"stringify-object": "^6.0.0",
|
|
42
43
|
"strip-ansi": "^7.1.2"
|
|
43
44
|
},
|