sushi IRC suite

h1. sushi IRC suite

{{>toc}}

The sushi IRC suite consists of a central daemon and several clients, which communicate via DBus.

The daemon -- [[sushi-maki:|maki]] -- provides DBus methods and signals that abstract the IRC protocol to make it more pleasant to use.

Consequently, clients using this interface can focus on providing a good user experience instead of worrying about implementation details of the IRC protocol.

For example, this interface could also be used to easily write IRC bots in any language that supports DBus.

The suite currently provides a graphical client for GTK -- [[sushi-tekka:|tekka]] -- as well as one for the terminal -- [[sushi-nigiri:|nigiri]].

h1. Components

* [[sushi-maki:|maki]] IRC daemon (C, "GLib":http://www.gtk.org/)

* [[sushi-tekka:|tekka]] IRC client (Python, "GTK":http://www.pygtk.org//"GNOME":http://www.gnome.org/)

* [[sushi-nigiri:|nigiri]] IRC client (Python, "Urwid":http://excess.org/urwid/)

* [[sushi-chirashi:|chirashi]] IRC plugins (Python)

h1. Contact

You can find us on "freenode":irc://chat.freenode.net/ (chat.freenode.net) in "#sushi-irc":irc://chat.freenode.net/sushi-irc.

Also, feel free to ask questions and report bugs at http://redmine.ikkoku.de/.

h1. Downloads

h2. Stable Version

  * 1.4.0 (2012-01-15): "Source [xz]":/attachments/download/37/sushi-1.4.0.tar.xz, "Source [bz2]":/attachments/download/35/sushi-1.4.0.tar.bz2, "Source [gz]":/attachments/download/36/sushi-1.4.0.tar.gz, "Ubuntu":https://launchpad.net/~sushi/+archive/stable (10.10, 11.04, 11.10 and 12.04), "Arch Linux [AUR]":http://aur.archlinux.org/packages.php?ID=53008

The only platform working out-of-the-box is Linux.

Instructions for OpenSolaris and Mac OS X can be found in "documentation/os":http://redmine.ikkoku.de/projects/sushi-maki/repository/revisions/master/show/documentation/os.

h2. Development Version

The current development version is available in the following forms:

* Ubuntu packages: https://launchpad.net/~sushi/+archive/development (Packages are provided for Ubuntu 10.10, 11.04, 11.10 and 12.04.)

* Web interface: http://redmine.ikkoku.de/projects

* Git repositories: @http://redmine.ikkoku.de/git/{sushi,sushi-maki,sushi-tekka,sushi-nigiri,sushi-chirashi}@

h1. Development

* You can translate sushi at https://translations.launchpad.net/sushi.

* Some nice source code statstics are located at https://www.ohloh.net/projects/sushi.

* Useful information for client developers can be found in "documentation/clients":http://redmine.ikkoku.de/projects/sushi-maki/repository/revisions/master/show/documentation/clients.