zing-art 1.0.1

A TUI for physical string art placement. It takes a sequence, you pull the thread. ZING: Zing Is Not Generating.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

# ZING

![Zing Interface](assets/interface.png)

## What is this?

Zing is a TUI (Text User Interface) designed for the execution phase of string art.

The name comes from two places:

1. The acronym: **Zing Is Not Generating**.
2. The sound a thread makes when it snaps `/zing/`.

It does not calculate algorithms. It does not turn photographs into nail patterns. It simply holds the map while you drive.

<img src="assets/example.png" alt="String Art Example" width="400">

## Why use it?

When you are doing string art, your hands and your mind are busy. You cannot be struggling with a complex GUI.

Zing takes a comma-separated sequence of numbers (the nail numbers) and displays them one by one on a terminal using big, readable text.

It also previews the previous and next steps so you can maintain flow.

## Installation

You can install Zing using pre-built binaries or compile it from source.

### Automated Install (Recommended)

#### Linux & macOS

Run the following in your terminal to download and install the latest release

```bash
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/000Volk000/zing/releases/latest/download/zing-art-installer.sh | sh
```

#### Windows

Run this in PowerShell

```PowerShell
irm https://github.com/000Volk000/zing/releases/latest/download/zing-art-installer.ps1 | iex
```

### Package Managers

#### Homebrew

```bash
brew install 000Volk000/zing/zing-art
```

### From Source

If you have [Rust](https://rust-lang.org/) installed, you can get it directly from [crates.io](https://crates.io/):

```bash
cargo install zing-art
```

Or build it from the repository:

```bash
git clone https://github.com/000Volk000/zing.git
cd zing
cargo install --path .
```

## Usage

Feed it a sequence.

You can feed it any plain text file. The extension does not matter, but the structure does.

```bash
zing-art pattern.txt
```

### Important Data Rules

1. **Single Line Input:** Your sequence of numbers must be entirely on the **first line** (separated by commas) of the file.
2. **File Modification:** Zing will write to the **second line** to save your current progress.

### Example file

```plaintext
0,105,238,104,239,106,197,99,194,54,167,47,166,46,165,45,164
```

## Controls

- `SPACE` / `RIGHT` : Next step.
- `BACKSPACE` / `LEFT` : Go back.
- `s` : Save current position.
- `q` / `ESCAPE` : Quit.

> [!IMPORTANT]
> Zing attempts to auto-save your progress when you quit.<br>If saving fails, it will warn you before closing.

## The Philosophy

Generators are for planning. Zing is for making.

The software stays out of your way. No distractions. Just the number you need to hit next.

## License

Created under the MIT License. See [LICENSE](https://github.com/000Volk000/zing/blob/main/LICENSE) for more information.

Created by [Darío Martínez Kostyuk](https://linktree.volkhost.es/) - 2025