diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 65 |
1 files changed, 40 insertions, 25 deletions
@@ -1,43 +1,58 @@ -ZyklonB -======= +uirc3 +===== +The unethical IRC trinity. This project consists of an experimental IRC client, +daemon, and bot. It's all you're ever going to need for chatting. -`ZyklonB' is an experimental IRC bot, building upon the concept of my other -VitaminA IRC bot. The main characteristic of these two bots is that they run -plugins as coprocesses, which allows for enhanced reliability and programming -language freedom. +All of them have these potentially interesting properties: + - full IPv6 support + - SSL/TLS support, including client certificates + - minimal dependencies + - very compact and easy to hack on -While originally intended to be a simple C99 rewrite of the original bot, which -was written in the GNU dialect of AWK, it fairly quickly became a playground -where I added everything that seemed nice. +degesch +------- +The IRC client. I thought it would be interesting to build an IRC client on +top of libreadline. At least it's way simpler than doing it in ncurses. +The interface should feel familiar for weechat users. + +It's the youngest and largest of them all and currently under heavy development. kike ---- -Also included is a simple IRC daemon that mostly follows the RFC's but is -limited to single-server networks, due to the protocol being incredibly ugly and -tricky to implement correctly (the poor quality of the RFC's doesn't help). It -is designed for use as a regular user application rather than a system daemon. +The IRC daemon. It mostly follows RFCs but it can't form networks consisting +of multiple servers, or use any services packages, such as Atheme. (Mostly due +to the protocol being incredibly ugly and tricky to implement correctly, with +the poor quality of the RFCs not helping much). It is designed to be used as +a regular user application rather than a system daemon. It is complete enough to be useful but there are still some things that need to be resolved before I can consider it stable. -Some interesting features: - - SSL/TLS autodetection +Notable features: + - SSL/TLS autodetection (why doesn't everyone have this?) - IRCop authentication through SSL/TLS client certificates - - epoll support on Linux - - superfast build time, small memory footprint + - epoll support on Linux; it should be able to handle quite a number of users -degesch +ZyklonB ------- -To complete it all, I've also started working on an IRC client. I thought it -would be interesting to build an IRC client on top of libreadline. Also way -simpler than doing it in ncurses. +The IRC bot. It builds upon the concept of my other VitaminA IRC bot. The main +characteristic of these two bots is that they run plugins as coprocesses, which +allows for enhanced reliability and programming language freedom. + +While originally intended to be a simple C99 rewrite of the original bot, which +was written in the GNU dialect of AWK, it fairly quickly became a playground +where I added everything that seemed nice. + +Notable features: + - resilient against crashes, server disconnects and timeouts + - SOCKS support (even though socksify can add that easily to any program) Building -------- Build dependencies: CMake, pkg-config, help2man, awk, sh, liberty (included) -Runtime dependencies: openssl, ncursesw (degesch), readline (degesch) +Runtime dependencies: openssl, curses (degesch), readline (degesch) - $ git clone https://github.com/pjanouch/ZyklonB.git + $ git clone https://github.com/pjanouch/uirc3.git $ git submodule init $ git submodule update $ mkdir build @@ -50,7 +65,7 @@ To install the application, you can do either the usual: Or you can try telling CMake to make a package for you. For Debian it is: $ cpack -G DEB - # dpkg -i ZyklonB-*.deb + # dpkg -i uirc3-*.deb Note that for versions of CMake before 2.8.9, you need to prefix cpack with `fakeroot' or file ownership will end up wrong. @@ -83,7 +98,7 @@ And no, I'm not going to change the names. License ------- -`ZyklonB' is written by Přemysl Janouch <p.janouch@gmail.com>. +`uirc3' is written by Přemysl Janouch <p.janouch@gmail.com>. You may use the software under the terms of the ISC license, the text of which is included within the package, or, at your option, you may relicense the work |