guilded

Tools for interacting with the Guilded.gg API.

📝 About

⚠️ This library only works with selfbots, which are a gray zone in Guilded. Use at your own risk.

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

📦 Packages

• js/guilded.js (GitHub, NPM) - main package that provides a lib for the guilded.gg API. Comes with built in caching, structures, etc.
• js/guilded-api-types (GitHub, NPM) - thinking of making your own guilded lib/wrapper? This package consists of typings for the guilded.gg API compiled together by the community. No need to write your own typings and reinvent the wheel.
• js/webhook-client (GitHub, NPM) - Library-agnostic webhook client for interaction with guilded.gg API webhooks.
• js/embeds (GitHub, NPM) - Library-agnostic embed builder for sending messages with rich content through the guilded.gg API.
• js/common (GitHub, NPM) - Utilities and structures shared across various js packages.
• js/itami (GitHub) - official framework for js/guilded.js, comes with highly customizable commands, listeners, and other abstractions.

📥 Installation

Recommended that you use node v12+

• npm install guilded
• yarn add guilded

⚡ Usage

You can find extra examples here

const { Client } = require("guilded");

/*
 * ES6:
 * import { Client } from "guilded";
 */

const client = new Client();

client.on('ready', () => console.log(`Bot is successfully logged in`));

client.on("messageCreate", message => {
    if(message.content === "poggers") {
        return message.channel.send("poggers indeed");
    }
})

client.login({
    email: "email",
    password: "password"
});

📃 Documentation

Documentation is viewable here: https://guilded.js.org

✋ 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.

Please run npm run bootstrap after running npm install in your local environment. Please ensure your commits pass the test, lint, and build scripts.

We make use of lerna to manage our monorepo. The main commands used are below

• lerna add <module> [--scope=package-name] - add npm module dependency to all/specific package(s)
• lerna create <package> - create a new package
• npm run bootstrap = lerna bootstrap - recursively install dependencies in all packages and symlink local packages
• lerna run <npm-script> - recursively execute command in all packages (must exist in each packages package.json)

🤝 Acknowledgements

Discord.js - Main inspiration & lots of derived work.

⚖️ LICENSING

Guilded.JS © lnfernal, Released under the MIT License. All subpackages are also released under the MIT License