p
/
neetdraw
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Terminal drawing application with multiplayer support
78 Commits 1 Branch 0 Tags 224 KiB
C 90.6%
CMake 9.4%
Go to file
Přemysl Eric Janouch d9586b36bf
Alpine 3.19 Success Details
Arch Linux AUR Success Details
OpenBSD 7.3 Success Details
Bump dependencies 		2024-04-10 18:35:09 +02:00
cmake General project maintenance 2021-10-30 03:24:55 +02:00
liberty@8386af0420 Bump dependencies 2024-04-10 18:35:09 +02:00
termo@f9a102456f Bump dependencies 2024-04-10 18:35:09 +02:00
.clang-format Add clang-format configuration, clean up 2021-10-30 03:24:55 +02:00
.gitignore Rename the project 2021-11-16 11:52:54 +01:00
.gitmodules Bump liberty, termo 2018-06-24 06:11:21 +02:00
CMakeLists.txt CMakeLists.txt: declare compatibility with 3.27 2023-08-01 03:18:16 +02:00
LICENSE Allow passing drawings to open on the command line 2023-05-22 05:47:03 +02:00
README.adoc README.adoc: update package information 2023-07-01 21:59:31 +02:00
config.h.in Rename the project 2021-11-16 11:52:54 +01:00
neetdraw.c Allow passing drawings to open on the command line 2023-05-22 05:47:03 +02:00
neetdraw.png Rename the project 2021-11-16 11:52:54 +01:00

README.adoc

neetdraw

neetdraw is a terminal drawing application with multiplayer support.

neetdraw

Packages

Regular releases are sporadic. git master should be stable enough. You can get a package with the latest development version using Arch Linux’s AUR, or as a Nix derivation.

Building

Build dependencies: CMake, pkg-config, liberty (included), termo (included)
Runtime dependencies: ncursesw, libev

$ git clone --recursive https://git.janouch.name/p/neetdraw.git
$ mkdir neetdraw/build
$ cd neetdraw/build
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug
$ make

To install the application, you can do either the usual:

# make install

Or you can try telling CMake to make a package for you. For Debian it is:

$ cpack -G DEB
# dpkg -i neetdraw-*.deb

Usage

For standalone mode you can run the program without arguments:

$ neetdraw

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

$ neetdraw -s :1234

To connect to a running server, run:

$ neetdraw -c localhost:1234

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.

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.

Contributing and Support

Use https://git.janouch.name/p/neetdraw to report any bugs, request features, 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.

Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9

License

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.