1j01/textual-paint

Fork 0

mirror of https://github.com/1j01/textual-paint.git synced 2024-09-11 15:56:03 +03:00

Isaiah Odhner 61227597f8 Fix flood fill infinite loop when color under cursor matches fill color

2023-04-24 22:18:48 -04:00

8.7 KiB

Raw Blame History

Textual Paint

MS Paint in your terminal.

This is a TUI (Text User Interface) image editor, inspired by MS Paint, built with Textual.

This screenshot of Textual Paint is the terminal's screen buffer copied as HTML, wrapped in SVG, placed in HTML inside Markdown.
This might not render correctly in your browser.

Features

Open and save images
- Fancy file dialogs
- Warnings when overwriting an existing file, or closing with unsaved changes
- File formats:
  - PNG (.png)
  - Bitmap (.bmp)
  - ANSI (.ans) - Note that while it can load the files that it saves, you may have limited success loading other ANSI files that you find. ANSI files can vary a lot and even encode animations!
Tools
- Free-Form Select
- Select
- Eraser
  - Color Eraser
- Fill With Color
- Pick Color
- Magnifier
- Pencil
- Brush
- Airbrush
- Text
- Line
- Curve
- Rectangle
- Polygon
- Ellipse
- Rounded Rectangle
Color palette
Undo/Redo
Efficient screen updates and undo/redo history, by tracking regions affected by each action
- You could totally use this program over SSH! Haha, this "what if" project could actually be useful. Of course, it should be mentioned that you can also run graphical programs over SSH, but this might be more responsive, or just fit your vibe better.
Brush previews
Menu bar
Status bar
Keyboard shortcuts
Localization into 26 languages: Arabic, Czech, Danish, German, Greek, English, Spanish, Finnish, French, Hebrew, Hungarian, Italian, Japanese, Korean, Dutch, Norwegian, Polish, Portuguese, Brazilian Portuguese, Russian, Slovak, Slovenian, Swedish, Turkish, Chinese, Simplified Chinese

Usage

Command Line Options

$ python3 paint.py --help
usage: paint.py [-h] [--theme {light,dark}] [--language {ar,cs,da,de,el,en,es,fi,fr,he,hu,it,ja,ko,nl,no,pl,pt,pt-br,ru,sk,sl,sv,tr,zh,zh-simplified}] [--ascii-only-icons]
                [--inspect-layout] [--clear-screen] [--restart-on-changes]
                [filename]

Paint in the terminal.

positional arguments:
  filename              File to open

options:
  -h, --help            show this help message and exit
  --theme {light,dark}  Theme to use, either "light" or "dark"
  --language {ar,cs,da,de,el,en,es,fi,fr,he,hu,it,ja,ko,nl,no,pl,pt,pt-br,ru,sk,sl,sv,tr,zh,zh-simplified}
                        Language to use
  --ascii-only-icons    Use only ASCII characters for tool icons
  --inspect-layout      Inspect the layout with middle click, for development
  --clear-screen        Clear the screen before starting; useful for development, to avoid seeing fixed errors
  --restart-on-changes  Restart the app when the source code is changed, for development

Keyboard Shortcuts

Ctrl+D: Toggle Dark Mode
Ctrl+Q: Quit
Ctrl+Shift+S: Save As IF SHIFT IS DETECTED — might trigger Save instead, and overwrite the open file! ⚠️
Ctrl+Shift+Z: Redo IF SHIFT IS DETECTED — might trigger Undo instead.

The rest match MS Paint's keyboard shortcuts:

Ctrl+S: Save
Ctrl+O: Open
Ctrl+N: New
Ctrl+T: Toggle Tools Box
Ctrl+W: Toggle Colors Box
Ctrl+Z: Undo
Ctrl+Y: Redo
F4: Redo
Ctrl+A: Select All
Ctrl+PageUp: Large Size
Ctrl+PageDown: Normal Size

Known Issues

Pressing Delete while using the Text tool deletes the whole text box. Similarly, Ctrl+A selects the canvas instead of the text in the text box.
The Curve and Polygon tool previews disappear when you're not hovering over the canvas.
Pick Color can't be cancelled with Escape or by pressing both mouse buttons.
Help > Help Topics isn't very helpful.
The selection can't be dragged from the top left corner.
Due to limitations of the terminal, shortcuts using Shift or Alt might not work.
Menus are not keyboard navigable.
Clicking the Zoom submenu doesn't always work. You just have to click it a few times before it opens. (It may be technically open but positioned off screen, or lacking width/height. I don't know.)
Some languages don't display correctly.
Large files can make the program very slow.
The program sometimes crashes or freezes randomly.

Development

Install Textual and other dependencies:

pip install "textual[dev]" stransi psutil pyright

Run via Textual's CLI for live-reloading CSS support, and enable other development features:

textual run --dev "paint.py --clear-screen --inspect-layout --restart-on-changes"

Or run more basically:

python paint.py

--clear-screen is useful for development, because it's sometimes jarring to see error messages that have actually been fixed, when exiting the program.

--inspect-layout lets you middle click to visualize the layout breakdown by labeling each widget in the hierarchy, and coloring their regions. The labels affect the layout, so you can also hold Ctrl to only colorize, and you can remember how the colors correspond to the labels.

--restart-on-changes automatically restarts the program when any Python files change. This works by the program restarting itself directly. (Programs like modd or nodemon that run your program in a subprocess don't work well with Textual's escape sequences.)

There are also launch tasks configured for VS Code, so you can run the program from the Run and Debug panel. Note that it runs slower in VS Code's debugger.

To see logs, run textual console and then run the program via textual run --dev. This also makes it run slower.

Update Dependencies

python -m pipreqs.pipreqs --ignore .history --force

License

MIT

Unicode Symbols and Emojis for Paint Tools

The first thing I did in this project was to collect possible characters to represent all the tool icons in MS Paint, to gauge how good of a recreation it would be possible to achieve, starting from looks. Unfortunately, I haven't run into any significant roadblocks, so I'm apparently recreating MS Paint. Again.

These are the symbols I've found so far:

Free-Form Select: ✂️📐🆓🕸✨⚝🫥🇫/🇸◌⁛⁘ ⢼⠮
Select: ⬚▧🔲 ⣏⣹
Eraser/Color Eraser: 🧼🧽🧹🚫👋🗑️▰▱
Fill With Color: 🌊💦💧🌈🎉🎊🪣🫗
Pick Color: 🎨💉💅💧📌📍⤤𝀃🝯🍶
Magnifier: 🔍🔎👀🔬🔭🧐🕵️‍♂️🕵️‍♀️
Pencil: ✏️✎✍️🖎🖊️🖋️✒️🖆📝🖍️
Brush: 🖌️🖌👨‍🎨🧑‍🎨💅
Airbrush: 💨ᖜ╔🧴🥤🫠
Text: 🆎📝📄📃🔤📜AＡ
Line: 📏📉📈⟍𝈏╲⧹\⧵∖
Curve: ↪️🪝🌙〰️◡◠~∼≈∽∿〜〰﹋﹏≈≋～⁓
Rectangle: ▭▬▮▯🟥🟧🟨🟩🟦🟪🟫⬛⬜◼️◻️◾◽▪️▫️
Polygon: ▙𝗟𝙇﹄』⬣⬟🔶🔷🔸🔹🔺🔻△▲
Ellipse: ⬭⭕🔴🟠🟡🟢🔵🟣🟤⚫⚪🫧
Rounded Rectangle: ▢⬜⬛

The default symbols used may not be the best on your particular system, so I may add some kind of configuration for this in the future.

Cursor

A crosshair cursor could use one of +✜✛✚╋╬, but whilst that imitates the look, it might be better to show the pixel under the cursor, i.e. character cell, surrounded by dashes, like this:

 ╻
╺█╸
 ╹

8.7 KiB Raw Blame History Unescape Escape