An open API service indexing awesome lists of open source software.

https://github.com/shou/chabunko

Websocket IRC bouncer and chat
https://github.com/shou/chabunko

Last synced: about 1 month ago
JSON representation

Websocket IRC bouncer and chat

Awesome Lists containing this project

README

          

Chabunko
========

A simple websocket based web chat with a planned IRC interface.

`Chasocketo.hs` is the websocket server.
`base.html` is the interface.
`Chabunko.hs` is the back-end spitting out the interface.

# Protocol

The websocket server itself can receive eight different types of commands.

## Protocol input

### Msg
"msg \ \" - "msg" followed by a space, a channel (no spaces),
another space, and then finally the contents of the message itself.

This sends a message to the server which then relays it to everyone except the
sender.

This can return a warning if the user is flooding/spamming.

### Set
"set \ \" - "set" followed by a space, then the key which cannot
contain any spaces, another space after that, and finally the data you want to
associate with the key.

This is a general way to store settings, however as an example, you can use it
to store users' avatar URLs.

### Join

### Part

### Opt
"opt \ \" - "opt" followed by a space, a channel (no spaces),
another space, and then they key which cannot contain any spaces.

Returns what has been set by every user for the specified key.

### Opts
"opts \"

Returns the keys of the stores options.

### Req

### List
"list \"

Returns the userlist for a channel.

### Ban

### End

## Protocol output