update readme

Author: 李锶厅(lisiting01)

LICENSE.txt

@@ -1,27 +1,29 @@
 # revit-mcp-plugin
 
-[Chinese Version](#简介)
+English | [简体中文](README_zh.md)
 
-# Introduction
+## Introduction
 
-The revit-mcp-plugin allows you to interact with Revit through the MCP protocol using the Claude client.
+revit-mcp-plugin is a Revit plugin based on the MCP protocol, enabling AI to interact with Revit.
 
-This project is the Revit client (receives messages, operates Revit) and needs to be used in conjunction with [revit-mcp](https://github.com/revit-mcp/revit-mcp) (provides tools to AI).
+This project is part of the revit-mcp project (receives messages, loads command sets, operates Revit), and needs to be used in conjunction with [revit-mcp](https://github.com/revit-mcp/revit-mcp) (provides tools to AI) and [revit-mcp-commandset](https://github.com/revit-mcp/revit-mcp-commandset) (specific feature implementations).
 
 ## Environment Requirements
-* Revit 2019
+
+- Revit 2019~2024
 
 ## Usage Instructions
 
 ### Register Plugin
+
 Register the plugin and restart Revit:
 
 ```xml
 <?xml version="1.0" encoding="utf-8"?>
 <RevitAddIns>
   <AddIn Type="Application">
     <Name>revit-mcp</Name>
-    <Assembly>revit-mcp-plugin.dll</Assembly>
+    <Assembly>%your_path%\revit-mcp-plugin.dll</Assembly>
     <FullClassName>revit_mcp_plugin.Core.Application</FullClassName>
     <ClientId>090A4C8C-61DC-426D-87DF-E4BAE0F80EC1</ClientId>
     <VendorId>revit-mcp</VendorId>
@@ -30,190 +32,100 @@ Register the plugin and restart Revit:
 </RevitAddIns>
 ```
 
-### Enable Service
-Add-in Modules -> mcp -> Start mcp service listening
-
-### Adding Commands
-To add commands, you only need to focus on the Commands directory (specific command implementation) and the Core/SocketService.cs file (command registration).
+`%your_path%` needs to be replaced with the actual path after compilation.
 
-Each command in the Commands directory is divided into two parts:
-* `XXXCommand` is responsible for parsing parameters and triggering event handlers, while also handling timeouts and errors
-* `XXXEventHandler` is responsible for the actual operation, using transactions to ensure atomicity
+### Configure Commands
 
-Commands need to be registered in the RegisterCommands method of SocketService before they can be called by the mcp service.
+Add-in Modules -> Revit MCP Plugin -> Settings
 
-**Process**
-1. Create a new feature subdirectory in the `Commands` directory (e.g., `Commands/window/`)
-2. Add an event handler (e.g., `CreateWindowEventHandler.cs`), which is based on Revit's external event
-3. Add a command class (e.g., `CreateWindowCommand.cs`), which parses information from the mcp server and calls the handler for implementation
-4. Register the new command in the `RegisterCommands` method of `SocketService`
-
-## Project File Organization
+This interface is used to configure the commands to be loaded into Revit. Click OpenCommandSetFolder to open the folder storing command sets. A typical command set folder structure looks like this:
 
 ```
-revit_mcp/
-├── Core/
-│   ├── Application.cs                     # Application entry point
-│   ├── MCPServiceConnection.cs            # Revit external command
-│   ├── SocketService.cs                   # Socket service implementation
-│   └── JsonRPC/                           # JSON-RPC related classes
-│       ├── JsonRPCRequest.cs              # Request model
-│       ├── JsonRPCResponse.cs             # Response model
-│       ├── JsonRPCErrorCodes.cs           # Error code constants
-│       └── JsonRPCSerializer.cs           # Serialization/deserialization helper
-│
-├── Commands/
-│   ├── Interfaces/                        # Command interfaces
-│   │   ├── IRevitCommand.cs               # Command interface
-│   │   └── IWaitableExternalEventHandler.cs # Event wait handler interface
-│   │
-│   ├── Base/
-│   │   └── ExternalEventCommandBase.cs    # External event-based command base class
-│   │
-│   ├── Registry/
-│   │   └── RevitCommandRegistry.cs        # Command registration
-│   │
-│   ├── Wall/                              # Wall-related commands
-│   │   ├── CreateWallEventHandler.cs      # Create wall event handler
-│   │   └── CreateWallCommand.cs           # Create wall command
-│   │
-│   └── Code/                              # Code execution related commands
-│       ├── ExecuteCodeEventHandler.cs     # Execute code event handler
-│       └── ExecuteCodeCommand.cs          # Execute code command
-│
-├── Utils/                                 # Utility classes
-│
-└── Models/                                # Data models
+CommandSetName/
+├── 2019/                                # Compatible executable files for different versions
+├── 2020/
+├── 2021/
+├── 2022/
+├── 2023/
+├── 2024/
+└── command.json                         # Configuration file
 ```
 
-### Core Directory
-1. **Application.cs**: Application entry point, responsible for initializing the plugin
-2. **MCPServiceConnection.cs**: Revit external command, used to start the service
-3. **SocketService.cs**: Socket service implementation, responsible for communicating with external clients
-4. **JsonRPC Directory**: Contains classes and implementations related to the JSON-RPC protocol
-
-### Commands Directory
-1. **Interfaces Directory**: Command-related interface definitions
-2. **Base Directory**: Contains base class implementations for commands
-3. **Registry Directory**: Command registration and management
-4. **Functional Directories** (Wall, Code, etc.): Contains specific functionality commands and event handlers
-
-### Utils Directory
-Contains various utility classes to help handle repeatedly used functionality.
-
-### Models Directory
-Contains data model classes used to pass data between different parts of the system.
-
-
-
-## 简介
-
-revit-mcp-plugin 允许你使用claude客户端通过 MCP 协议与 Revit 进行交互。
-
-本项目是revit客户端（接收信息，操作revit），还需要配合[revit-mcp](https://github.com/revit-mcp/revit-mcp)（向AI提供tools）使用。
-
-## 环境要求
-
-- revit 2019
-
-## 使用方法
-
-### 注册插件
+Successfully identified commands need to be checked to be loaded and used.
 
-注册插件，重启Revit
-
-```
-<?xml version="1.0" encoding="utf-8"?>
-<RevitAddIns>
-  <AddIn Type="Application">
-    <Name>revit-mcp</Name>
-    <Assembly>revit-mcp-plugin.dll</Assembly>
-    <FullClassName>revit_mcp_plugin.Core.Application</FullClassName>
-    <ClientId>090A4C8C-61DC-426D-87DF-E4BAE0F80EC1</ClientId>
-    <VendorId>revit-mcp</VendorId>
-    <VendorDescription>https://github.com/revit-mcp/revit-mcp-plugin</VendorDescription>
-  </AddIn>
-</RevitAddIns>
-```
-
-### 启用服务
-
-附加模块->mcp->开启mcp服务监听
-
-## 添加命令
-
-对于添加命令，仅需要聚焦Commands目录（命令的具体实现）以及Core/SocketService.cs文件（注册命令）
+### Enable Service
 
-Commands中的每一个命令分为两个部分：
+Add-in -> Revit MCP Plugin -> Revit MCP Switch
 
-- `XXXCommand`负责解析参数并触发事件处理程序，同时处理超时和错误
-- `XXXEventHandler`负责实际的操作，使用事务确保操作的原子性
+Open the service to allow AI to discover your Revit program. Now AI can control your Revit!
 
-命令需要在SocketService中的RegisterCommands注册后才能被mcp服务调用
+> Note: If you modify the configured commands after enabling the service, you may need to restart REVIT for the configuration to take effect. This is related to whether the command has already been registered.
 
-**流程**
+## Custom Commands
 
-1. 在`Commands`目录下创建新的功能子目录（例如`Commands/window/`）
-2. 添加事件处理器（例如`CreateWindowEventHandler.cs`），事件处理器基于Revit的外部事件
-3. 添加命令类（例如`CreateWindowCommand.cs`），解析来自mcp服务器的信息，调用处理器实现
-4. 在`SocketService`的`RegisterCommands`方法中注册新命令
+You can refer to the [revit-mcp-commandset](https://github.com/revit-mcp/revit-mcp-commandset) project to develop custom commands.
 
-## 项目文件组织
+## Project File Organization
 
 ```
-revit_mcp/
-├── Core/
-│   ├── Application.cs                     # 应用程序入口点
-│   ├── MCPServiceConnection.cs            # Revit外部命令
-│   ├── SocketService.cs                   # Socket服务实现
-│   └── JsonRPC/                           # JSON-RPC相关类
-│       ├── JsonRPCRequest.cs              # 请求模型
-│       ├── JsonRPCResponse.cs             # 响应模型
-│       ├── JsonRPCErrorCodes.cs           # 错误代码常量
-│       └── JsonRPCSerializer.cs           # 序列化/反序列化帮助类
+revit-mcp-plugin/
+├── Configuration/                            # Configuration management related classes
+│   ├── CommandConfig.cs                      # Command configuration
+│   ├── ConfigurationManager.cs               # Configuration manager
+│   ├── DeveloperInfo.cs                      # Developer information
+│   ├── FrameworkConfig.cs                    # Framework configuration
+│   └── ServiceSettings.cs                    # Service settings
+│
+├── Core/                                     # Program entry and core functionality
+│   ├── Application.cs                        # Application entry point
+│   ├── CommandExecutor.cs                    # Command executor
+│   ├── CommandManager.cs                     # Command manager
+│   ├── ExternalEventManager.cs               # External event manager
+│   ├── MCPServiceConnection.cs               # MCP service connection
+│   ├── RevitCommandRegistry.cs               # Revit command registration
+│   ├── Settings.cs                           # Application settings
+│   └── SocketService.cs                      # Socket service implementation
 │
-├── Commands/
-│   ├── Interfaces/                        # 命令接口
-│   │   ├── IRevitCommand.cs               # 命令接口
-│   │   └── IWaitableExternalEventHandler.cs # 事件等待处理器接口
-│   │
-│   ├── Base/
-│   │   └── ExternalEventCommandBase.cs    # 基于外部事件的命令基类
-│   │
-│   ├── Registry/
-│   │   └── RevitCommandRegistry.cs        # 命令注册
-│   │
-│   ├── Wall/                              # 墙相关命令
-│   │   ├── CreateWallEventHandler.cs      # 创建墙事件处理器
-│   │   └── CreateWallCommand.cs           # 创建墙命令
-│   │
-│   └── Code/                              # 代码执行相关命令
-│       ├── ExecuteCodeEventHandler.cs     # 执行代码事件处理器
-│       └── ExecuteCodeCommand.cs          # 执行代码命令
+├── Models/                                   # Data models
+│   └── ...                                   # Various data model classes
 │
-├── Utils/                                 # 工具类
+├── UI/                                       # WPF form interfaces
+│   └── ...                                   # Interface related classes
 │
-└── Models/                                # 数据模型
+└── Utils/                                    # Utility classes
+    ├── Logger.cs                             # Logging utility
+    └── PathManager.cs                        # Path management utility
 ```
 
-### Core 目录
+### Configuration Directory
+Responsible for managing various configuration information for the plugin:
 
-1. **Application.cs**: 应用程序入口点，负责初始化插件
-2. **MCPServiceConnection.cs**: Revit外部命令，用于启动服务
-3. **SocketService.cs**: Socket服务实现，负责与外部客户端通信
-4. **JsonRPC目录**: 包含JSON-RPC协议相关的类和实现
+- CommandConfig.cs: Defines command-related configuration
+- ConfigurationManager.cs: Manages loading, saving, and accessing configurations
+- DeveloperInfo.cs: Stores developer-related information
+- FrameworkConfig.cs: Framework-level configuration settings
+- ServiceSettings.cs: Service-related settings
 
-### Commands 目录
+### Core Directory
+Contains the core functionality and entry point of the plugin:
 
-1. **Interfaces目录**: 命令相关接口定义
-2. **Base目录**: 包含命令的基类实现
-3. **Registry目录**: 命令注册和管理
-4. **功能性目录** (Wall, Code等): 包含特定功能的命令和事件处理器
+- Application.cs: Application entry point, responsible for initializing the plugin
+- CommandExecutor.cs: Core component responsible for executing Revit commands
+- CommandManager.cs: Manages and dispatches various commands in the plugin
+- ExternalEventManager.cs: Manages Revit external events
+- MCPServiceConnection.cs: MCP service connection
+- RevitCommandRegistry.cs: Registers and manages available Revit commands
+- Settings.cs: Triggers the display of the settings interface
+- SocketService.cs: Implements Socket communication with external clients
 
-### Utils 目录
+### Models Directory
+Contains data model classes used to pass data between different parts of the system.
 
-包含各种工具类，帮助处理重复使用的功能。
+### UI Directory
+Contains user interface related components of the plugin, implemented using the WPF framework.
 
-### Models 目录
+### Utils Directory
+Provides various auxiliary tools:
 
-包含数据模型类，用于在系统各部分之间传递数据。
+- Logger.cs: Logging tool for debugging and error tracking
+- PathManager.cs: Project-related file path management