modly README

The project's README from github.com/lightningpixel/modly. As one markdown file: README.md.

Modly logo

Modly

Local, open source, AI-powered image-to-3D mesh generation. Turn any photo into a 3D model using open source AI models running entirely on your GPU. Modly is a desktop application for Windows, Linux, and Apple Silicon macOS.

Created by Lightning Pixel

Modly screenshot


Download

Head to the Releases page to download the latest installer for Windows, Linux, or Apple Silicon macOS.

Alternatively, you can clone the repository and run the app directly without installing:

# Windows
launch.bat

# Linux / macOS
./launch.sh

Getting started

1. Install JS dependencies

npm install

2. Set up Python backend

cd api
python -m venv .venv
.venv\Scripts\activate     # Windows
source .venv/bin/activate  # Linux / macOS
pip install -r requirements.txt

3. Run in development

npm run dev

4. Test

npm test
./node_modules/.bin/tsc --noEmit -p tsconfig.node.json
npm run build

Platform notes


Extension system

Modly supports external model and process extensions. Each extension is a GitHub repository containing a manifest.json plus the runtime entry files required by its type.

Official extensions

Extension Model URL
modly-hunyuan3d-mini-extension Hunyuan3D 2 Mini https://github.com/lightningpixel/modly-hunyuan3d-mini-extension
modly-hunyuan3d-mini-turbo-extension Hunyuan3D 2 Mini Turbo https://github.com/lightningpixel/modly-hunyuan3d-mini-turbo-extension
modly-hunyuan3d-mini-fast-extension Hunyuan3D 2 Mini Fast https://github.com/lightningpixel/modly-hunyuan3d-mini-fast-extension
modly-triposg-extension TripoSG https://github.com/lightningpixel/modly-triposg-extension
modly-trellis2-gguf-extension Trellis2 GGUF https://github.com/lightningpixel/modly-trellis2-gguf-extension

How to install an extension

1. Go to the Models page and click Install from GitHub.

Install from GitHub

2. Enter the HTTPS URL of the extension repository and confirm.

Enter extension URL

3. If the extension exposes model nodes, download the model or one of its variants. Process extensions are ready once installation and setup complete.

Install models


Workflows

Start with a basic workflow first. For example, on the "Workflows" tab, try: Image -> Generate Mesh -> Add to Scene. Make sure there is a connection between each of the steps. Go to the "Generate" tab, make sure the workflow is selected, then click on "Generate 3D Model". Click on "Settings/Logs/Errors" to see any issues.

Modly CLI

Agents and scripts can call a running Modly desktop app without using the UI via the stdlib-only CLI. The CLI is a thin helper over Modly's canonical automation concepts and keeps final machine-readable JSON on stdout:

python tools/modly-cli/agent.py health
python tools/modly-cli/agent.py model list
python tools/modly-cli/agent.py workflow-run status <run_id>
python tools/modly-cli/agent.py generate --image ./input.png --output ./export.glb

Canonical commands are health, model, workflow-run, capability, and process-run. The friendly generate command starts POST /workflow-runs/from-image, polls the returned run, exports the final mesh when requested, and includes recovery metadata such as workflow-run status ... and workflow-run cancel ... in the JSON response.

Compatibility and helper surfaces are intentionally separated: legacy wraps old /generate/* job endpoints, dev serve-api / dev ensure-server start only the FastAPI backend and do not prove Electron/Desktop bridge readiness, and experimental comfy-image / experimental generate-from-workflow are external ComfyUI orchestration helpers rather than the canonical Modly agent contract. Hidden helper aliases such as status, export, and batch remain parseable for scripts, but they are not presented as canonical root commands.

experimental generate-from-workflow --workflow <name> --output <path> treats --output as the final artifact location. When the ComfyUI workflow produces a downloadable 3D asset, the CLI downloads it directly; image-only workflows remain a compatibility path through Modly image-to-3D generation.

See tools/modly-cli/SKILL.md for the agent workflow and output contract.


Community

Join the Discord server to stay up to date with the latest news, report bugs, and share feedback.


Sponsors

Thanks to our early sponsors for believing in Modly and helping make local AI 3D generation more accessible.

DrHepa
DrHepa
   benjapenjamin
benjapenjamin
   iammojogo-sudo
iammojogo-sudo


License

MIT License — see LICENSE for details.

If you fork this project and build your own app from it, you must credit the original project and its creator:

Based on Modly by Lightning Pixel

This is a requirement of the MIT license attribution clause. Please keep this credit visible in your app's UI or documentation.

modly (lightningpixel/modly)

Searching Database…

8.2K ·GitHub
Что это такое?Modly — это настольное приложение, которое превращает фотографию (или текстовый запрос) в 3D-модель с помощью открытых моделей ИИ. Всё работает полностью на вашей видеокарте, без обращения к облачным сервисам.
Это самостоятельное приложение или библиотека, которую можно встроить в мой проект?Это самостоятельное настольное приложение на Electron, созданное с помощью React и Three.js, а не библиотека. Кроме того, в комплекте есть отдельный CLI для скриптов, который использует только стандартную библиотеку Python.
Как его запустить?Скачайте установщик для своей платформы на странице Releases или клонируйте репозиторий, установите JS-зависимости, настройте Python-бэкенд и запустите приложение в режиме разработки.
Нужна ли особая видеокарта или дополнительные среды выполнения, чтобы им пользоваться?Да, генерация полностью выполняется на вашей локальной видеокарте. Кроме того, приложение включает Python-бэкенд наряду с фронтендом на Node/Electron, поэтому при сборке из исходников нужно настроить и Node, и Python.
Работает ли это на любом Mac или только на новых?Поддержка macOS ограничена только чипами Apple Silicon: компьютеры Mac на процессорах Intel не поддерживаются, тогда как Windows и Linux поддерживаются полностью.
На каких операционных системах это работает?Windows, Linux и macOS на Apple Silicon. Для каждой системы есть собственные установщики на странице Releases.
Покидают ли мои данные компьютер?Нет, генерация изначально рассчитана на полную работу на вашей видеокарте с локальными открытыми моделями, поэтому изображения и запросы остаются на вашем компьютере.
Для чего нужен CLI Modly?Он позволяет агентам и скриптам управлять запущенным настольным приложением Modly в фоновом режиме: они обращаются к тем же эндпоинтам запуска воркфлоу, что и интерфейс, и получают ответ в формате JSON, пригодном для машинной обработки, не трогая окно Electron.
Как устроена система расширений?Расширения — это репозитории на GitHub, которые содержат файл manifest.json и файлы среды выполнения. Чтобы установить расширение, вставьте его HTTPS-ссылку на странице Models, а затем скачайте модель, которую оно предоставляет. Официальные расширения включают Hunyuan3D 2 Mini/Turbo/Fast, TripoSG и Trellis2 GGUF.
Как работают воркфлоу внутри приложения?Воркфлоу — это графы узлов, которые вы собираете на вкладке Workflows, например Image -> Generate Mesh -> Add to Scene. Некорректные графы блокируются с встроенными предупреждениями и не ломают текущую модель.
Можно ли потом доработать созданную модель?Да, импортированные модели можно сгладить и упростить прямо в приложении, а оптимизированный результат сохраняется обратно в вашу рабочую папку.
Size
25.2 MB
Stars
8.2K
Age
7mo
Commits · 90 Days