2021-11-16 11:50:48 +01:00
|
|
|
neetdraw
|
|
|
|
========
|
2014-10-22 23:58:25 +02:00
|
|
|
|
2021-11-16 11:50:48 +01:00
|
|
|
'neetdraw' is a terminal drawing application with multiplayer support.
|
2014-10-22 23:58:25 +02:00
|
|
|
|
2021-11-16 11:50:48 +01:00
|
|
|
image::neetdraw.png[align="center"]
|
2015-02-09 09:02:12 +01:00
|
|
|
|
2016-03-14 21:11:01 +01:00
|
|
|
Packages
|
|
|
|
--------
|
2023-07-01 21:59:31 +02:00
|
|
|
Regular releases are sporadic. git master should be stable enough.
|
|
|
|
You can get a package with the latest development version using Arch Linux's
|
|
|
|
https://aur.archlinux.org/packages/neetdraw-git[AUR],
|
|
|
|
or as a https://git.janouch.name/p/nixexprs[Nix derivation].
|
2016-03-14 21:11:01 +01:00
|
|
|
|
|
|
|
Building
|
|
|
|
--------
|
2015-09-27 02:08:32 +02:00
|
|
|
Build dependencies: CMake, pkg-config, liberty (included), termo (included) +
|
|
|
|
Runtime dependencies: ncursesw, libev
|
2015-02-28 21:49:28 +01:00
|
|
|
|
2021-11-16 11:50:48 +01:00
|
|
|
$ git clone --recursive https://git.janouch.name/p/neetdraw.git
|
|
|
|
$ mkdir neetdraw/build
|
|
|
|
$ cd neetdraw/build
|
2015-02-28 21:33:08 +01:00
|
|
|
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug
|
2014-10-22 23:58:25 +02:00
|
|
|
$ make
|
2014-10-27 15:48:57 +01:00
|
|
|
|
2016-03-14 21:11:01 +01:00
|
|
|
To install the application, you can do either the usual:
|
2014-10-28 03:17:39 +01:00
|
|
|
|
2016-03-14 21:11:01 +01:00
|
|
|
# make install
|
2014-10-28 03:17:39 +01:00
|
|
|
|
2016-03-14 21:11:01 +01:00
|
|
|
Or you can try telling CMake to make a package for you. For Debian it is:
|
2014-10-27 15:48:57 +01:00
|
|
|
|
2016-03-14 21:11:01 +01:00
|
|
|
$ cpack -G DEB
|
2021-11-16 11:50:48 +01:00
|
|
|
# dpkg -i neetdraw-*.deb
|
2014-10-28 03:17:39 +01:00
|
|
|
|
2014-10-27 15:48:57 +01:00
|
|
|
Usage
|
|
|
|
-----
|
2016-03-14 21:11:01 +01:00
|
|
|
For standalone mode you can run the program without arguments:
|
|
|
|
|
2021-11-16 11:50:48 +01:00
|
|
|
$ neetdraw
|
2016-03-14 21:11:01 +01:00
|
|
|
|
|
|
|
To run as a server for other clients to connect to and draw simultaneously:
|
|
|
|
|
2021-11-16 11:50:48 +01:00
|
|
|
$ neetdraw -s :1234
|
2016-03-14 21:11:01 +01:00
|
|
|
|
|
|
|
To connect to a running server, run:
|
|
|
|
|
2021-11-16 11:50:48 +01:00
|
|
|
$ neetdraw -c localhost:1234
|
2016-03-14 21:11:01 +01:00
|
|
|
|
|
|
|
Once you have the program running, simply select a colour you like from the
|
|
|
|
palette and draw by pressing and dragging the mouse. Use the middle mouse
|
|
|
|
button to move the canvas.
|
|
|
|
|
|
|
|
You can store the current image to `drawing.bin` and load it back using the
|
|
|
|
's' and 'l' keys respectively. To just export the current picture for printing
|
|
|
|
it on a terminal, press 'e'. To export for IRC, press 'E'.
|
2014-10-27 15:48:57 +01:00
|
|
|
|
2014-10-24 23:01:11 +02:00
|
|
|
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
|
2015-09-27 02:08:32 +02:00
|
|
|
or xterm. These two are feature-full and *fast*. st also works great.
|
2014-10-24 23:01:11 +02:00
|
|
|
|
|
|
|
Even so, try not to strain the application too much. It can and will break if
|
|
|
|
you flood the communication channel with the terminal.
|
|
|
|
|
2016-03-14 21:11:01 +01:00
|
|
|
Contributing and Support
|
|
|
|
------------------------
|
2021-11-16 11:50:48 +01:00
|
|
|
Use https://git.janouch.name/p/neetdraw to report any bugs, request features,
|
2018-06-24 02:59:54 +02:00
|
|
|
or submit pull requests. `git send-email` is tolerated. If you want to discuss
|
|
|
|
the project, feel free to join me at ircs://irc.janouch.name, channel #dev.
|
2016-03-14 21:11:01 +01:00
|
|
|
|
2018-06-24 02:59:54 +02:00
|
|
|
Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9
|
2017-06-07 21:38:13 +02:00
|
|
|
|
2014-10-22 23:58:25 +02:00
|
|
|
License
|
|
|
|
-------
|
2018-06-24 02:58:23 +02:00
|
|
|
This software is released under the terms of the 0BSD license, the text of which
|
|
|
|
is included within the package along with the list of authors.
|