A lightweight Blender add-on for potato-style automation π β simplify your workflow and focus on creativity.
Before getting started, ensure you have the following installed:
-
ποΈ Blender β
4.xor above π Download -
π Python β
3.xor above (For developers) π Download
Tip
Using the latest stable version is recommended for the best compatibility.
Copy one of those to the terminal
- Build the addon, then checking \dist folder
potato package- Build and install/uninstall the addon based on your Blender version, default 4.3
potato install 4.xpotato uninstall 4.x- If you're a dev, "reload" is a combination of UnInstall + Clean + package + Install
potato reload- π Automated registry download
- π¨ Quick material setup
- π§© Custom utilities for Blender scripting
- β‘ One-click run from Blender or terminal
- π Extensible Python codebase
This feature is part of the LSPotato addon, used for downloading and managing registry data from the LSRegistry system. It is not a standalone project β it is a newly added feature inside the addon.
Core capabilities:
- Download registry metadata (
registry.yaml,registry.ls.yaml) - Fetch GitHub releases
- Extract registry files into the project
- Automatically link objects from
.blendfiles - Maintain LSRegistry collections inside the Scene
- Provide Repair functionality
- Support GitHub token authentication for private repositories
YourProject/
βββ YourBlendFile.blend
βββ registry/
βββ metadata/
β βββ io.github.lvoxx.world-builder/
β βββ registry.yaml
β βββ registry.ls.yaml
βββ io.github.lvoxx.world-builder_dummy/
βββ World-Builder.blend
User enters in the UI:
io.github.lvoxx.world-builder:dummy
Flow:
- User clicks Get
- Metadata files are downloaded
- The release ZIP is fetched
- Files are extracted into the
registry/directory - The addon links the
"Main"object fromWorld-Builder.blend - UI displays:
Installed: io.github.lvoxx.world-builder:dummy
When the user clicks Get, the system:
- Downloads & extracts the release β β
- Creates the root
LSRegistrycollection (blue, COLOR_04) in the Scene β β - Creates a sub-collection named:
io-github-lvoxx-world-builder-dummyβ β - Links objects from extracted
.blendfiles into this sub-collection β β
When the user clicks Repair, the system:
- Locates the
LSRegistrycollection β β - Scans all child collections β β
- Parses collection names, for example:
io-github-lvoxx-world-builder-dummyβ namespace + version β β - Finds corresponding registry folder:
registry/io.github.lvoxx.world-builder_dummy/β β - Removes only broken links inside that specific collection β β
- Re-downloads the release ZIP β β
- Re-extracts and re-links objects β β
Scene Collection
βββ π LSRegistry (π΅ Blue β COLOR_04)
βββ π io-github-lvoxx-world-builder-dummy
βββ π Main (linked object)
For private GitHub repositories:
- The user sets a GitHub Token in Addon Preferences
- The token is used via the
Authorizationheader during downloads - Multiple credential profiles are supported (extensible)
- Download the latest release ZIP from Releases.
- Open Blender β
EditβPreferencesβAdd-onsβInstall... - Select the ZIP file β enable Potato-Blender.
git clone https://github.com/lvoxx/Potato-Blender.git
cd Potato-Blenderpotato helpgraph TD
%% Main Entry Point
A[Blender Startup] --> B{Addon Installed?}
B -->|No| C[Install Potato-LSCherry Addon]
B -->|Yes| D[Load Addon Components]
C --> D
%% Core Components Loading
D --> E[Initialize LSCherry Toon Shader]
D --> F[Load Potato Utilities]
D --> G[Register UI Panels]
%% LSCherry Toon Shader System
E --> H[Load Material Libraries]
H --> I[Game-specific Presets]
I --> J[HI3 Materials]
I --> K[Genshin Impact Materials]
I --> L[Honkai Star Rail Materials]
I --> M[Other Game Materials]
%% Potato Automation System
F --> N[Mesh Automation Tools]
F --> O[Material Setup Utilities]
F --> P[Custom Scripting Tools]
%% User Interface
G --> Q[Shader Editor Panel]
G --> R[Properties Panel]
G --> S[Tools Panel]
%% Main Workflow
T[User Selects Object] --> U{Material Exists?}
U -->|No| V[Create New Material]
U -->|Yes| W[Edit Existing Material]
V --> X[Apply LSCherry Base Shader]
W --> X
X --> Y[Configure Toon Parameters]
Y --> Z[Select Game-specific Preset]
Z --> AA[Fine-tune Settings]
AA --> BB[Preview Result]
BB --> CC{Satisfied?}
CC -->|No| Y
CC -->|Yes| DD[Apply Final Material]
%% Advanced Features
DD --> EE[Optional: Batch Processing]
DD --> FF[Optional: Export Settings]
DD --> GG[Optional: Save as Preset]
%% Error Handling
BB --> HH{Errors Detected?}
HH -->|Yes| II[Show Error Messages]
HH -->|No| CC
II --> JJ[Suggest Fixes]
JJ --> Y
%% Background Processes
subgraph "Background Systems"
KK[Auto-reload Libraries]
LL[Mesh Fairing]
MM[Planar UV Mapping]
NN[Material Validation]
end
%% CLI Tools
subgraph "CLI Tools"
OO[potato package]
PP[potato install]
QQ[potato uninstall]
RR[potato reload]
end
style A fill:#e1f5fe
style DD fill:#c8e6c9
style HH fill:#ffcdd2
style EE fill:#fff3e0
style FF fill:#fff3e0
style GG fill:#fff3e0