mirror of
https://github.com/tiramisulabs/seyfert.git
synced 2025-07-01 20:46:08 +00:00
89 lines
2.7 KiB
Markdown
89 lines
2.7 KiB
Markdown
# biscuit
|
|
|
|
## A brand new bleeding edge non bloated Discord library
|
|
|
|
<img align="middle" src="https://raw.githubusercontent.com/oasisjs/biscuit/main/assets/biscuit.svg" alt="biscuit" />
|
|
|
|
### Install (for [node18](https://nodejs.org/en/download/))
|
|
|
|
```sh-session
|
|
npm install @oasisjs/biscuit
|
|
pnpm add @oasisjs/biscuit
|
|
yarn add @oasisjs/biscuit
|
|
```
|
|
|
|
> or via [cdn](https://nest.land/package/biscuit)
|
|
|
|
The biscuit Discord library is built ontop of Discordeno and webspec APIs, we aim to provide portability. Join our
|
|
[Discord](https://discord.gg/zmuvzzEFz2)
|
|
|
|
### Most importantly, biscuit is:
|
|
|
|
- A modular [Discordeno](https://github.com/discordeno/discordeno) fork
|
|
- A framework to build Discord bots
|
|
- A bleeding edge API to contact Discord
|
|
|
|
Biscuit is primarily inspired by Discord.js and Discordeno but it does not include a cache layer by default, we believe
|
|
that you should not make software that does things it is not supposed to do.
|
|
|
|
### Why biscuit?:
|
|
|
|
- [Minimal](https://en.wikipedia.org/wiki/Unix_philosophy), non feature-rich!
|
|
- Crossplatform
|
|
- Consistent
|
|
- Performant
|
|
|
|
### Example bot (TS/JS)
|
|
|
|
```js
|
|
import { GatewayIntents, Session } from "@oasisjs/biscuit";
|
|
|
|
const token = "your token goes here";
|
|
|
|
const intents = GatewayIntents.MessageContent | GatewayIntents.Guilds | GatewayIntents.GuildMessages;
|
|
const session = new Session({ token, intents });
|
|
|
|
session.on("ready", ({ user }) => {
|
|
console.log("Logged in as:", user.username);
|
|
});
|
|
|
|
session.on("messageCreate", (message) => {
|
|
if (message.content.startsWith("!ping")) {
|
|
message.reply({ content: "pong!" });
|
|
}
|
|
});
|
|
|
|
session.start();
|
|
```
|
|
|
|
### Mininal style guide
|
|
|
|
- 4 spaces, no tabs
|
|
- Semi-colons are mandatory
|
|
- Run `deno fmt`
|
|
- Avoid circular dependencies
|
|
|
|
### Contrib guide
|
|
|
|
- Install Deno extension [here](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno)
|
|
- Run `deno check` to make sure the library works
|
|
- Avoid sharing state between classes
|
|
|
|
### Compatibility (bun)
|
|
|
|
**⚠️ DISCLAIMER:** since bun is unstable I highly recommend running biscuit on node!
|
|
|
|
- We got the library running on EndeavourOS but it spams the ready event multiple times
|
|
- We got the library running on Arch/Artix Linux but breaks when sending fetch requests
|
|
- We got the library running on WSL (Ubuntu) without any trouble
|
|
|
|
> if you really want to use the library with bun remember to clone the repo instead of installing it via the registry
|
|
|
|
### Known issues:
|
|
|
|
- some properties may be not implemented yet
|
|
- some structures are not implemented (see https://github.com/oasisjs/biscuit/issues)
|
|
- cache (wip)
|
|
- no optimal way to create embeds, should be fixed in builders tho
|
|
- no optimal way to deliver a webspec bun version to the registry (#50)
|