browser one-page terminal app using xterm.js and socket.io
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Robey c30145753e mention size 3 months ago
public it works! it's tiny! 3 months ago
src it works! it's tiny! 3 months ago
.gitignore it works! it's tiny! 3 months ago
LICENSE.txt it works! it's tiny! 3 months ago
README.md mention size 3 months ago
package-lock.json it works! it's tiny! 3 months ago
package.json it works! it's tiny! 3 months ago
tsconfig.json it works! it's tiny! 3 months ago
webpack.config.js it works! it's tiny! 3 months ago

README.md

Canko

Canko is a small static website that bundles xterm.js and socket.io into a full-window terminal that connects to zdani, or anything that speaks a similar socket.io protocol. It assumes you have set up a proxy-pass on your website that forwards /socket.io to your mud server.

The webpacked javascript is over 300KB, but only 3KB of that is canko itself. The rest is xterm and socket.io.

"Canko" is the lojban word for "window".

Socket.io protocol

To send and receive text for the terminal:

  • data(text: string)

To tell the mud server about your terminal's size:

  • resize(cols: number, rows: number)

Authors

License

Apache 2.0 license, included in LICENSE.txt.