node.js IRC bot framework

Go to file

hgw 59dc4bc980 Update README		2023-10-03 00:16:14 +00:00
commands	Correct config file names	2023-10-03 00:09:23 +00:00
config	Add brackets setting to example config	2023-10-03 00:10:09 +00:00
.gitignore	init	2023-10-02 02:15:55 +00:00
Dockerfile	init	2023-10-02 02:15:55 +00:00
LICENSE	init	2023-10-02 02:15:55 +00:00
README.md	Update README	2023-10-03 00:16:14 +00:00
bot.js	Correct config file names	2023-10-03 00:09:23 +00:00
docker-compose.yml	init	2023-10-02 02:15:55 +00:00
package-lock.json	init	2023-10-02 02:15:55 +00:00
package.json	init	2023-10-02 02:15:55 +00:00

README.md

Bones

node.js IRC bot framework

Bones is the base framework I use for creating multithreaded IRC bots, originally developed as a way to hugely improve on the speeds of earlier versions of mercury which was at one point extraordinarily slow.

Bones will open all called bot commands in their own node process and then feed back the output as a string to the main file in order to be sent to IRC. This way the main process effectively only acts as a handler for prompts, forcing all outputs to be generated in seperate processes means the bot operates much faster than if the entire thing was just in the main bot.js file.

Deployment

Instructions are general and assume you have already developed something with this framework, not a whole lot of point trying to run this as it is.

Have Docker (required) and Docker Compose (optional, but strongly recommended, this guide assumes you have it) installed already.
Rename config/example.default.json to config/default.json and modify it accordingly. A list of variables and their descriptions can be found in this repos wiki. You do not need to do anything with example.usersettings.json unless you wish to predefine settings prior to the bots first start, the usersettings file will be made on the first run if it does not exist.
You may also want to edit the container names in the docker-compose.yml file accordingly. (Optional but recommended)
Run docker compose up to begin. Append -d to start in the background and --build for the first run and subsequent starts after edits have been made. If you begin the bot with -d you can run docker compose logs -f to see live logs.

Examples

mercury (https://git.supernets.org/hgw/mercury)
fascinus (https://git.supernets.org/hgw/fascinus)

Support

If you need assistance with installation or usage, you are more than welcome to contact me in #5000 on irc.supernets.org

License

This framework is licensed under the ISC License