Installations & Preparations

Installing Node.js

To use TouchGuild, you'll need to install Node.js. TouchGuild v.0.1.7 requires Node.js v16.16.0 or higher.

If you'd like to check if you have Node.js installed in your machine, run node -v in your terminal. If it outputs 16.16.0 or higher, then you're good to go! Otherwise, continue reading the steps below.

On Windows, it's as simple as downloading any other program. Download the latest version from the Node.js website. Open the downloaded file & follow the instructions.

On macOS, either:

  • Download the latest version from the Node.js website. Open the downloaded file & follow the instructions.

  • Use a package manager like Homebrew & run the command brew install node

On Linux, you can consult this page to determine how you should install Node.js.

Creating the bot's folder

To build a bot, we'll need to create a folder for it.

Initiating the project folder

Run this command in the bot's folder you created to initialize your project folder:

npm init

When running this command, a new file will appear in your folder: package.json, this file lists dependencies of your projects as well as other information about your project.

Once you're done, you're ready to install TouchGuild!

Installing TouchGuild

To install TouchGuild, we'll use the Node's package manager (npm).

Run the command below:

npm install touchguild

You're almost ready to code your Guilded bot!

Installing a linter

While coding, you can run into numerous syntax errors or code in an inconsistent style. It is recommended to install a linter (e.g: ESLint) to ease these troubles.

Now you're ready to code your Guilded bot with TouchGuild.

Last updated