guilded.ts

A powerful NPM module that allows you to easily interact with the Guilded API.

Links

• GitHub
• NPM
• Guilded.TS Guilded Server
• Guilded API Guilded server
• Documentation

Packages

• guilded.ts ( NPM ) - The main package for interacting with the official Guilded API.
• guilded-api-typings ( NPM ) - Type definitions for the Guilded API.
• @guildedts/builders ( NPM ) - A set of builders for creating a Guilded bot.
• @guildedts/rest ( NPM ) - The REST API manager for Guilded.TS.
• @guildedts/ws ( NPM ) The Websocket API manager for Guilded.TS.

Installation

npm i guilded.ts
yarn add guilded.ts
pnpm add guilded.ts

Example bot

// ESM
import Client, { Embed } from 'guilded.ts';
// CommonJS
const { Client, Embed } = require('guilded.ts');

// Create a new client
const client = new Client();

// This event is emitted when your bot is connected to Guilded's Gateway API.
client.once('ready', () => console.log(`[READY] Logged in as ${client.user.name}.`));

// This event is emitted when a message is sent on Guilded.
client.on('messageCreate', (message) => {
    if (message.content?.toLowerCase() !== 'ping') return;

	const embed = new Embed()
        .setTitle('Pong!')
        .setDescription('This is the ping command!')
        .setColor('GREEN');

	message.reply({ content: 'Pong!', embeds: [embed] });
});

// Log into guilded
client.login('YOUR_BOT_TOKEN');

Contributing

Contributing helps us maintain Guilded.TS. All contributions are greatly appreciated.

We utilize Yarn and Turbo to manage our Monorepo. If you want to contribute we highly recommend knowing the basics of these two.

Getting started

To get started, run the following scripts:

# Install all dependencies
yarn install
# Build all local packages
yarn build

Committing your changes

After you have made your desired changes, make sure you run the following script before committing your changes:

# Prepare your code
# Runs prettier along with eslint
yarn prepare

---

Maintained by Gamertike. | Inspired by discord.js.