Chariot.js

# Prerequisites

Chariot.js can be installed with optional native dependencies which aren't required for running but enhance performance the larger the bot becomes. Skip to the Installation instructions if no optional dependencies are wished to be used.

In order to successfully install Chariot.js with all optional native dependencies a working compiler environment needs to be running which node-gyp can use to build needed packages from source.

# 🐧 On Unix

  • python with a recommended version of 2.7, 3.5, 3.6 or 3.7
    • Note: Python 3 is only officially supported as of node-gyp version ^5.0.5
  • make
  • A working C++ compiler toolset, like GCC

# Installation:

If using Ubuntu or any other Debian based flavor of Linux, Python usually is already installed, however if Python were to be missing, it can easily be install with sudo apt-get install python. Make sure a working Python installation is in place by checking the version number with python -V or python3 -V. After assuring that Python is installed, installing a compiler toolset is as easy as running sudo apt-get install build-essential to install all build tools needed for node-gyp.

# 🍏 On macOS

  • python with a recommended version of 2.7, 3.5, 3.6 or 3.7
    • Note: Python 3 is only officially supported as of node-gyp version ^5.0.5
  • Xcode

# Installation:

Python is already pre-installed on modern versions of macOS. To install Xcode, head over to the App Store (or click here) and download Xcode. Follow the instructions to install Xcode. In addition to Xcode you'll also need the Command Line Tools. You can install those directly within Xcode. Open Xcode, then navigate to Preferences or click ⌘ + ,, then head to Locations. Alternatively, you can run this command in your Terminal of choice: xcode-select --install. This step will install gcc and all related tools including e.g. make needed to compile with node-gyp.

# 🖥 On Windows

You can install all required tools needed to compile with node-gyp by installing Microsoft's windows-build-tools running following command in either an elevated PowerShell or CMD.exe (or any Terminal you like to use) running as administrator: npm install --global --production windows-build-tools.

← Installation →