Building - KingRainbow44/Open-Shen GitHub Wiki

Note: This guide is for building from source. Usually the development branch.

Prerequisites

  1. You have Visual Studio 2019 installed. (versions after 2017 work as well)
  2. You have Node v17.xx.x installed. (versions after v16.xx.x work as well)
  3. You have set the environment variable WORKING_DIRECTORY to your debug path. (only required for running from source)

Building

  1. If you haven't already, run git clone https://github.com/KingRainbow44/Open-Shen
  2. Run git checkout development (or stay on stable)
  3. Run npm install --save-dev (this installs additional dependencies for compiling)
  4. Run npm run package or npm run debug

npm run package compiles your code into an executable binary, while npm run debug runs the code from source.