Content
<p align="center">
<img src="brand/exports/koryao-software-icon.png" width="156" alt="KORYAO Basic software icon">
</p>
<h1 align="center">KORYAO Basic|KORYAO Basic</h1>
<p align="center">
A local AI workstation for designers and creative professionals: connecting Codex, image vectorization, task verification, and creative software delivery into a traceable workflow.
</p>
<p align="center">
<strong>Local-first · Windows-first · Safe-by-default · Evidence-backed</strong>
</p>
<p align="center">
<a href="https://github.com/jianbaorui07-dot/KORYAO-basic/actions/workflows/ci.yml"><img src="https://github.com/jianbaorui07-dot/KORYAO-basic/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
<img src="https://img.shields.io/badge/version-v0.1.0--alpha.2-f59e0b" alt="version">
<img src="https://img.shields.io/badge/Python-3.10%2B-2563eb" alt="Python 3.10+">
<img src="https://img.shields.io/badge/MCP-stdio-16a34a" alt="MCP stdio">
<img src="https://img.shields.io/badge/license-KORYAO%20Proprietary-b91c1c" alt="KORYAO Proprietary License">
</p>
---
Current release boundary: **v0.1-alpha**. Core security probes and pixel reconstruction (accurate reconstruction) are marked as `stable`; desktop, Adobe writing, and local model running are marked as `experimental`; other capabilities are marked as `planned` or `not implemented` based on evidence.
> AutoCAD/DXF plan validate / dry-run / guarded write. Photoshop, Illustrator, Blender, and CapCut write flows are experimental or planned.
## Tool List
KORYAO Basic is not a "chat page with a shell" or an online tool that uploads images to a remote server. It consists of three parts:
1. **Codex Scheduling Layer**: Understands user goals, selects suitable Skills, and MCP tools.
2. **Local Security Runtime**: Restricts paths, requires confirmation, executes tasks, verifies results, and generates desensitized records.
3. **Creative Production Toolchain**: Completes image vectorization, Adobe file delivery, ComfyUI/CAD/Blender bridging tasks.
The core goal is to form a clear local closed loop for creative tasks:
```text
Propose goal → Select materials → Local execution → Quality verification → Preview results → Export delivery → Save evidence
```
> The current version is still in the Alpha stage. Pixel reconstruction and core security probes have been verified; desktop, Adobe writing, local private model running, and other capabilities are still marked as `experimental`; unfinished features will not be packaged as delivered capabilities.
## Current Capability Status
| Capability | Status | Description |
| --- | --- | --- |
| Pixel Reconstruction | **Stable core** | Reconstructs RGBA pixels in working resolution into real SVG geometry, and renders and verifies pixel by pixel |
| Editable-99 | **Available** | Uses SSIM, difference, MAE, edge Dice, alpha MAE five threshold screening high-fidelity candidates |
| Artisan / Intelligent / Lightweight Vectorization | **Available** | For different editing and complexity requirements of illustrations, icons, logos, and textures |
| Codex + MCP Local Scheduling | **Available** | Project-level configuration, security tool registration, task planning, and desensitized evidence have been implemented |
| Windows Desktop | **Experimental** | Has startup, shutdown, restart, and sidecar lifecycle evidence, but still needs more clean machine acceptance |
| AI / PSD Native Delivery | **Experimental** | Calls Illustrator / Photoshop on Windows, requires confirmation, verification, and no overwrite |
| KORYAO-C1 Local Model Running | **Experimental** | Only receives structured task metadata through loopback, does not directly read disk or execute software |
| macOS Desktop | **Planned** | Currently only supports core Python/MCP paths and front-end separate construction |
| ComfyUI / Blender / CAD / CapCut Closed Loop | **Partial / Planned** | Has probes, protocols, dry-run, or experimental implementation, but has not completed unified customer-level acceptance |
| Formal Commercial Release | **Not released** | Still lacks code signature, SmartScreen, upgrade rollback, formal installation package, and after-sales process |
## Five Image Vectorization Modes
| Mode | Suitable Scene | Main Features |
| --- | --- | --- |
| **Exact Pixel Reconstruction `exact`** | Pixel-level archive, faithful reproduction | Each pixel is converted into SVG geometry; no embedding of PNG, Base64, scripts, or external links |
| **Editable-99 `editable-99`** | High-fidelity subsequent editing | Only candidate results that pass all five quality indicators will enter the final selection |
| **Artisan Vectorization `artisan`** | Illustrations, traditional textures, complex graphics | Fewer anchor points, smoother curves, emphasizing editability |
| **Smart Vectorization `smart`** | General design materials | Balances similarity, details, and file complexity |
| **Lightweight Vectorization `lightweight`** | Logos, icons, signs | Reduces color, fragments, nodes, and file size |
Default work maximum side length is `1024`, optional `512 / 1600 / 2048 / original size`. SVG safety upper limit can be selected `64 / 128 / 256 MB`, tasks will stop if exceeding the upper limit, no overwriting of original images, and no silent downgrade to Illustrator Image Trace.
## Quick Start
### Windows: Install Core Environment
Minimum requirements: Git 64-bit, Python 3.10+. Running desktop also requires Node.js 22 LTS, Rust stable MSVC, Microsoft C++ Build Tools, and WebView2.
```powershell
git clone https://github.com/jianbaorui07-dot/KORYAO-basic.git
Set-Location .\KORYAO-basic
powershell -ExecutionPolicy Bypass -File .\bootstrap.ps1 -Profile auto
```
`bootstrap.ps1` will:
- Create `.venv` in the repository;
- Install matching Python/MCP dependencies;
- Generate project-level `.codex/config.toml`;
- Run security pre-check;
- Not modify unrelated system-level software.
After completion, create a new Codex task in the repository and let Codex reload the MCP configuration.
### Start Windows Desktop
```powershell
npm.cmd ci --prefix apps\starbridge-desktop
powershell -ExecutionPolicy Bypass -File apps\starbridge-desktop\scripts\Build-Sidecar.ps1
npm.cmd run tauri:dev --prefix apps\starbridge-desktop
```
Verify core services only:
```powershell
.\.venv\Scripts\python.exe scripts\starbridge_preflight.py --markdown
.\.venv\Scripts\python.exe -m starbridge_mcp.server tools --json --safe-only
```
### macOS: Run Core MCP
```bash
git clone https://github.com/jianbaorui07-dot/KORYAO-basic.git
cd KORYAO-basic
bash ./bootstrap.sh --profile auto
```
This script will not automatically install or modify Homebrew, Xcode, Rosetta, or describe the current front-end construction as a runnable macOS desktop version.
```bash
./.venv/bin/python scripts/starbridge_preflight.py --markdown
./.venv/bin/python -m starbridge_mcp.server tools --json --safe-only
```
## Command Line Vectorization
```powershell
python -m pip install -e ".[vectorization]"
npm.cmd run illustrator:vectorize -- --input "<input.png>" --mode exact --max-dimension 1024 --max-svg-size-mb 128 --reference-id "reference"
npm.cmd run illustrator:vectorize -- --input "<input.png>" --mode editable-99 --quality-preset editable-99 --target-difference 1.0 --reference-id "reference"
npm.cmd run illustrator:vectorize -- --input "<input.png>" --mode artisan --reference-id "reference"
npm.cmd run illustrator:vectorize -- --input "<input.png>" --mode smart --reference-id "reference"
npm.cmd run illustrator:vectorize -- --input "<input.png>" --mode lightweight --reference-id "reference"
```
## Security and Privacy Boundary
- Default read-only, planned, or `dry-run`; real writing must be explicitly confirmed by the user.
- Output is limited to the safe root directory, project output directory, or a new path explicitly selected by the user.
- No recursive scanning of private directories, no overwriting of source files, no silent reduction of quality thresholds.
- Reports only save hashes, relative references, and status, but not Token, Cookie, OAuth, customer materials, or real absolute paths.
- KORYAO-C1 local model running only receives task metadata that has been schema validated, material ID, and Adapter whitelist.
- Community basic capabilities do not require login or network connection; the current source code revision uses KORYAO's proprietary license.
Please do not submit Token, Cookie, Adobe authorization information, customer materials, or real save paths to GitHub.
## Architecture Overview
```mermaid
flowchart LR
A["User"] --> B["Codex Dialogue"]
B --> C["Codex Skills"]
C --> D["KORYAO MCP"]
D --> E["Local Security Layer"]
E --> F["Vectorization and Verification Engine"]
E --> G["Adobe / ComfyUI / CAD / Blender Adapter"]
E --> H["KORYAO-C1 Local Model Running"]
F --> I["SVG / Preview / Quality Report"]
G --> J["Controlled Software Delivery Results"]
H --> K["Plan / Evaluation / Repair Suggestions"]
```
## Document Index
- [Product Facts](docs/PRODUCT_FACTS.md)
- [Architecture V2](docs/ARCHITECTURE_V2.md)
- [Five Modes of Vectorization](docs/vectorization-modes.md)
- [Pixel Reconstruction](docs/exact-pixel-vectorization.md)
- [Illustrator Access](docs/05-codex-illustrator.md)
- [Adobe Demo Gallery](docs/adobe-demo-gallery.md)
- [Adobe Demo Smoke Test](docs/adobe-demo-smoke-test.md)
- [Release Notes Draft](RELEASE_NOTES_DRAFT.md)
- [Security Instructions](SECURITY.md)
- [Contribution Guide](CONTRIBUTING.md)
## Cooperation and Feedback
KORYAO is looking for partners willing to participate in product development, visual design, testing and acceptance, creative software access, and commercial landing.
- Reproducible defects and document issues: Please submit GitHub Issue.
- Commercial cooperation and joint development: `jianbaorui07@gmail.com`
- Please do not upload customer materials, private authorization files, and sensitive paths in Issue, PR, or attachments.
## License
The current version uses [KORYAO Proprietary License](LICENSE). Copyright © 2025–2026 菅宝瑞, all rights reserved. Historical versions are still subject to the license terms that accompanied their release.
Connection Info
You Might Also Like
markitdown
Python tool for converting files and office documents to Markdown.
OpenAI Whisper
OpenAI Whisper MCP Server - 基于本地 Whisper CLI 的离线语音识别与翻译,无需 API Key,支持...
oh-my-opencode
Background agents · Curated agents like oracle, librarians, frontend...
claude-flow
Claude-Flow v2.7.0 is an enterprise AI orchestration platform.
ai-engineering-from-scratch
Learn it. Build it. Ship it for others. The most comprehensive open-source...
chatbox
User-friendly Desktop Client App for AI Models/LLMs (GPT, Claude, Gemini, Ollama...)