diff --git a/docs/en_us/1.1-QuickStarted.md b/docs/en_us/1.1-QuickStarted.md index 911fe25f0..b88ede7c1 100644 --- a/docs/en_us/1.1-QuickStarted.md +++ b/docs/en_us/1.1-QuickStarted.md @@ -221,6 +221,15 @@ Best-practice references: Please refer to the [Integration Documentation](2.1-Integration.md) and the [Integrated Interface Overview](2.2-IntegratedInterfaceOverview.md). +## Project Packaging + +If you need to package your project into an executable, refer to the following. + +> [!TIP] +> If you use the [⭐ Project Template](https://github.com/MaaXYZ/MaaPracticeBoilerplate) for development, you can use the included CI workflow for packaging. See the relevant instructions in the template project for details. + +For manual packaging, please refer to the documentation for each [General UI](/README_en.md#general-ui). + ## Communication Developers are welcome to join the official QQ group (595990173) for integration and development discussions. The group is reserved for engineering topics; product-usage support is not provided, and off-topic or spam accounts may be removed to keep the channel focused. diff --git a/docs/en_us/1.2-ExplanationOfTerms.md b/docs/en_us/1.2-ExplanationOfTerms.md index 17efae2dd..83404f95f 100644 --- a/docs/en_us/1.2-ExplanationOfTerms.md +++ b/docs/en_us/1.2-ExplanationOfTerms.md @@ -1,5 +1,11 @@ # 1.2 Explanation of Terms +A project based on MaaFramework typically consists of `MaaFramework Core`, `UI`, `Project Resources`, and `Agent`. Among these, `Project Resources` define the project's execution logic, `Core` handles execution, `Agent` extends custom logic, and `UI` provides the interaction interface, reading resources and performing operations through the [ProjectInterface protocol](./3.3-ProjectInterfaceV2.md). + +![architecture](/docs/static/architecture.png) + +Most of the development based on this project revolves around writing project resources. Simply configure the `interface.json` file correctly to run it through the [General UI](/README_en.md#general-ui) provided by the community. Before starting development, make sure you are familiar with the following terms. + ## MaaFW Terminology - **Node** diff --git a/docs/static/architecture.png b/docs/static/architecture.png new file mode 100644 index 000000000..9b28c0760 Binary files /dev/null and b/docs/static/architecture.png differ diff --git "a/docs/zh_cn/1.1-\345\277\253\351\200\237\345\274\200\345\247\213.md" "b/docs/zh_cn/1.1-\345\277\253\351\200\237\345\274\200\345\247\213.md" index 51e09c0d2..478183881 100644 --- "a/docs/zh_cn/1.1-\345\277\253\351\200\237\345\274\200\345\247\213.md" +++ "b/docs/zh_cn/1.1-\345\277\253\351\200\237\345\274\200\345\247\213.md" @@ -209,7 +209,7 @@ my_resource/ 我们定义了一套 [ProjectInterface 协议](3.3-ProjectInterfaceV2协议.md),用于描述项目所需的资源文件及运行配置,以便通用 UI 能够正确加载和运行您的项目。 -_说人话就是,按文档再写个 `interface.json`,用来告诉通用 UI 你的资源文件放哪儿了、有哪些任务可以执行等等,这样通用 UI 才能帮你跑起来。_ +*说人话就是,按文档再写个 `interface.json`,用来告诉通用 UI 你的资源文件放哪儿了、有哪些任务可以执行等等,这样通用 UI 才能帮你跑起来。* - [interface.json 文档](3.3-ProjectInterfaceV2协议.md) - [例子](https://github.com/MaaXYZ/MaaFramework/blob/main/sample/interface.json) @@ -222,6 +222,15 @@ _说人话就是,按文档再写个 `interface.json`,用来告诉通用 UI 请参考 [集成文档](2.1-集成文档.md) 和 [集成接口一览](2.2-集成接口一览.md) 。 +## 项目打包 + +如果需要将项目打包为可执行文件,可以参考以下内容。 + +> [!TIP] +> 如果使用 [⭐项目模板](https://github.com/MaaXYZ/MaaPracticeBoilerplate) 进行开发,则可以通过附带的 CI 工作流进行打包。具体步骤参见模板项目中的相关说明。 + +如果需要自行打包,请参考各个[通用 UI](/README.md#通用-ui)对应的说明文档。 + ## 沟通交流 欢迎开发者加入官方 QQ 群(595990173),交流集成与开发实践。群内仅讨论开发相关议题,不提供日常使用/客服支持;为保证讨论质量,长期离题或违规的成员可能会被移除。 diff --git "a/docs/zh_cn/1.2-\346\234\257\350\257\255\350\247\243\351\207\212.md" "b/docs/zh_cn/1.2-\346\234\257\350\257\255\350\247\243\351\207\212.md" index 18b195b07..d20f6491d 100644 --- "a/docs/zh_cn/1.2-\346\234\257\350\257\255\350\247\243\351\207\212.md" +++ "b/docs/zh_cn/1.2-\346\234\257\350\257\255\350\247\243\351\207\212.md" @@ -1,5 +1,11 @@ # 1.2 术语解释 +一个基于 MaaFramework 开发项目通常包含`MaaFramework本体`、`UI`、`项目资源`、`agent`几个部分。其中,`项目资源`定义项目具体执行逻辑,`本体`负责执行,`agent`用于扩展自定义逻辑,`UI`提供交互界面并通过[ProjectInterface协议](./3.3-ProjectInterfaceV2协议.md)读取资源和进行操作。 + +![architecture](/docs/static/architecture.png) + +基于本项目进行开发的大部分时间围绕编写项目资源进行。只需正确配置 `interface.json` 文件,就可以通过社区提供的[通用 UI](/README.md#通用-ui)运行。在进行开发前,请务必熟悉以下术语。 + ## MaaFW 专有术语 - **Node** | **节点**