📚Introduction

Welcome to Guilded.js

Guilded.js is a library for the Guilded.gg API written in TypeScript. It is usable in either TypeScript or JavaScript project and is built to be customizable and extendable, perfect for both hobbyist programmers and those that need a library that will scale with their bot.

The library is heavily inspired by discord.js design-wise. We appreciate the work that they've done over there, so go give them a star.

Guilded.js is made up of various sub-packages, allowing more seasoned programmers that only need certain functionalities to install only what they need. However, for most people, you will only ever need to install the main guilded.js package.

A quick overview of all the sub-packages:

If you're new to the project, the following packages are likely what you're going to be using.

  • guilded.js (GitHub, NPM) - The main library that ties everything together. Contains structures, caching, and other utilities for building your bot.

  • @guildedjs/gil (GitHub, NPM) - Our bot command framework, allowing you to skip a lot of the boilerplate needed to make most bots and jump straight into working on your commands.

These packages are meant for more seasoned programmers who know exactly what functionality they need. You will likely not need to import any of these as they're already included in the main package.

  • @guildedjs/guilded-api-types (GitHub, NPM) - Raw typings for the guilded API, suitable for projects that want to interface directly with the API without having to write types of their own.

  • @guildedjs/webhook-client (GitHub, NPM) - Library agnostic client for send messages through Guilded webhooks.

  • @guildedjs/rest (GitHub, NPM) - Utility for making REST requests to the Guilded API. Includes rate-limiting, proxy support, and route utility functions

  • @guildedjs/ws (GitHub, NPM) - Utility for connecting to Guilded's WebSocket gateway and receiving events. Supports replaying events and handling disconnects.

This guide assumes that you have a basic understanding of JavaScript and Node.JS. If you don't, it's recommended that you start with learning that first, then proceeding with this guide.

Ready to get started?

Here are some of the articles that you're probably looking for.

NextSetting up a Guilded bot

Last updated