Skip to content

Commit 5e1753b

Browse files
NatsuuMistEO
andauthored
docs: update quick start guide with architecture and packaging sections (#1252)
## Summary by Sourcery 更新快速入门指南,为基于 MaaFramework 的项目添加高层架构背景和打包说明。 文档: - 在快速入门指南中添加 MaaFramework 项目架构概览以及各组件的角色说明。 - 记录项目打包方案,包括社区项目模板 CI 工作流的使用方式,以及通用 UI 打包文档的参考说明。 <details> <summary>Original summary in English</summary> ## Summary by Sourcery Update the Quick Start guide with high-level architecture context and packaging instructions for MaaFramework-based projects. Documentation: - Add an overview of MaaFramework project architecture and component roles to the Quick Start guide. - Document project packaging options, including use of the community project template CI workflow and General UI packaging docs. </details> --------- Co-authored-by: MistEO <mistereo@hotmail.com>
1 parent 2a90cb4 commit 5e1753b

5 files changed

Lines changed: 31 additions & 1 deletion

File tree

docs/en_us/1.1-QuickStarted.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,15 @@ Best-practice references:
221221

222222
Please refer to the [Integration Documentation](2.1-Integration.md) and the [Integrated Interface Overview](2.2-IntegratedInterfaceOverview.md).
223223

224+
## Project Packaging
225+
226+
If you need to package your project into an executable, refer to the following.
227+
228+
> [!TIP]
229+
> 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.
230+
231+
For manual packaging, please refer to the documentation for each [General UI](/README_en.md#general-ui).
232+
224233
## Communication
225234

226235
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.

docs/en_us/1.2-ExplanationOfTerms.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# 1.2 Explanation of Terms
22

3+
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).
4+
5+
![architecture](/docs/static/architecture.png)
6+
7+
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.
8+
39
## MaaFW Terminology
410

511
- **Node**

docs/static/architecture.png

16.1 KB
Loading

docs/zh_cn/1.1-快速开始.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ my_resource/
209209

210210
我们定义了一套 [ProjectInterface 协议](3.3-ProjectInterfaceV2协议.md),用于描述项目所需的资源文件及运行配置,以便通用 UI 能够正确加载和运行您的项目。
211211

212-
_说人话就是,按文档再写个 `interface.json`,用来告诉通用 UI 你的资源文件放哪儿了、有哪些任务可以执行等等,这样通用 UI 才能帮你跑起来。_
212+
*说人话就是,按文档再写个 `interface.json`,用来告诉通用 UI 你的资源文件放哪儿了、有哪些任务可以执行等等,这样通用 UI 才能帮你跑起来。*
213213

214214
- [interface.json 文档](3.3-ProjectInterfaceV2协议.md)
215215
- [例子](https://github.com/MaaXYZ/MaaFramework/blob/main/sample/interface.json)
@@ -222,6 +222,15 @@ _说人话就是,按文档再写个 `interface.json`,用来告诉通用 UI
222222

223223
请参考 [集成文档](2.1-集成文档.md)[集成接口一览](2.2-集成接口一览.md)
224224

225+
## 项目打包
226+
227+
如果需要将项目打包为可执行文件,可以参考以下内容。
228+
229+
> [!TIP]
230+
> 如果使用 [⭐项目模板](https://github.com/MaaXYZ/MaaPracticeBoilerplate) 进行开发,则可以通过附带的 CI 工作流进行打包。具体步骤参见模板项目中的相关说明。
231+
232+
如果需要自行打包,请参考各个[通用 UI](/README.md#通用-ui)对应的说明文档。
233+
225234
## 沟通交流
226235

227236
欢迎开发者加入官方 QQ 群(595990173),交流集成与开发实践。群内仅讨论开发相关议题,不提供日常使用/客服支持;为保证讨论质量,长期离题或违规的成员可能会被移除。

docs/zh_cn/1.2-术语解释.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# 1.2 术语解释
22

3+
一个基于 MaaFramework 开发项目通常包含`MaaFramework本体``UI``项目资源``agent`几个部分。其中,`项目资源`定义项目具体执行逻辑,`本体`负责执行,`agent`用于扩展自定义逻辑,`UI`提供交互界面并通过[ProjectInterface协议](./3.3-ProjectInterfaceV2协议.md)读取资源和进行操作。
4+
5+
![architecture](/docs/static/architecture.png)
6+
7+
基于本项目进行开发的大部分时间围绕编写项目资源进行。只需正确配置 `interface.json` 文件,就可以通过社区提供的[通用 UI](/README.md#通用-ui)运行。在进行开发前,请务必熟悉以下术语。
8+
39
## MaaFW 专有术语
410

511
- **Node** | **节点**

0 commit comments

Comments
 (0)