Skip to main content

CLI tool for drawing pixel art in the terminal with keyboard (WASD) controls.

Project description

term-paint

Description

This is a CLI tool for drawing images in your terminal with keyboard controls. For wide compatibility, only 8 terminal colors are used - an image that uses different colors will round them to the nearest supported color when loaded and saved.

Usage

  • E to toggle drawing mode (X in infobar means drawing is disabled; % in infobar means it is enabled)
  • W,A,S,D to move around the image
  • 1...7 for switching colors (indicated on the left of the infobar)
  • 0 to switch to black (default fill color)
  • B to show a view of the image in your default image viewer
  • X to save the image under the filename provided (nameless files are saved as unnamed.png)
  • Q to exit the program without saving any changes

CLI options

  • -n NAME/--filename NAME: provides a filename to save or load the image
  • -l/--load: try to load the specified image (fails if the name was not provided or the image doesn't exist)
  • -x/--width: specify the width in pixels when creating a new image (default 88)
  • -y/--height: specify the height in pixels when creating a new image (default 31 for 88x31 images)
  • -p/--pos: display cursor position in infobar (recommended)
  • -c/--change-color: tries to use the brighter versions of terminal colors (visible colors are dependent on your theme)

Installation

From PyPI:

  • pip install term-paint or pipx install term-paint or uvx install term-paint
  • term-paint [OPTIONS]

From wheel files:

  • Download the wheel files from the release and place them into a new directory
  • uv install .
  • term-paint [OPTIONS]

From the repo:

  • git clone https://github.com/strawberry-p/term-paint.git
  • cd term-paint
  • py paint.py [OPTIONS]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

term_paint-1.0.1.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

term_paint-1.0.1-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file term_paint-1.0.1.tar.gz.

File metadata

  • Download URL: term_paint-1.0.1.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.22

File hashes

Hashes for term_paint-1.0.1.tar.gz
Algorithm Hash digest
SHA256 6e98f10ace25cae608f594568db512e2ad175a7f8b24929b0ef5c88c58a62ce9
MD5 c23a4f7cad6a6f49b8f712b950df1819
BLAKE2b-256 8cec94f7573026432418f48fbbbdd8a8ab4a6be492f3cf8d774d4ad231a9b8c0

See more details on using hashes here.

File details

Details for the file term_paint-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: term_paint-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.22

File hashes

Hashes for term_paint-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 727c6797e1fd3478a21a9b1b57e51e4ff9edf2ab35b1e7a29043e6679c2d7595
MD5 e5b79020b9e6c5be240329d906f8fea0
BLAKE2b-256 791c6d0676afa7cdcae9d57515153532d4b8e25df7e1c2fa08e2277566a19b00

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page