Terminal drawing application with multiplayer support
Go to file
Přemysl Eric Janouch 0d871dec86 Update README.rst
Add a screenshot.
2015-02-09 09:02:12 +01:00
cmake Rewrite to use libev 2014-10-28 02:39:37 +01:00
termo@af193ef483 Update termo 2014-11-30 00:40:40 +01:00
.gitignore Initial commit 2014-10-22 23:58:25 +02:00
.gitmodules Initial commit 2014-10-22 23:58:25 +02:00
.travis.yml Add Travis CI configuration 2015-02-08 05:50:20 +01:00
CMakeLists.txt Little fixes 2015-02-08 02:31:13 +01:00
LICENSE Initial commit 2014-10-22 23:58:25 +02:00
README.rst Update README.rst 2015-02-09 09:02:12 +01:00
autistdraw.c Add an option to expect all client drawing to succeed 2015-02-08 02:33:02 +01:00
config.h.in Rewrite to use libuv 2014-10-24 23:01:57 +02:00
utils.c Rewrite to use libev 2014-10-28 02:39:37 +01:00

README.rst

autistdraw
==========

`autistdraw` is a terminal drawing application with multiplayer support.

.. image:: http://www.image-share.com/upload/2848/201.png

Building and Running
--------------------
Build dependencies: CMake, pkg-config, ncursesw, libev, termo (included)::

 $ git clone https://github.com/pjanouch/autistdraw.git
 $ git submodule init
 $ git submodule update
 $ mkdir build
 $ cd build
 $ cmake .. -DCMAKE_BUILD_TYPE=Debug
 $ make

Now, for standalone mode you can run::

 $ ./autistdraw

To run as a server for other clients to connect to and draw simultaneously::

 $ ./autistdraw -s :1234

Finally, to connect to a running server, run::

 $ ./autistdraw -c localhost:1234

Usage
-----
Simply select a colour you like from the palette and draw by clicking and
dragging the mouse.  Use the middle mouse button to move the canvas.

Known Issues
------------
VTE-based terminals, such as gnome-terminal, are terminally broken and you will
experience drawing artefacts.  Those are neither a problem of this application,
nor a problem of ncurses as far as I can tell.

To achieve the best results, please use a decent terminal such as rxvt-unicode
or xterm.  These two are feature-full and **fast**.  st also works great.

Even so, try not to strain the application too much.  It can and will break if
you flood the communication channel with the terminal.

License
-------
`autistdraw` 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
under the MIT or the Modified BSD License, as listed at the following site:

http://www.gnu.org/licenses/license-list.html