brainlet-irc/README.md
2021-01-25 14:48:21 -05:00

23 lines
836 B
Markdown

# brainlet-irc
Unofficial Brainlet to IRC translation layer
**WARNING: You should not expose the IRC server to the public! There are multiple known
security issues in the dependencies of the module hosting the actual IRC server.**
# Installing
```bash
git clone --depth=1 --recurse-submodules https://git.hippoz.xyz/hiimgoodpack/brainlet-irc.git
cd brainlet-irc
npm install
pushd ircd.js; npm install; popd
pushd brainlet-lib; npm install; popd
```
# Technical notes
This uses irc@0.5.0. See [this](https://github.com/martynsmith/node-irc/issues/495) for more information
This also uses a fork of ircdjs to add the NOTICE command. [This pull request](https://github.com/alexyoung/ircd.js/pull/99)
is trying to get it merged with the main repository, but I'm not sure how fast it'll get merged seeing the date of the last commit.