Skip to content

Commit

Permalink
docs: MGT
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaofeiTM233 committed Oct 9, 2024
1 parent 495d8cc commit 9c76585
Showing 1 changed file with 8 additions and 81 deletions.
89 changes: 8 additions & 81 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,92 +5,19 @@

<div align="center">

# MaaPracticeBoilerplate
# MGT

</div>

本仓库为 [MaaFramework](https://github.com/MaaXYZ/MaaFramework) 所提供的项目模板,开发者可基于此模板直接创建自己的 MaaXXX 项目。

> **MaaFramework** 是基于图像识别技术、运用 [MAA](https://github.com/MaaAssistantArknights/MaaAssistantArknights) 开发经验去芜存菁、完全重写的新一代自动化黑盒测试框架。
> 低代码的同时仍拥有高扩展性,旨在打造一款丰富、领先、且实用的开源库,助力开发者轻松编写出更好的黑盒测试程序,并推广普及。

## 即刻开始

- [📄入门文档](https://github.com/MaaXYZ/MaaFramework/blob/main/docs/zh_cn/1.1-%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B.md)
- [🎞️视频教程](https://www.bilibili.com/video/BV1yr421E7MW)

## 如何开发

0. 使用右上角 `Use this template` - `Create a new repository` 来基于本模板创建您自己的项目。

1. 完整克隆本项目及子项目(地址请修改为您基于本模板创建的新项目地址)。

```bash
git clone --recursive https://github.com/MaaXYZ/MaaPracticeBoilerplate.git
```

**请注意,一定要完整克隆子项目,不要漏了 `--recursive`,也不要下载 zip 包!**

2. 下载 MaaFramework 的 [Release 包](https://github.com/MaaXYZ/MaaFramework/releases),解压到 `deps` 文件夹中。

3. 配置资源文件。

```bash
python ./configure.py
```

4. 按需求修改 `assets` 中的资源文件,请参考 MaaFramework 相关文档。

- 可使用 [MaaDebugger](https://github.com/MaaXYZ/MaaDebugger) 进行调试;
- 也可以在本地安装后测试:

1. 执行安装脚本

```bash
python ./install.py
```

2. 运行 `install/MaaPiCli.exe`

5. 完成开发工作后,上传您的代码并发布版本。

```bash
# 配置 git 信息(仅第一次需要,后续不用再配置)
git config user.name "您的 GitHub 昵称"
git config user.email "您的 GitHub 邮箱"
# 提交修改
git add .
git commit -m "XX 新功能"
git push origin HEAD -u
```

6. 发布您的版本

需要先修改仓库设置 `Settings` - `Actions` - `General` - `Read and write permissions` - `Save`

```bash
# CI 检测到 tag 会自动进行发版
git tag v1.0.0
git push origin v1.0.0
```

## 生态共建

MAA 正计划建设为一类项目,而非舟的单一软件。

若您的项目依赖于 MaaFramework,我们欢迎您将它命名为 MaaXXX, MXA, MAX 等等。当然,这是许可而不是限制,您也可以自由选择其他与 MAA 无关的名字,完全取决于您自己的想法!

同时,我们也非常欢迎在 [最佳实践列表](https://github.com/MaaXYZ/MaaFramework#%E6%9C%80%E4%BD%B3%E5%AE%9E%E8%B7%B5) 中添加上您的项目!
本项目由 **[MaaFramework](https://github.com/MaaXYZ/MaaFramework)** 强力驱动!

## 鸣谢
目前只能按预置的配置运行,并且不一定能够流畅运行!

本项目由 **[MaaFramework](https://github.com/MaaXYZ/MaaFramework)** 强力驱动!
仅在 MuMu12 的 1600x900 分辨率下测试运行,其它分辨率未经测试,可行性未知。

感谢以下开发者对本项目作出的贡献(下面链接改成你自己的项目地址):
# 使用方法

<a href="https://github.com/MaaXYZ/MaaFramework/graphs/contributors">
<img src="https://contrib.rocks/image?repo=MaaXYZ/MaaFramework&max=1000" />
</a>
[Releases](https://github.com/xiaofeiTM233/MGT/releases/latest) 下载对应系统版本的压缩包,解压后按一定方式运行。

# Dev
Please contact us via email xiaofeitm233@vip.qq.com or join qq group 949370222

0 comments on commit 9c76585

Please sign in to comment.