flatblox-tui 0.1.0 → 0.1.1
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.
- package/README.md +0 -46
- package/dist/flatblox-logo.png +0 -0
- package/dist/index.js +29 -29
- package/package.json +13 -17
package/README.md
CHANGED
|
@@ -8,49 +8,3 @@ npx flatblox-tui
|
|
|
8
8
|
|
|
9
9
|
`npx` installs the matching Bun and OpenTUI runtime automatically. macOS,
|
|
10
10
|
Windows, and Linux on x64 or ARM64 are supported.
|
|
11
|
-
|
|
12
|
-
## Development
|
|
13
|
-
|
|
14
|
-
Open the cloud artwork dashboard:
|
|
15
|
-
|
|
16
|
-
```sh
|
|
17
|
-
pnpm tui
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
The first run shows a welcome screen. Create a local artwork without signing in,
|
|
21
|
-
load `.flatblox.json` artwork cards from the current directory, or choose
|
|
22
|
-
**Sign in / Dashboard** to open Flatblox in your browser. Approve the TUI
|
|
23
|
-
connection there, then return to the terminal. The local session is stored with
|
|
24
|
-
owner-only file permissions.
|
|
25
|
-
|
|
26
|
-
Press `N` to choose a grid size and preset palette for a new cloud artwork. Use
|
|
27
|
-
arrow keys or H/J/K/L to choose a saved artwork and Enter to edit it. In the
|
|
28
|
-
editor, `Ctrl+S` asks for a name before creating a new Supabase artwork; later
|
|
29
|
-
saves update it. Use `-` and `+` to zoom the centered artboard, and Escape to
|
|
30
|
-
return to the artwork dashboard. Press `R` to refresh, `O` to sign out, and `Q`
|
|
31
|
-
to quit.
|
|
32
|
-
|
|
33
|
-
To stream the open artwork into Blender, install and enable
|
|
34
|
-
`services/blender/addon/flatblox_live.py`, confirm the add-on says `Listening`,
|
|
35
|
-
then press `B` in the editor. Press `B` again to disconnect. Blender and the
|
|
36
|
-
TUI must run on the same computer.
|
|
37
|
-
|
|
38
|
-
Open a local draft or create a local artwork instead:
|
|
39
|
-
|
|
40
|
-
```sh
|
|
41
|
-
pnpm tui -- drawing.flatblox.json
|
|
42
|
-
pnpm tui -- --local
|
|
43
|
-
pnpm tui -- --size 32 --output drawing.flatblox.json
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
Press `?` in the editor for all drawing controls. Local saves use the
|
|
47
|
-
web-compatible Flatblox draft format.
|
|
48
|
-
|
|
49
|
-
Development reads Supabase and site values from `apps/web/.env`. Override the
|
|
50
|
-
browser destination during local dashboard development with:
|
|
51
|
-
|
|
52
|
-
```sh
|
|
53
|
-
FLATBLOX_DASHBOARD_URL=http://localhost:5174/dashboard/ pnpm tui
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
Sign out without opening the interface with `pnpm tui -- --logout`.
|
package/dist/flatblox-logo.png
CHANGED
|
Binary file
|