Tools for interacting with the official Guilded.gg API.

📝 About

This repo serves as a monorepo that houses several packages, mainly the guilded.js package, which is a library for the Guilded API.

📦 Packages

• guilded.js (GitHub, NPM) - Main library that ties everything together. Has additional logic for caching.
• @guildedjs/gil (GitHub, NPM) - Framework allowing you to build bots with ease.
• @guildedjs/guilded-api-types (GitHub, NPM) - Interfacing directly with the API without using guilded.js? This package provides typings covering the entire API.
• @guildedjs/webhook-client (GitHub, NPM) - Library agnostic client for interacting with webhooks.
• @guildedjs/rest (GitHub, NPM) - Utility for making REST requests to the Guilded API. Includes ratelimit handling.
• @guildedjs/ws (GitHub, NPM) - Utility for connecting to Guilded's WebSocket gateway and receiving events.

📥 Installation

Recommended that you use node v12+

• npm install guilded.js
• yarn add guilded.js

⚡ Usage

You can find extra examples here

const { Client } = require("guilded.js");
// import { Client } from "guilded.js";
const client = new Client({ token: "TOKEN_HERE" });

client.on("ready", () => console.log(`Bot is successfully logged in`));
client.on("messageCreated", (message) => {
    if (message.content === "test") {
        return message.reply("test indeed");
    }
});

client.login();

📃 Documentation

Documentation is viewable here: https://guilded.js.org
A general purpose guide is available here: https://guilded-js.gitbook.io/api-docs/

✋ Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

We make use of PNPM and Changeset to manage our monorepo. It's recommended that if you plan on contributing, you use these tools.

Please run pnpm install -r in your local environment to properly locally symlink all the packages that depend on each other.

Please ensure your commits pass the test, lint, and build scripts.

🤝 Acknowledgements

Discord.js - Inspiration & derived work.

⚖️ LICENSING

Guilded.JS © zaida04. All packages released under MIT.

Maintained by: zaida04, Skillz4Killz, Uhuh, and DaStormer