MagicWE 开源项目教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00250/article/details/141583884

MagicWE 开源项目教程

MagicWELag free asynchronous world editor for PMMP with plenty of options项目地址:https://gitcode.com/gh_mirrors/ma/MagicWE

1. 项目的目录结构及介绍

MagicWE 是一个用于 PMMP（PocketMine-MP）的异步世界编辑器，提供了丰富的选项和功能。项目的目录结构如下：

MagicWE/
├── src/
│   └── xenialdan/
│       └── MagicWE2/
│           ├── Brushes/
│           ├── Commands/
│           ├── Selection/
│           ├── Tasks/
│           ├── Utils/
│           └── Main.php
├── resources/
│   ├── lang/
│   └── templates/
├── .gitignore
├── .poggit.yml
├── LICENSE
├── README.md
├── TODO.md
├── phpstan.neon.dist
├── plugin.yml

目录介绍

src/xenialdan/MagicWE2/: 包含项目的主要源代码。
- Brushes/: 刷子工具的实现。
- Commands/: 命令的实现。
- Selection/: 选择区域的实现。
- Tasks/: 异步任务的实现。
- Utils/: 工具类和辅助函数。
- Main.php: 项目的主入口文件。
resources/: 包含项目的资源文件。
- lang/: 多语言支持文件。
- templates/: 模板文件。
.gitignore: Git 忽略文件配置。
.poggit.yml: Poggit CI 配置文件。
LICENSE: 项目许可证（GPL-3.0）。
README.md: 项目说明文档。
TODO.md: 待办事项列表。
phpstan.neon.dist: PHPStan 静态分析配置文件。
plugin.yml: 插件配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/xenialdan/MagicWE2/Main.php。这个文件是 MagicWE 插件的主入口点，负责初始化插件并注册必要的命令和事件监听器。

Main.php 主要功能

初始化插件实例。
注册命令。
注册事件监听器。
加载配置和资源文件。

3. 项目的配置文件介绍

项目的配置文件是 plugin.yml。这个文件定义了插件的基本信息和命令配置。

plugin.yml 主要内容

name: MagicWE
version: 2.0.0
main: xenialdan\MagicWE2\Main
api:
  - 4.0.0
commands:
  wand:
    description: Toggle the wand tool on/off
    usage: /wand
  undo:
    description: Rolls back the last action
    usage: /undo
  redo:
    description: Applies the last undo action again
    usage: /redo
  debug:
    description: Gives you the debug stick which gives information about the clicked block
    usage: /debug
  cylinder:
    description: Create a cylinder
    usage: /cylinder <blocks:string> <diameter:int> [height:int] [flags:text]
  count:
    description: Count blocks in selection
    usage: /count [blocks:string] [flags:text]
  help:
    description: MagicWE help command
    usage: /help [command:string]
  version:
    description: MagicWE version
    usage: /version
  info:
    description: Information about MagicWE
    usage: /info
  report:
    description: Report a bug to GitHub
    usage: /report [title:text]
  donate:
    description: Donate to support development of MagicWE
    usage: /donate