## 📝 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](https://github.com/discordjs/discord.js)
## 📦 Packages
* `js/guilded.js` (**[GitHub](https://github.com/lnfernal/guilded.js/tree/main/packages/guilded.js#readme), [NPM](https://www.npmjs.com/package/js/guilded.js)**) - main package that provides a lib for the guilded.gg API. Comes with built in caching, structures, etc.
* `js/guilded-api-types` (**[GitHub](https://github.com/lnfernal/guilded.js/tree/main/packages/guilded-api-typings#readme), [NPM](https://www.npmjs.com/package/js/guilded-api-typings)**) - 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](https://github.com/lnfernal/guilded.js/tree/main/packages/webhook-client#readme), [NPM](https://www.npmjs.com/package/js/webhook-client)**) - Library-agnostic webhook client for interaction with guilded.gg API webhooks.
* `js/embeds` (**[GitHub](https://github.com/lnfernal/guilded.js/tree/main/packages/embeds#readme), [NPM](https://www.npmjs.com/package/js/embeds)**) - Library-agnostic embed builder for sending messages with rich content through the guilded.gg API.
* `js/common` (**[GitHub](https://github.com/lnfernal/guilded.js/tree/main/packages/common#readme), [NPM](https://www.npmjs.com/package/js/common)**) - Utilities and structures shared across various js packages.
* `js/itami` (**[GitHub](https://github.com/lnfernal/guilded.js/tree/main/packages/itami#readme)**) - 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](https://github.com/lnfernal/guilded.js/tree/main/examples)
```ts
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](https://lerna.js.org/) to manage our monorepo. The main commands used are below**
* `lerna add [--scope=package-name]` - add npm module dependency to all/specific package(s)
* `lerna create ` - create a new package
* `npm run bootstrap` = `lerna bootstrap` - recursively install dependencies in all packages and symlink local packages
* `lerna run ` - recursively execute command in all packages (must exist in each packages package.json)
## 🤝 Acknowledgements
[Discord.js](https://github.com/discordjs/discord.js) - Main inspiration & lots of derived work.
## ⚖️ LICENSING
> **Guilded.JS** © [lnfernal](https://github.com/lnfernal), Released under the [MIT](https://github.com/lnfernal/guilded.js/blob/main/LICENSE) License. All subpackages are also released under the MIT License
