nw-builder

nw-builder

Build NW.js applications for Mac, Windows and Linux.

For version 3, please go to the corresponding branch.

Major Features

• Get, run or build applications.
• Integrate FFmpeg community builds
• Configure executable fields and icons
• Downloading from mirrors
• Node Native Addon support

Check out the documentation if you wish to give nw-builder a try.

Please note that the documentation assumes you know how to write NW.js applications.

Installation

With npm:

npm install nw-builder -D

With yarn:

yarn add nw-builder -D

With pnpm:

pnpm add nw-builder -D

Usage

Here is two way to use nw-build to build your nwjs applications

CLI

1. To get nwjs cache

   nwbuild --mode=get
   

2. To run nwjs application

   nwbuild --mode=run
   

3. To build nwjs application

   nwbuild --mode=build
   

JavaScript API

1. Define an npm script

   {
     "scripts": {
       "build": "node scripts/build.js"
     }
   }
   

2. Create a build script

   // scripts/build.js
   const { nwbuild } = require("nw-builder");
   await nwbuild({
     srcDir: "./nwapp/**/* ./other/**/*.js",
     mode: "build",
     version: "latest",
     flavor: "normal",
     platform: "linux",
     arch: "x64",
     outDir: "./build",
     cache: false,
     app: { ... },
   });
   

3. Run the script

   npm run build
   

Alternatives

• nw-builder-platforms - Fork of this repo with platform specific build options
• nwjs-builder-phoenix - Previously the most used build tool, however it is no longer maintained

Changelog

[4.5.3] - 2023-12-20

Changed

• Wrap unzipper call inside Promise to prevent race condition.