Development Guide
About 398 wordsAbout 1 min
This directory contains the complete developer documentation for the MaaNTE project.
Reading route
We recommend reading in the following order:
- Create the environment, start it up, and complete the first change. PR →
getting-started.md - Understand Pipeline Writing Specifications →
pipeline-guide.md - View coding specifications →
coding-standards.md - Need to write Python custom logic →
custom-action.md - Understanding Scene Jump Mechanisms →
scene-manager.md - Requires debugging of a single node. →
node-testing.md
File Index
Tier 1 — Get started quickly
| Document | Instruction |
|---|---|
| Quick Start | Walk through the complete development process using real-world examples (#223 → #231) |
Tier 2 — Reference Manual
| Document | Instruction |
|---|---|
| Custom motion development | Python CustomAction writing, Controller API, and Pipeline integration |
| Node testing | How to write and execute node tests to verify whether the identification is stable and hit-through. |
| DMCA / Abuse Submission Template | One-click reusable reporting text for counterfeit/drug trafficking warehouses(AGPL-3.0) |
| DeepWiki — MaaNTE | Quickly view online project documents with AI. |
| Pipeline Agreement | MaaFramework Official Pipeline Protocol Full Text |
Tier 3 — Regulations and constraints
| Document | Instruction |
|---|---|
| Coding Standards | Pipeline / Python Coding rules, pre-submission checks, common pitfalls |
Pipeline Basic components
All Pipeline developers should query the most frequently used reusable nodes in their daily development for reuse.
| Document | Instruction | Path |
|---|---|---|
| Scene Manager | Automatic navigation to the target scene from any interface | Interface/Scene/ |
| InScene scene recognition | Determine the current scene in the video | Interface/Scene/Status.json |
| Universal Button | Entrance buttons for each scene | Common/Button/ |
| Custom actions and recognition | General Python tools: alt_click, etc. | agent/custom/action/Common/ |
Advanced Components Reference
Read as needed. Only read when using the corresponding component.
| Document | Instruction |
|---|---|
| Automatic battle | ⚠ Under development |
| Automatic navigation | ⚠ Under development |
Task maintenance document
Reading is only required when performing the corresponding task.
| Document | Instruction |
|---|---|
| 待補充 | 待補充 |
Quick jump
| What I want to do ? | Where should I look ? |
|---|---|
| First time participating, starting from scratch. | getting-started.md |
| Modify Pipeline Nodes | pipeline-guide.md |
| Writing Python Custom Logic | custom-action.md |
| Scene navigation/interface navigation | scene-manager.md |
| Detect a single node | node-testing.md |
| View coding specifications | coding-standards.md |
Refer to
Communication
Join the developer QQ group:1092630280
