🎒
TouchGuild Guide
Get back Home
  • TouchGuild's Docs
  • Introduction
  • Privacy Policy
  • 📝Installation & Preparation
  • âš’ī¸Setting up an application
  • 🤖Creating your application
  • Intents
  • Application Commands
    • Registering
    • Command Interactions
    • Components
  • đŸ“ŦManaging messages
    • â„šī¸Tips
    • Original Message concept & how it works
    • Creating embeds
  • Permissions & Roles
  • 😰Reactions
  • Data & Analytics
  • Managing members
    • đŸ’¯Award experience to server members
    • đŸĻĩBan, unban & kick server members
Powered by GitBook
On this page
  • Installing the runtime
  • Method 1: Installing Node.js
  • Method 2: Installing Bun instead of Node.js
  • Installing a linter

Was this helpful?

Installation & Preparation

PreviousPrivacy PolicyNextSetting up an application

Last updated 7 months ago

Was this helpful?

Installing the runtime

TouchGuild is built using the Node.js runtime, so we highly recommend to use it to not face unexpected compatibility issues.

You can also use TouchGuild with instead of Node.js (we tested it and it worked!) and any other runtime that is Node.js (as well as npm) compatible.

We're developing TouchGuild using Node.js, we cannot ensure that using it with Bun or any other runtime will work as expected.

So let's get started installing Node.js or Bun, shall we?

Method 1: Installing Node.js

To use TouchGuild, you'll need to install . The latest TouchGuild version (v1.x.x) 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 macOS, either:

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

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

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

On Linux, you can consult 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
yarn init
pnpm 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
yarn add touchguild
pnpm add touchguild

You're almost ready to code your Guilded bot!

Method 2: Installing Bun instead of Node.js

As said earlier, you can install Bun instead of Node.js, but we cannot ensure that it'll work properly, we only tried it once. As long as Bun supports Node.js and is fully compatible, you won't have any issue when it comes to developing using TouchGuild.

Paste into your Terminal:

curl -fsSL https://bun.sh/install | bash

Using Homebrew (if you have it installed):

brew install oven-sh/bun/bun
powershell -c "irm bun.sh/install.ps1|iex"
curl -fsSL https://bun.sh/install | bash

Create a folder for your project

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

Initiating the project folder

Run the following command to

bun init

After executing it, follow the instruction given by the command (you don't have to specify anything if you don't want to, you can press enter multiple times to skip).

After that, you should see that some files have been added to your folder, this includes your package.json that is used to manage your dependencies and list other information about your project, and some other files.

You're one step closer to adding TouchGuild to your brand new project.

Installing TouchGuild

Finally! We're installing it!

Run the following command into your terminal in your project folder (it is npm compatible).

bun install touchguild

TouchGuild is ready to use!

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.

More ways & more information on how to install Bun (Guide):

📝
Bun
Node.js
Node.js website
Homebrew
Node.js website
this page
https://bun.sh/docs/installation