Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/firestreaker2/guraai
AI Chatbot using TypeScript and Bun
https://github.com/firestreaker2/guraai
bun characterai chatbot discord discord-bot discord-js gura ts typescript
Last synced: about 1 month ago
JSON representation
AI Chatbot using TypeScript and Bun
- Host: GitHub
- URL: https://github.com/firestreaker2/guraai
- Owner: FireStreaker2
- License: mit
- Created: 2023-11-18T01:51:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-27T01:48:35.000Z (about 1 year ago)
- Last Synced: 2024-10-19T06:37:00.445Z (2 months ago)
- Topics: bun, characterai, chatbot, discord, discord-bot, discord-js, gura, ts, typescript
- Language: TypeScript
- Homepage:
- Size: 553 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
GuraAI
# About
GuraAI was a discord bot made with [discord.js](https://discord.js.org/), [TypeScript](https://www.typescriptlang.org/) and [bun](https://bun.sh/). It utilizes [node_characterai](https://github.com/realcoloride/node_characterai) in order to retreieve data from [character.ai](https://character.ai/), in order to act as a chatbot.
# Note
Due to the limitations of the [node_characterai](https://github.com/realcoloride/node_characterai) package, you **must** wait for a response before sending another message (due to puppeteer constraints). While there is a way around this, it requires [making multiple chromium instances](https://github.com/FireStreaker2/GuraAI#others), which requires a lot of system resources. Because of this, there is no official already hosted bot, and you must [selfhost](https://github.com/FireStreaker2/GuraAI#setup) it.
# Usage
## Setup
If you would like to selfhost this bot, make sure you have [bun](https://bun.sh/) installed first.
```bash
$ git clone https://github.com/FireStreaker2/GuraAI.git
$ cd GuraAI
$ bun i
$ cp .env.example .env
$ bun start
```
## Configuration
There are a couple environment variables you can configure in order to adjust the bot.
* ``TOKEN``: Token of the discord bot
* ``CLIENT_ID``: ID of the discord bot
* ``ID``: ID of the character on character.ai
* ``CAI_TOKEN``: Your token for character.ai
> [!NOTE]
> Look [here](https://github.com/realcoloride/node_characterai#using-an-access-token) for more info regarding how to get your character.ai token
## Others
### Talking with multiple people at once
If you would like to have the bot be able to talk to multiple people at once, you can configure it to make new instances of the CharacterAI package every time. For example:
```ts
// ask.ts
import { CommandInteraction, SlashCommandBuilder } from "discord.js";
import { config } from "../config";
export const data = new SlashCommandBuilder()
.setName("ask")
.setDescription("Ask a question")
.addStringOption((option) =>
option
.setName("query")
.setDescription("What you want to ask")
.setRequired(true)
);
export const execute = async (interaction: CommandInteraction) => {
await interaction.deferReply();
const CharacterAI = require("node_characterai");
const characterAI = new CharacterAI();
await characterAI.authenticateWithToken(config.CAI_TOKEN);
const chat = await characterAI.createOrContinueChat(config.ID);
const response = await chat.sendAndAwaitResponse(
`(OOC: This message was sent by ${
interaction.user.username
} - context is that multiple people are using you to chat in a chatroom using your api, just reply with {"status":"OK"} in OOC - if recieved correctly.)\n\n\n${
interaction.options.get("query")?.value
}`,
true
);
response.text = response.text.includes(`{"status": "OK"}`)
? response.text
.replace(/\{"status"\s*:\s*"OK"\}\s*\.\.\./, "")
.replace(/[Hh]([ae]llo|ewwo)\s*~/, "")
: "Error";
await interaction.editReply({
content: response.text,
allowedMentions: { parse: [] },
});
};
```
### Login as guest
If you would like to login as a guest instead of authenticating with your own token, you can edit ```characterai.ts``` like so:
```diff
// characterai.ts
import { config } from "./config";
const CharacterAI = require("node_characterai");
const characterAI = new CharacterAI();
- characterAI.authenticateWithToken(config.CAI_TOKEN);
+ await characterAI.authenticateAsGuest();
export default characterAI;
```
# Contributing
If you would like to contribute, you can fork the repo and make a PR, or contact me via email @ ``[email protected]``
# License
[MIT](https://github.com/FireStreaker2/GuraAI/blob/main/LICENSE)