Build and run server (Windows/OS X/Linux)

December 19, 2024 ยท View on GitHub

Prerequisites:

I only use even-numbered node.js releases, but odd-numbered releases may work!

If you get errors with node.js 20.x, try node.js 18.x.

Build and run on Windows

Additional prerequisites:

  • Visual Studio

  1. Launch the appropriate native tools command prompt - search for x64 native tools in the Start menu

  2. Change to the server folder in the working copy

  3. Run npm install. A build error mentioning sys/ioctl.h is expected - this is benign, and can be ignored

  4. Run run OPTIONS to start the server, where OPTIONS are the command line options for it - see the server docs

Build and run on macOS/Linux

Additional macOS prerequisites:

  • Xcode

Additional Linux Ubuntu package prerequisites: (you're on your own for other distros - reports welcome)

  • apt-get install libusb-dev (libusb)
  • apt-get install libudev-dev

Steps:

  1. Go to terminal

  2. Change to the server folder in the working copy

  3. Run npm install

  4. Run npm start -- OPTIONS to start the server, where OPTIONS are the command line options for it - see the server docs