https://github.com/errornointernet/termcanvas

Draw stuff in your terminal!
https://github.com/errornointernet/termcanvas

canvas cli drawing multiplayer paint terminal

Last synced: about 1 month ago
JSON representation

Draw stuff in your terminal!

• Host: GitHub
• URL: https://github.com/errornointernet/termcanvas
• Owner: ErrorNoInternet
• License: mit
• Created: 2022-07-29T05:56:28.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-27T07:11:38.000Z (over 1 year ago)
• Last Synced: 2025-04-03T13:21:19.349Z (6 months ago)
• Topics: canvas, cli, drawing, multiplayer, paint, terminal
• Language: Go
• Homepage:
• Size: 950 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# termcanvas

Draw stuff in your terminal!

![Screenshot0](https://raw.githubusercontent.com/ErrorNoInternet/termcanvas/main/screenshots/0.png)

![Screenshot1](https://raw.githubusercontent.com/ErrorNoInternet/termcanvas/main/screenshots/1.png)

## Features

 - Placing pixels

 - 16 different colors

 - Drawing filled squares

 - Drawing empty boxes

 - Displaying custom text

 - Saving & loading (CSV)

 - Multiplayer support

#### Colors

It's possible to use more than 16 colors, by modifying the color names saved in the CSV files to hex codes.

See [examples/hex-colors.csv](https://github.com/ErrorNoInternet/termcanvas/blob/main/examples/hex-colors.csv) for an example.

#### Multiplayer support

To host a termcanvas server, run `termcanvas -host`, which starts a server on port 55055 (you can change this with `termcanvas -host -port XXXXX`).

To connect to a termcanvas server, run `termcanvas -connect example.com` (or `termcanvas -connect example.com -port XXXXX` for a custom port).

The server host knows the IP addresses of whoever connects (clients can only see the server IP), and multiple clients can connect to the same server.

## Controls

`esc`: exit termcanvas\

`left click`: place a pixel (works with the Region tool, which draws a region)\

`right click`: remove a pixel (works with the Region tool, which removes a region)

## Compiling

### Requirements

 - Go 1.18 or higher recommended

```sh

git clone https://github.com/ErrorNoInternet/termcanvas

cd termcanvas

go build

```

If you would like to modify or use this repository (including its code) in your own project, please be sure to credit!