BetterBoxx - Chatbot powered by Node.js

This is a simple chatbot application that uses the OpenAI API to generate responses to user inputs. The code is written in Node.js 18 or higher and relies on the @remote-kakao/core package for its messaging functionality.

This bot also supports plugins via the /plugins directory, allowing users to extend its functionality by adding custom features and integrations. Developers can easily create new plugins and enhance the chatbot's capabilities to suit their specific needs.

This repository hosts both server and client codes. The document below explains configuring server-end of the project. Pasting reference/client.js into Messenger Bot R should make the client work out of the box.

Getting Started

To get started with this project, first, clone the repository to your local machine using the following command:

git clone https://github.com/BetterBoxx/BetterBoxx.git

After cloning the repository, navigate to the project directory and install the required dependencies using npm.

cd BetterBoxx
npm install

Configuration

Before running the chatbot, you will need to configure the environment variables. Rename the .env.example file to .env and replace the value of OPENAI_API with your OpenAI API key. Optionally, you can also set your desired port to expose in the same file.

OPENAI_API=YOUR_API_KEY
PORT=YOUR_PORT #optional

You can also configure authentication for each room by setting USE_AUTH to TRUE and AUTH_ROOM to the room ID you want to authenticate.

USE_AUTH=TRUE #or FALSE
AUTH_ROOM=YOUR_ROOM_ID,SECOND_ROOM,THIRD,SO_FORTH

To enhance security, it is advised to rename room names with random strings on your device while using the BetterBoxx client to serve as a secret key.

Usage

To start the chatbot, run the following command in your terminal:

npm start

To keep the chatbot running indefinitely, use forever as follows:

forever start index.js

The chatbot will log your OpenAI API to console and start listening on the port specified in the .env file or default to port 3000.

Functionality

The chatbot responds to messages that begin with the various commands. A help module is included, so check them out by sending /? in chat.

The chatbot also responds to the Ping! command with a "Pong!" message.

Additionally, attaching messages following >> will pass the message to OpenAI gpt-3.5-turbo API, replying to the chat with an AI generated response.

Using a plugin

In this example, we will use keyword-manager as a plugin.

1. Place the plugin inside plugins directory.

2. In index.js of BetterBoxx's root directory,

   a. At the top of the file, add import { processKeyword } from "./plugins/keyword-manager/index.js";

   b. Under function processMessage, add imported function and pass incoming msg like so:

   function processMessage(msg) {
   	// NOTE: Add more features here
   	openAIChat(msg);
   }

   c. Edit .env as required per plugin. Sample .env for keyword-manager is already provided in this repository.

Other information

Using Android as a server

KKS has written a great guide on doing this on Android using Termux. Link to the guide

"If you think you screwed up somewhere, it's better to start over." - KKS

If the link above is broken, refer to archived page. Link to the archived guide

Developing plugins

To develop a plugin for BetterBoxx, follow these steps:

1. Create a new directory for your plugin: In the plugins folder, create a new directory named after your plugin.

2. Create a new JavaScript file: Inside your plugin directory, create a JavaScript file with the same name as your plugin.

3. Define your plugin: Define your plugin as an object in your JavaScript file. It should have properties like name, version, onLoad, and onMessage.

Use the openai-gpt plugin, which is included in this repository, as an example to understand the structure and functionality of a plugin.

Credits

This project uses code from remote-kakao by thoratica (MIT License).

I would like to express my gratitude to the developers of these projects for their valuable contributions to the open-source community.

License

This project is licensed under the MIT License - see the LICENSE file for details. You are free to use, modify, and distribute this code as you see fit.