Do you have an interest in the Guilded API and have prior experience with working with typescript libraries? Make an issue in this github repository or shoot us a message in our Guilded Server!
This repo serves as a monorepo that houses several packages, mainly the guilded.js
package, which is a library for the Guilded API.
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/api
(GitHub, NPM) - Multi-use wrapper over the entire Guilded API. Covers rest requests and ws connections.
Recommended that you use node v18+
npm install guilded.js
yarn add guilded.js
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();
Looking for all the Client events? See here
Documentation is viewable here: https://guilded.js.org
A general purpose guide is available here: https://guilded-js.gitbook.io/api-docs/
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.
Discord.js - Inspiration & derived work.
Maintained by: zaida04, Skillz4Killz, Uhuh, and DaStormer