Mirror of the official squircy3 repository
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tyler Sommer c3d2f3982e
Ready-to-use docker image, update README
1 day ago
cmd/squircy Add node_compat plugin, enhance require(), support []string in config 2 days ago
config Add node_compat plugin, enhance require(), support []string in config 2 days ago
event Add node_compat plugin, enhance require(), support []string in config 2 days ago
irc Life, the universe, and everything 1 month ago
plugin Fix formatted print calls 2 days ago
plugins Reduce boilerplate for plugins, allow circular requires 1 day ago
vm Reduce boilerplate for plugins, allow circular requires 1 day ago
.dockerignore Life, the universe, and everything 1 month ago
.gitignore Life, the universe, and everything 1 month ago
Dockerfile Ready-to-use docker image, update README 1 day ago
LICENSE Life, the universe, and everything 1 month ago
Makefile Reduce boilerplate for plugins, allow circular requires 1 day ago
README.md Ready-to-use docker image, update README 1 day ago
config.toml.dist Ready-to-use docker image, update README 1 day ago
go.mod Ready-to-use docker image, update README 1 day ago
go.sum Ready-to-use docker image, update README 1 day ago
package.json Life, the universe, and everything 1 month ago

README.md

squircy3

A proper IRC bot.

Overview

squircy3 is a cross-platform application written in Go that works nearly anywhere. A plugin architecture enables the bot’s capabilities and functionality to expand and support anything.

Core plugins provide IRC client functionality, central configuration, and an embedded JavaScript runtime. Other built-in plugins provide NodeJS compatibility including support for ES6+ features through babel.

Getting started

Clone this repository, then build using make.

git clone git@code.dopame.me:veonik/squircy3
cd squircy3
make all

The main squircy executable and all built plugins will be in out/ after a successful build.

Run squircy.

out/squircy

Docker

Run squircy3 in Docker using the veonik/squircy3 image hosted on Docker Hub.

docker run --it veonik/squircy3:latest

Configuration

squircy3 is configured using the TOML file config.toml below the bot’s root directory.

See config.toml.dist for the reference version of this file.