An open API service indexing awesome lists of open source software.

https://github.com/zaida04/g.js-self

[archive] Library for creating selfbots on Guilded.
https://github.com/zaida04/g.js-self

Last synced: 8 months ago
JSON representation

[archive] Library for creating selfbots on Guilded.

Awesome Lists containing this project

README

          

> # 🚨 This library has been discontinued in favor of the bot API version, which can be found [here](https://github.com/guildedjs/guilded.js-next)


guildedjs

Tools for interacting with the Guilded.gg API.






CI
License: MIT


## 📝 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 `@guildedjs/guilded.js` package, which is a library for the Guilded API. Inspired heavily by [discord.js](https://github.com/discordjs/discord.js)

## 📦 Packages

- `@guildedjs/guilded.js` (**[GitHub](https://github.com/zaida04/guilded.js-selfbot/tree/main/packages/guilded.js#readme), [NPM](https://www.npmjs.com/package/@guildedjs/guilded.js)**) - main package that provides a lib for the guilded.gg API. Comes with built in caching, structures, etc.
- `@guildedjs/guilded-api-types` (**[GitHub](https://github.com/zaida04/guilded.js-selfbot/tree/main/packages/guilded-api-typings#readme), [NPM](https://www.npmjs.com/package/@guildedjs/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.
- `@guildedjs/rest` (**[GitHub](https://github.com/zaida04/guilded.js-selfbot/tree/main/packages/rest#readme), [NPM](https://www.npmjs.com/package/@guildedjs/rest)**) - Utility for making REST requests.
- `@guildedjs/webhook-client` (**[GitHub](https://github.com/zaida04/guilded.js-selfbot/tree/main/packages/webhook-client#readme), [NPM](https://www.npmjs.com/package/@guildedjs/webhook-client)**) - Library-agnostic webhook client for interaction with guilded.gg API webhooks.
- `@guildedjs/embeds` (**[GitHub](https://github.com/zaida04/guilded.js-selfbot/tree/main/packages/embeds#readme), [NPM](https://www.npmjs.com/package/@guildedjs/embeds)**) - Library-agnostic embed builder for sending messages with rich content through the guilded.gg API.
- `@guildedjs/common` (**[GitHub](https://github.com/zaida04/guilded.js-selfbot/tree/main/packages/common#readme), [NPM](https://www.npmjs.com/package/@guildedjs/common)**) - Utilities and structures shared across various @guildedjs packages.

## 📥 Installation

NPM

**Recommended that you use node v12+**

- `npm install @guildedjs/guilded.js`
- `yarn add @guildedjs/guilded.js`

## ⚡ Usage

You can find extra examples [here](https://github.com/zaida04/guilded.js-selfbot/tree/main/examples)

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

## 📃 Documentation

Documentation is viewable here: https://zaida04.github.io/guildedjs-selfbot-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**.

**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** © [zaida04](https://github.com/zaida04). All packages released under [MIT](https://github.com/zaida04/guilded.js-selfbot/blob/main/LICENSE).