shaperunner 10.3__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: shaperunner
|
|
3
|
+
Version: 10.3
|
|
4
|
+
Summary: Rotating 3D wireframes drawn as ASCII art, in their own window or in the terminal
|
|
5
|
+
Project-URL: Homepage, https://github.com/wolfybird/shaperunner
|
|
6
|
+
Project-URL: Issues, https://github.com/wolfybird/shaperunner/issues
|
|
7
|
+
Author: RFrank
|
|
8
|
+
License-Expression: GPL-3.0-or-later
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Keywords: 3d,ascii,ascii-art,audio-reactive,terminal,visualizer,wireframe
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Environment :: Console
|
|
13
|
+
Classifier: Intended Audience :: End Users/Desktop
|
|
14
|
+
Classifier: Operating System :: OS Independent
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Topic :: Artistic Software
|
|
17
|
+
Classifier: Topic :: Multimedia :: Graphics
|
|
18
|
+
Requires-Python: >=3.10
|
|
19
|
+
Requires-Dist: numpy
|
|
20
|
+
Requires-Dist: pygame-ce
|
|
21
|
+
Requires-Dist: sounddevice
|
|
22
|
+
Description-Content-Type: text/markdown
|
|
23
|
+
|
|
24
|
+
# ShapeRunner
|
|
25
|
+
|
|
26
|
+
Rotating 3D wireframes drawn as ASCII art, with a z-buffer, depth-based
|
|
27
|
+
color palettes and optional audio reactivity (onset and BPM detection from
|
|
28
|
+
any input device). It opens in its own window on Windows, macOS and Linux,
|
|
29
|
+
or runs in a terminal. CPU only: Python and NumPy.
|
|
30
|
+
|
|
31
|
+
## Get it
|
|
32
|
+
|
|
33
|
+
### With pip
|
|
34
|
+
|
|
35
|
+
With Python 3.10 or newer:
|
|
36
|
+
|
|
37
|
+
pip install shaperunner
|
|
38
|
+
shaperunner # in its own window
|
|
39
|
+
shaperunner --terminal # in this terminal
|
|
40
|
+
|
|
41
|
+
`pip install --upgrade shaperunner` updates it. If pip refuses because the
|
|
42
|
+
environment is "externally managed" (Homebrew Python on macOS, recent
|
|
43
|
+
Ubuntu and Debian), use [pipx](https://pipx.pypa.io) instead:
|
|
44
|
+
`pipx install shaperunner`. On Linux, audio mode also needs PortAudio
|
|
45
|
+
(`sudo apt install libportaudio2`).
|
|
46
|
+
|
|
47
|
+
### Ready-made apps
|
|
48
|
+
|
|
49
|
+
No Python needed. GitHub Actions builds the apps (see [Build](#build)).
|
|
50
|
+
Open the latest run on the [Build apps](https://github.com/wolfybird/shaperunner/actions/workflows/build.yml)
|
|
51
|
+
page and download the file for your system (downloads need a free GitHub
|
|
52
|
+
account):
|
|
53
|
+
|
|
54
|
+
| System | File | Start it |
|
|
55
|
+
|---|---|---|
|
|
56
|
+
| Windows | `ShapeRunner-windows.zip` | Unzip, then double-click `ShapeRunner.exe`. `ShapeRunner-terminal.exe` is the terminal version. |
|
|
57
|
+
| macOS (Apple silicon) | `ShapeRunner-macos.zip` | Unzip and move `ShapeRunner.app` to Applications. |
|
|
58
|
+
| Linux | `ShapeRunner-linux.tar.gz` | `tar xzf ShapeRunner-linux.tar.gz`, then run `ShapeRunner/ShapeRunner` (add `--terminal` for the terminal version). |
|
|
59
|
+
|
|
60
|
+
The apps aren't signed, so the first launch shows a warning:
|
|
61
|
+
|
|
62
|
+
- **Windows:** on "Windows protected your PC", click **More info**, then **Run anyway**.
|
|
63
|
+
- **macOS:** right-click the app, choose **Open**, then **Open** again.
|
|
64
|
+
Audio mode asks for microphone access the first time.
|
|
65
|
+
|
|
66
|
+
### Terminal version, set up for you
|
|
67
|
+
|
|
68
|
+
The installer sets up everything the terminal version needs. It puts the
|
|
69
|
+
packages in a private `.venv` folder, so the rest of your system is left
|
|
70
|
+
alone.
|
|
71
|
+
|
|
72
|
+
1. Download this project (green **Code** button, then **Download ZIP**) and unzip it.
|
|
73
|
+
2. Run the installer for your system:
|
|
74
|
+
- **Windows:** double-click `install_windows.bat`.
|
|
75
|
+
- **macOS:** double-click `install_mac.command`. If macOS blocks it, right-click it, choose **Open**, then **Open**.
|
|
76
|
+
- **Linux:** in a terminal in the project folder, run `./install_linux.sh`.
|
|
77
|
+
3. Start the program with the launcher the installer makes in the same
|
|
78
|
+
folder: `Run ShapeRunner.bat` on Windows,
|
|
79
|
+
`Run ShapeRunner.command` on macOS, `./run_shaperunner.sh` on Linux.
|
|
80
|
+
|
|
81
|
+
If Python is missing, the installer explains how to get it. Running it
|
|
82
|
+
again updates the packages. To remove it, delete the `.venv` folder and the
|
|
83
|
+
launcher.
|
|
84
|
+
|
|
85
|
+
### From source
|
|
86
|
+
|
|
87
|
+
pip install -r requirements.txt
|
|
88
|
+
python shapes_v10-3.py # in its own window
|
|
89
|
+
python shapes_v10-3.py --terminal # in this terminal
|
|
90
|
+
|
|
91
|
+
`pygame-ce` gives the window (plain `pygame` works too, but has no
|
|
92
|
+
installs for Python 3.14 and newer); without it the program runs in the
|
|
93
|
+
terminal.
|
|
94
|
+
`sounddevice` is optional and needs PortAudio, which Linux may need
|
|
95
|
+
installed (`sudo apt install libportaudio2`). The terminal version needs
|
|
96
|
+
256-color ANSI support (Windows Terminal, macOS Terminal, iTerm2, most
|
|
97
|
+
Linux terminals).
|
|
98
|
+
|
|
99
|
+
## Mouse and keys
|
|
100
|
+
|
|
101
|
+
In the window, the button bar along the bottom does the most common things,
|
|
102
|
+
**Menu** has every setting, and **Settings** opens a panel with sliders and
|
|
103
|
+
dropdowns.
|
|
104
|
+
|
|
105
|
+
| Mouse (window) | Action |
|
|
106
|
+
|---|---|
|
|
107
|
+
| Left-drag | rotate |
|
|
108
|
+
| Right-drag | spin |
|
|
109
|
+
| Wheel | zoom (over a menu setting: change it) |
|
|
110
|
+
| Middle-click | reset rotation |
|
|
111
|
+
|
|
112
|
+
| Key | Action |
|
|
113
|
+
|---|---|
|
|
114
|
+
| Space | pause |
|
|
115
|
+
| Arrows, `<` `>` or `,` `.` | rotate X/Y, Z |
|
|
116
|
+
| `o` / `r` | auto-rotate on/off / reset rotation |
|
|
117
|
+
| `+` `-` | scale |
|
|
118
|
+
| `f` `F` | field of view |
|
|
119
|
+
| `[` `]` | rotation speed |
|
|
120
|
+
| `d` `D` | density |
|
|
121
|
+
| `p` | wireframe / points |
|
|
122
|
+
| `c` / `C` / `i` | color mode / depth palette / invert depth |
|
|
123
|
+
| Shift+`0`-`9` | fixed color in shape color mode |
|
|
124
|
+
| `b` / `B` | brightness shading on/off / next character ramp |
|
|
125
|
+
| `z` `Z` | depth range |
|
|
126
|
+
| `s` `S` | auto-switch interval |
|
|
127
|
+
| `a` / `A` | audio on/off / input device |
|
|
128
|
+
| `n` `N` | audio sensitivity |
|
|
129
|
+
| `g` | what audio onsets trigger |
|
|
130
|
+
| `t` | adaptive density to hold the frame rate |
|
|
131
|
+
| `R` | resolution |
|
|
132
|
+
| `h` | HUD on/off |
|
|
133
|
+
| `m` | menu |
|
|
134
|
+
| `P` | settings panel |
|
|
135
|
+
| `?` or F1 | help |
|
|
136
|
+
| F11 or Alt+Enter | fullscreen (window); Esc leaves it |
|
|
137
|
+
| `q` | quit |
|
|
138
|
+
|
|
139
|
+
Settings are remembered between runs. They are stored, with a `crash.log`
|
|
140
|
+
if something goes wrong, in `%APPDATA%\ShapeRunner` on Windows,
|
|
141
|
+
`~/Library/Application Support/ShapeRunner` on macOS and
|
|
142
|
+
`~/.config/shaperunner` on Linux. **Menu → Reset all settings** goes back
|
|
143
|
+
to the defaults.
|
|
144
|
+
|
|
145
|
+
## Shapes
|
|
146
|
+
|
|
147
|
+
| Key | Shapes (press again to cycle) |
|
|
148
|
+
|---|---|
|
|
149
|
+
| `1` | Cube, Octahedron |
|
|
150
|
+
| `2` | Pyramid, Cone |
|
|
151
|
+
| `3` | Sphere, Icosahedron |
|
|
152
|
+
| `4` | Hexagon, Octagon, Star |
|
|
153
|
+
| `5` | Cylinder, Helix |
|
|
154
|
+
| `6` | Torus, Torus Knot |
|
|
155
|
+
| `7` | Mobius Strip, Trefoil Knot |
|
|
156
|
+
| `8` | Klein 1 (bottle), Klein 2 (figure-8) |
|
|
157
|
+
| `9` | Lorenz attractor |
|
|
158
|
+
| `0` | Mandelbrot, Julia (height fields) |
|
|
159
|
+
|
|
160
|
+
## Versions
|
|
161
|
+
|
|
162
|
+
`shapes_v10-3.py` is the current version, a single self-contained file.
|
|
163
|
+
Each version is developed as a new numbered copy; older ones are kept
|
|
164
|
+
outside the repo (they are still in the git history).
|
|
165
|
+
|
|
166
|
+
Up to v10 the project was called ASCII 3D Shapes. Settings saved under that
|
|
167
|
+
name (in an `ASCII3DShapes` folder) are picked up the first time a newer
|
|
168
|
+
version runs.
|
|
169
|
+
|
|
170
|
+
## Build
|
|
171
|
+
|
|
172
|
+
PyInstaller can only build for the system it runs on. On each system, run
|
|
173
|
+
|
|
174
|
+
pyinstaller ShapeRunner.spec
|
|
175
|
+
|
|
176
|
+
or `./build_mac.sh` on a Mac. The result is in `dist/`: a folder with
|
|
177
|
+
`ShapeRunner.exe` and `ShapeRunner-terminal.exe` on Windows,
|
|
178
|
+
`ShapeRunner.app` on macOS, and a `ShapeRunner` folder on Linux.
|
|
179
|
+
|
|
180
|
+
GitHub Actions builds all three and test-starts each one whenever a version
|
|
181
|
+
tag is pushed (`git tag v10.3 && git push origin v10.3`), or when **Build
|
|
182
|
+
apps** is run by hand from the Actions tab. It also tests the installer on
|
|
183
|
+
each system.
|
|
184
|
+
|
|
185
|
+
The spec builds the version named in its `SCRIPT` line, so update that line
|
|
186
|
+
when a newer version should ship. `pyproject.toml` names it too, for the pip
|
|
187
|
+
package, which **Publish to PyPI** on the Actions tab uploads when run by
|
|
188
|
+
hand.
|
|
189
|
+
|
|
190
|
+
## License
|
|
191
|
+
|
|
192
|
+
Copyright (C) 2026 RFrank
|
|
193
|
+
|
|
194
|
+
ShapeRunner is free software: you can redistribute it and/or modify it
|
|
195
|
+
under the terms of the GNU General Public License as published by the Free
|
|
196
|
+
Software Foundation, either version 3 of the License, or (at your option)
|
|
197
|
+
any later version. It comes with no warranty. See [LICENSE](https://github.com/wolfybird/shaperunner/blob/main/LICENSE) for
|
|
198
|
+
the full text.
|
|
199
|
+
|
|
200
|
+
The pictures and recordings you make with ShapeRunner are yours; the
|
|
201
|
+
license covers the program, not what it draws.
|
|
202
|
+
|
|
203
|
+
The ready-made apps also include other open-source software (Python, NumPy,
|
|
204
|
+
pygame-ce with SDL, PortAudio and others), each under its own license. Each
|
|
205
|
+
app carries their license texts in `THIRD_PARTY_NOTICES.txt`; see
|
|
206
|
+
[licenses/README.md](https://github.com/wolfybird/shaperunner/blob/main/licenses/README.md) for where they come from.
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
shaperunner.py,sha256=PlTsXcgCpuQYsrGlmg8eoqLDgdYEZxdIcfDeoXb9RYQ,110862
|
|
2
|
+
shaperunner-10.3.dist-info/METADATA,sha256=HMkQXkjDDNSPTwB0CCQEROr8eZEWhysQJzEFGTHpZK8,8024
|
|
3
|
+
shaperunner-10.3.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
|
|
4
|
+
shaperunner-10.3.dist-info/entry_points.txt,sha256=QVqO6g897lB-8T1ehjp9t4I3fV_A5wdYWo1NdUqVurk,49
|
|
5
|
+
shaperunner-10.3.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
|
|
6
|
+
shaperunner-10.3.dist-info/RECORD,,
|