ZYC.Framework Logo

ZYC.Framework

A high-performance, modular, and extensible desktop automation framework built with .NET 10 and WPF.

📖 Overview

ZYC.Framework is a modern desktop automation solution that combines the expressive UI capabilities of WPF with the latest features of .NET 10. It is designed to simplify the development of complex automation systems through a modular architecture.

The project deeply integrates .NET Aspire for distributed application orchestration, and supports a hybrid approach with Blazor and WebView2, so you can choose between a Web-based UI and a native desktop experience as needed.

✨ Key Features

Modular Architecture: Decoupled business logic with dynamic loading and independent development.
Modern UI Experience: Built on WPF with support for multi-workspace and multi-tab interactions.
Hybrid Development:
- WebView2 integration for embedding modern Web applications.
- Blazor integration to reuse Web components seamlessly in desktop scenarios.
Cloud-Native Ready: Built-in .NET Aspire support to simplify service discovery, governance, and deployment.
Batteries Included (Enterprise-Oriented):
- Task Management: Task scheduling and lifecycle management.
- Exception Handling: Robust global error capture and diagnostics.
- Localization: Built-in multi-language support for global-ready apps.

🛠️ Tech Stack

Runtime: .NET 10 SDK
UI Framework: WPF (Windows Presentation Foundation)
Hybrid UI: WebView2 + Blazor
Orchestration: .NET Aspire
Architecture: Modular Monolith / Plugin-based

🚀 Quick Start

Please refer to the detailed guide:

👉 Quick Start (quick-start.md)

👉 Download Demo Installer

Installation

Install the core package via NuGet:

dotnet add package ZYC.Framework.Alpha --version 1.2.3

Features

Core Framework

Feature	Description
Modular Architecture	Organize features as modules with support for dynamic loading and extension.
Multi-Workspace Layout	Split, merge, reorder, and change workspace layout directions.
Multi-Tab Navigation	URI-based tab navigation with switching, restoration, and cross-workspace movement.
Extensible Menu System	Extension points for main menu, hamburger menu, title bar, status bar, and taskbar menus.
Notification System	Built-in Toast and Banner notifications for status and error feedback.
Interaction Utilities	Desktop interaction helpers such as BusyWindow, overlays, and drag-and-drop.
Hybrid UI Support	Embed web content using `WebView2` and build hybrid UI with `Blazor`.
Configuration & State	Local persistence for configuration, application state, and task history.
Single Instance	Supports single-instance application startup control.
MCP Exposure	Automatically expose public framework and module capabilities as MCP tools.

Built-in Modules

Module	Description
About	Application metadata (version, author, description, copyright).
ApiReference	Built-in API documentation viewer.
CLI	Embedded terminal with command execution and parameter support.
FileExplorer	Embedded file explorer for directory browsing.
WebBrowser	Embedded browser for web and local content.
Language	Language switching and localization resource management.
Translator	Translation service integration.
Settings	Unified configuration management UI.
Secrets	Secure configuration editing and display.
TaskManager	Task queue, execution, pause/resume, cancel, and status tracking.
Update	NuGet-based version checking and update workflow.
NuGet	Package search, download, dependency handling, and caching.
ModuleManager	Install, enable, disable, and manage local or NuGet modules.
MCP.Server	Local MCP server exposing application capabilities.
Aspire	`Aspire` tool integration with service control and dashboard support.
Log	Logging infrastructure and log directory access.
BlazorDemo	Demonstrates `Blazor Server` integration.
Mock	Test module for validating framework capabilities.

Development & Delivery

Feature	Description
CLI Tools	Standalone CLI entry with module command extension support.
Module Scaffolding	Generate new modules and abstraction projects from templates.
Documentation Generation	Generate README and documentation templates.
NuGet Packaging	Build NuGet packages for framework and modules.
Installer Build	Build desktop installers for distribution.