NetCanv
A lightweight app for painting with other people over the Internet, in real time.
A screenshot of my imaginary friend and I painting things together using NetCanv.
- Lightweight. The whole app fits in about 10 MB, and unlike web apps, you only ever have to download a specific version once.
- Fast. NetCanv uses a fully hardware-accelerated canvas to deliver you the smoothest drawing experience possible. Additionally, the network protocol is really simple, which makes NetCanv run well even on the slowest connections.
- Decentralized. Even if one server goes down, you could find another one, or set one up on your own.
- Free. NetCanv is and will always be free to use, by anyone, for any purpose. It's licensed under the GNU General Public License 3, which means that all of NetCanv's derivatives must remain free, as well.
- Open source. You can be a part of NetCanv's development! If you have a feature you'd like to see added, or you think you've found a bug, head over to the Issues tab. If you know how to code, feel free to send in Pull Requests!
- Made with
💙 by a high school student with too much time on his hands.
Compiling
Should be as simple as:
$ cargo build --release
# or, if you just want to run the app:
$ cargo run --releaseNOTE: The "Open source licenses" icon will not show up in the lobby screen unless you have cargo-about installed. To install it, use:
$ cargo install cargo-aboutFeatures
Alternate rendering backends can be chosen by passing in features via the --features flag.
renderer-opengl(default) – The OpenGL rendering backend. May be incomplete or buggy in some places on certain drivers, please file issue reports if you find bugs!
Right now this is the only backend available. Do note that PRs implementing alternate backends will not be merged, because the rendering API is still in flux and may change at any time. More backends may be added after 1.0 is released.
Skia backend
There used to be a Skia backend, but it was removed because it was an unsupported, unnecessary maintenance burden. The last tag to feature this backend is 0.5.0.
Relay
NetCanv will connect to the official relay, hosted at https://netcanv.org, by default. However, if you want to host your own relay for whatever reason, it's quite simple to do.
To run the relay server, simply do:
$ cargo run -p netcanv-relayThis will allow you to host and join new rooms locally.
NetCanv's CI also provides builds of the relay for x86_64 and aarch64, so that you can set it up on a VPS, a Raspberry Pi, or a regular ol' computer. The relay is very lightweight and doesn't require much compute power, so your main limit is Internet bandwidth.
Nginx
If you have nginx running on your server, you can create a reverse proxy to the relay by adding
this to your server {} block:
location /relay {
proxy_pass http://localhost:62137;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
}It's also highly recommended to use a tool like certbot to enable
support for encryption. NetCanv assumes that servers support encryption by default, by prepending
wss:// to the URL in the relay server text field if another scheme isn't already present.
"Tutorial"
NetCanv was originally made as part of a YouTube "tutorial" series.
The series is in Polish (!) and can be found on YouTube.
Individual episodes:
- Introduction
- Drawing and GUI
- Refactoring and ∞
- Networking – coming soon (never)
Again, note that the tutorials are in Polish.
Purpose
The main purpose of this tutorial series is to show how to build a desktop app using Rust and Skia, together with peer-to-peer communication for realtime collaboration.
I generally don't like explaining every small detail in my videos. I'd rather showcase the cool and interesting parts about the development process. So don't consider this as a general Rust application development tutorial – treat it more like a devlog with some educational, comedic, and artistic value sprinkled over it.