Snowcone is a small core C++ project that provides the facilities necessary for a highly configurable and robust IRC functionality. Its behavior is programmable via the Lua scripting language. Two Lua packages are provided enabling snowcone to be the premiere solanum server notice console as well as a relaxed chat client.
To use snowcone, create a configuration file as described below and invoke one of the two modes:
# These mode shortcuts (dashboard/ircc) work when snowcone is installed
# otherwise you'll need to provide a path to the appropriate init.lua
# Launch the dashboard
$ snowcone dashboard
# Launch the client
$ snowcone irccThese are the baseline dependencies
# Debian build dependencies
apt install cmake pkg-config liblua5.4-dev libidn-dev libssl-dev libncurses-dev libgeoip-dev lua-mmdb lua-penlight lua-rex-pcre2-dev
# Optional on x86_64
apt install libhyperscan-dev
# Optional on arm64
apt install libvectorscan-dev
# Optional for testing
apt install libgmock-dev libgtest-dev lua-check
# Homebrew
brew install cmake pkg-config lua luarocks libidn ncurses openssl pcre2
# Optional on x86_64
brew install hyperscan
# Optional on arm64
brew install vectorscan
# Lua run-time dependencies
luarocks install penlight mmdblua lrexlib-pcre2
# On ARM mac you'll need to specify where pcre2 is installed
luarocks install lrexlib-pcre2 PCRE2_DIR=/opt/homebrew/opt/pcre2Snowcone can also make use of doxygen, luacheck, libhyperscan/libvectorscan.
cmake --preset arm-mac
cmake --build --preset arm-mac --target install
out/install/arm-mac/bin/snowcone dashboard- / - start typing a command
- CtrlS - start typing a search query (Lua pattern string)
- Esc - exit current input mode
- CtrlN - next view
- CtrlP - previous view
- F1-F8 - jump to view
/console- raw IRC message view/help- list of slash commands/quit- quit the IRC connection and exit the application/quote- enter a RAW IRC command (lots of stuff isn't implemented so you might use this more than usual)
/status- client log messages/session- state of the IRC connection/stats- internal information/eval- run some Lua code
- / - start typing a command
- t - start typing a chat message
- CtrlS - start typing a search query (Lua pattern string)
- Esc - exit current input mode
/console- raw IRC message view/help- list of slash commands/talk <target>- open a chat buffer for a channel or PM/close- close the current chat buffer/quit- quit the IRC connection and exit the application/quote- enter a RAW IRC command (lots of stuff isn't implemented so you might use this more than usual)
/status- client log messages/session- state of the IRC connection/stats- internal information/eval- run some Lua code
Default configuration path in order of preference
- Argument to
--configflag $XDG_CONFIG_HOME/snowcone/settings.lua$HOME/.config/snowcone/settings.lua
Configuration file format is a Lua literal. All fields are optional
except: nick, host, port.
{
-- the 3 required things
nick = 'snowconer',
host = "irc.libera.chat",
port = 6697,
user = 'myuser',
gecos = 'your realname text',
pass = 'a server password',
tls = true, -- set to false for plaintext connections
tls_client_cert = { file = '/path/to/pem' }, -- optional
tls_client_key = { file = '/path/to/pem' }, -- defaults to tls_client_cert
tls_client_password = 'apassword', -- defaults to '' if unspecified
tls_verify_host = 'host.name', -- used to override the hostname in the host key
-- most useful when connecting by IP address to a server with a certificate
sasl_credentials = {
default = { -- default is what get used at connection time automatically
mechanism = 'PLAIN',
username = 'username',
password = 'somepassword',
},
use_cert = { -- other names can be invoked with: /sasl <credential name>
mechanism = 'EXTERNAL',
}
},
mention_patterns = { -- Lua's pattern match syntax
'%f[%w]yournickname%f[^%w]',
},
notification_module = 'notification.mac', -- works on macOS using terminal-notifier
-- notification_module = 'notification.bell', -- uses normal terminal BELL character
plugin_dir = '/path/to/plugins',
plugins = {}, -- list of plugin names
-- Don't set these unless you run your own network
oper_username = 'username', -- used with OPER and CHALLENGE commands
oper_password = 'password', -- used with OPER command
challenge_key = { file = '/path/to/pem' }, -- used with CHALLENGE command
challenge_password = 'password', -- decryption password for challenge pem
}Credentials can be specified as:
- Literal string:
"example" - File contents:
{file="path"} - Command stdout:
{command="executable", arguments={"arg1", "arg2"}, multiline=false}
Viewed connections can be filtered with the /filter <disjunct> command.
Example: /filter nick "glguy" and (host |\.com$|I or account "*")
To reset the filter use an empty /filter
disjunct := conjunct ('or' disjunct)*
conjunct := atom ('and' conjunct)*
atom := '(' disjunct ')'
| 'not' atom
| field pattern
field := 'account' # e.g. "acct", unknown is "*"
| 'asn' # e.g. "1234"
| 'class' # e.g. "users"
| 'gecos' # e.g. "realname"
| 'host' # e.g. "example.com"
| 'ip' # e.g. "192.0.2.0"
| 'mask' # e.g. "nick!user@host"
| 'nick' # e.g. "nick"
| 'org' # e.g. "SOME-CORP"
| 'reason' # e.g. "Client Quit"
| 'server' # e.g. "gold.libera.chat"
| 'user' # e.g. "user", unknown is "?"
pattern := '|' regular-expression '|' # pcre regexp
| '|' regular-expression '|I' # caseless pcre regexp
| '"' literal string '"' # exact match
| "'" literal string "'" # exact match
Snowcone's ircc mode can load hyperscan databases for configuring the
server-side message filter extension. This requires installing either
the hyperscan or vectorscan optional packages.
Example patterns.lua can be loaded with /upload_filterdb /path/to/patterns.lua.
{
patterns = {
{
actions = {'DROP', 'ALARM'},
flags = {'HS_FLAG_SINGLEMATCH', 'HS_FLAG_CASELESS'},
regexp = 'example spam string',
},
{
actions = {'KILL'},
flags = {'HS_FLAG_SINGLEMATCH'},
regexp = 'example kill string',
},
},
}