Skip to content

NW-Unity is a tool for auto packing your Unity WebGL output folder to a NW.js executable folder.

License

Notifications You must be signed in to change notification settings

zzxzzk115/NW-Unity

Repository files navigation

NW-Unity

LOGO

PyPI - Wheel PyPI - Python Version version

NW-Unity is a tool for auto packing your Unity WebGL output folder to a NW.js executable folder.


Sample project runs on Windows:

Sample project runs on GameShell:

Quick Usage

Install by pip on Windows/Linux/MacOS:

pip install nwunity

Install by pip on GameShell:

sudo pip3 install nwunity

Pack your game:

# Package your Unity WebGL game(resolution is 320*240, full screen mode is on) on PC, Linux, or MacOS.
nwunity -d "/path/to/UnityWebGLDir" -n "MyGame" --width 320 --height 240 --fullscreen

# Package your Unity WebGL files on GameShell.
nwunity -d "/path/to/UnityWebGLDir" -n "MyGame" -p GameShell

How to use

NW-Unity is easy to use. You can install it by pip.

Install by pip

pip install nwunity

Parameters

You can use nwunity -h or nwunity --help to get help.

Format Parameter Explain
-d --directory Set the root directory of your Unity WebGL files, default is current working directory.
-n --name Set the name of your game, default is 'Untitled-Game'.
--width Set the width of your game window, default is 1024.
--height Set the height of your game window, default is 768.
--fullscreen Set full screen mode on, default is off.
--noframe Hide window frame title, default is show.
--resizable Set resizable mode on, default is off.
--transparent Set transparent mode on, default is off.
-p --platform Set platform, default is normal(PC, Linux, MacOS...). Options: GameShell.
-i --icon Set the icon of the game.

General tips

Unity WebGL uses Brotli to compress files by default, it has a bug: stuck at 90% when loading a game.

So, we have to change the default settings:

This may help you.

GameShell tips

Make sure the OS version of your GameShell is 0.5 or newer.

You have to build and install mesa 20.1 or newer.

Switch the GPU Driver of your GameShell to Lima if it's not.

See more details here

License

The project is under the MIT license.

About

NW-Unity is a tool for auto packing your Unity WebGL output folder to a NW.js executable folder.

Topics

Resources

License

Stars

Watchers

Forks