veonik
/
squircy3
mirror of https://github.com/veonik/squircy3
1
0
Fork 0
Code Issues Releases Wiki Activity
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.
10 Commits
3 Branches
6 Tags
1.4 MiB
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e9caee8cb4'
${ noResults }
Go to file
Tyler Sommer e9caee8cb4
Resolve Promises with AsyncResult, work on net node_compat 		3 years ago
cmd/squircy Add basic repl, fix some data races, add tests 4 years ago
config Add basic repl, fix some data races, add tests 4 years ago
event Add basic repl, fix some data races, add tests 4 years ago
irc Life, the universe, and everything 4 years ago
plugin Resolve Promises with AsyncResult, work on net node_compat 3 years ago
plugins Resolve Promises with AsyncResult, work on net node_compat 3 years ago
testdata Resolve Promises with AsyncResult, work on net node_compat 3 years ago
vm Resolve Promises with AsyncResult, work on net node_compat 3 years ago
.dockerignore Resolve Promises with AsyncResult, work on net node_compat 3 years ago
.gitignore Resolve Promises with AsyncResult, work on net node_compat 3 years ago
Dockerfile Add basic repl, fix some data races, add tests 4 years ago
LICENSE Life, the universe, and everything 4 years ago
Makefile Resolve Promises with AsyncResult, work on net node_compat 3 years ago
README.md Add basic repl, fix some data races, add tests 4 years ago
config.toml.dist Ready-to-use docker image, update README 4 years ago
go.mod Resolve Promises with AsyncResult, work on net node_compat 3 years ago
go.sum Resolve Promises with AsyncResult, work on net node_compat 3 years ago
package.json Life, the universe, and everything 4 years 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.