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 82d536b9a5
Add ability to specify server password in irc plugin
9 hours ago
cli Extract manager to cli package 1 day ago
cmd/squircy Extract manager to cli package 1 day ago
config Add basic repl, fix some data races, add tests 1 year ago
event Increase default Dispatcher limit to 1024 9 hours ago
irc Add ability to specify server password in irc plugin 9 hours ago
plugin Resolve Promises with AsyncResult, work on net node_compat 3 months ago
plugins Convert node_compat/internal to node_compat/native 22 hours ago
testdata Update goja, peg js deps to specific version 2 months ago
vm Update goja, peg js deps to specific version 2 months ago
.dockerignore Resolve Promises with AsyncResult, work on net node_compat 3 months ago
.gitignore Resolve Promises with AsyncResult, work on net node_compat 3 months ago
Dockerfile Update goja, peg js deps to specific version 2 months ago
LICENSE Life, the universe, and everything 1 year ago
Makefile Update goja, peg js deps to specific version 2 months ago
README.md Add basic repl, fix some data races, add tests 1 year ago
config.toml.dist Ready-to-use docker image, update README 1 year ago
go.mod Convert node_compat/internal to node_compat/native 22 hours ago
go.sum Convert node_compat/internal to node_compat/native 22 hours ago
package.json Update goja, peg js deps to specific version 2 months 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 in interactive mode with -interactive.

out/squircy -interactive

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.