nwutils / nwjs-shell-builder

NW.js (node-webkit) shell script builder and packager scripts

This repository is in maintainance mode. Bug fixes will be provided on a best effort basis. If you use this project, please consider contributing back.

nwjs application shell builder and packager

What's in here:

• Builder script
  • How it works
  • How we use it
  • Usage
  • Options
  • Examples
    • The bare minimum to build
    • Clean working dir
    • Build for all targets
    • Build only for windows 64 and 32 bit targets
    • build only for OSX 32 bit target
    • Build for all 64 bit
• Packaging script (currently in BETA)
  • Hooks
  • Usage
• License
• Thanks

nwjs shell builder script

nwjs shell script builder for nwjs (node-webkit) applications.

This script can be easily integrated into your build process.

How it works

It will download nwjs 32/64bit for Linux, Windows and OSX and build for all 3 platforms from given source directory

How we use it

This script was made to help us automate nightly builds of Gisto

You can see example usage in the CI script in Gisto repository: drone.io script

Usage:

If you want/have to build on Windows machine, use: Babun as your shell. Tested on Windows 8 but should work on Windows 7 too. If you're missing an package (like ZIP), just install it via Babun with pact - a Babun provided package manager.

$ /path/to/nwjs-build.sh --help

Options:

Option	Description
-h, --help	Show help and usage
--version=PACKAGE_VERSION	Set package version (defaults to 1.0.0)
--name=NAME	Set package name (if not set - default will be used)
--src=/PATH/TO/DIR	Set path to source dir
--target="2 3"	Build for particular OS or all (default is to build for all targets) Available targets: - 0 - linux-ia32 - 1 - linux-x64 - 2 - win-ia32 - 3 - win-x64 - 4 - osx-ia32 - 5 - osx-x64
--nw=VERSION	Set nwjs version to use (if not set - default will be used)
--output-dir=/PATH/TO/DIR	Change output directory (if not set - default will be used)
--win-icon=/PATH/TO/FILE	(For Windows target only) Path to .ico file (if not set - default will be used)
--osx-icon=/PATH/TO/FILE	(For OSX target only) Path to .icns file (if not set - default will be used)
--CFBundleIdentifier=com.bundle.name	(For OSX target only) Name of the bundle’s Identifier (if not set - default will be used)
--libudev	(For Linux target only) Use if you want the script to handle the lack of libudev.so.0 (linux targets) as mentioned here
--build	Start the build process (IMPORTANT! Must be the last parameter of the command)
--clean	Clean and remove TMP directory

Examples

========================

The bare minimum to build:

$ ./path/to/nwjs-build.sh \
    --src=/home/projects/PACKAGE_NAME/src \
    --build

Clean working dir:

$ ./path/to/nwjs-build.sh \
    --clean

Build for all targets:

$ ./path/to/nwjs-build.sh \
    --src=/home/projects/PACKAGE_NAME/src \
    --output-dir=/path/to/output/the/builds \
    --name=PACKAGE_NAME \
    --win-icon=/home/projects/resorses/icon.ico \
    --osx-icon=/home/projects/resorses/icon.icns \
    --CFBundleIdentifier=com.bundle.name \
    --target="0 1 2 3 4 5" \
    --version="1.0.0" \
    --libudev \
    --nw=0.11.6 \
    --build

Build only for windows 64 and 32 bit targets:

$ ./path/to/nwjs-build.sh \
    --src=/home/projects/PACKAGE_NAME/src \
    --output-dir=/path/to/output/the/builds \
    --name=PACKAGE_NAME \
    --win-icon=/home/projects/resorses/icon.ico \
    --target="2 3" \
    --version="1.0.0" \
    --build

Build only for osx 32 bit target:

$ ./path/to/nwjs-build.sh \
    --src=/home/projects/PACKAGE_NAME/src \
    --output-dir=/path/to/output/the/builds \
    --name=PACKAGE_NAME \
    --osx-icon=/home/projects/resorses/icon.icns \
    --CFBundleIdentifier=com.bundle.name \
    --target="4" \
    --version="1.0.0" \
    --build

Build for all 64 bit:

$ ./path/to/nwjs-build.sh \
    --src=/home/projects/PACKAGE_NAME/src \
    --output-dir=/path/to/output/the/builds \
    --name=PACKAGE_NAME \
    --osx-icon=/home/projects/resorses/icon.icns \
    --win-icon=/home/projects/resorses/icon.ico \
    --CFBundleIdentifier=com.bundle.name \
    --target="1 3 5 " \
    --version="1.0.0" \
    --libudev \
    --build

NWJS packaging script (currently in BETA)

❗ Please note that this is currently in BETA and it is not affecting the build script. You may off course use it but beta warning applies with all consequenses, so don't expect it to work out-of-the-box.

• install if not present zip, unzip, tar, git, NSIS, libxml2
• rename config.json.sample to config.json and adjust correct paths or generate with ./pack.sh init or specify location of the config.json by adding --config=/path/to/config.json

Usage:

./pack.sh init - generate config.json with interactive CMD

./pack.sh --windows - to build Windows installers

./pack.sh --linux - to build Linux installers

./pack.sh --osx - to build OSX installers

./pack.sh --all - to build installers for all systems

./pack.sh --all --config=/path/to/config.json - to build installers for all systems but using config.json located in any other path than in root directory

./pack.sh --clean - removes the ./TMP working directory

./pack.sh --clean all - removes the ./TMP working directory and releases directory (with all the content)

Hooks:

Place hooks in ./hooks/ directory

• file name before.sh will be executed before each build start
• file name after.sh will be executed after packaging script is finished
• file name after_build.sh will be executed after each platform build is finished

License

MIT

Thanks

Huge thanks to @SchizoDuckie for assisting with OSX build