guildedjs / guilded.js

⚠️ This project is in an Alpha stage, be weary of bugs. API Coverage is lacking at this point, will be waiting for the official Guilded API before adding more features. This library only works with selfbots for now. Selfbots are a gray zone in Guilded, so use this library at your own risk.

Tools for interacting with the Guilded.gg API.
Written in TS

Join our Discord Server! > Documentation

Table of Contents

• Example Usage
• About the Project
• Packages
• Getting Started
  • Prerequisites
  • Installation
  • Documentation
• Contributing
• License

Usage

// commonJS:
const { Client } = require("@guildedjs/guilded.js");

/*
 * ES6:
 * import { Client } from "@guildedjs/guilded.js";
 */

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"
});

About

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

Packages

• @guildedjs/guilded.js - main package that provides a lib for the guilded.gg api. Comes with built in caching, structures, etc.
• @guildedjs/itami - official framework for @guildedjs/guilded.js, comes with highly customizable commands, listeners, and other abstractions.
• @guildedjs/guilded-api-types - 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 reinventing the wheel.

Getting Started

Prerequisites

You are expected to have a reasonably supported version of node.js. Guildedjs is tested on node.js >12.0.0 and we make no guarantees that it will work on earlier versions

Installation

• npm install @guildedjs/guilded.js
• yarn add @guildedjs/guilded.js

Documentation

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

Contributing

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

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Please ensure your commits pass the tests, lints, and builds. This means you should test it locally before pushing.

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 - Caching strategy and overall layout

LICENSING

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