GD-Plug管理器使用手册

GD-Plug管理器使用手册

gd-plugMinimal plugin manager for Godot项目地址:https://gitcode.com/gh_mirrors/gd/gd-plug

1. 项目目录结构及介绍

GD-Plug是一个专为Godot引擎设计的插件管理解决方案，通过其配套的UI（gd-plug-ui）或命令行界面提供了便捷的插件安装、更新和卸载功能。以下为其基本目录结构概述：

• 根目录
  • addons: 这个目录存放gd-plug本身作为一个插件时所需的代码。
    • gd-plug: 核心插件脚本，负责插件的管理逻辑。
  • 可选：项目级别下，用户可以通过创建或初始化gd-plug脚本来声明要管理的第三方插件。

2. 项目的启动文件介绍

在GD-Plug的上下文中，没有传统的“启动文件”概念，但有两个关键操作涉及项目的“启动”配置和执行：

• 初始化（Init）: 用户并不直接编辑一个特定的启动文件来开始使用GD-Plug。而是通过执行命令行指令或者通过GD-Plug UI来初始化项目，这通常意味着在项目的根目录下创建或设置addons/plug gd脚本，并且初始化gd-plug环境。例如，使用Godot运行以下命令来初始化项目:

  godot --headless -s addons/plug gd init
  

• _plugging() 函数: 在addons/plug gd脚本中定义的这个函数是实际声明和管理插件的地方。它不对应于一个启动文件，而是一种脚本内编程接口，用于指定项目将使用的插件列表。

3. 项目的配置文件介绍

GD-Plug的配置主要体现在两个方面：

(a) 插件声明配置（位于你的项目中）

• 文件位置: 用户应在项目根目录下的addons/plug gd扩展脚本中进行插件的声明。
• 示例内容:

  extends "res://addons/gd-plug/plug gd"
  
  func _plugging():
      plug("imjp94/UIDesignTool")
      # 更多插件声明...
  

  上述示例表明了如何在_plugging()函数内部声明需要管理的插件，这些插件将在gd-plug的控制下被安装、更新或卸载。

(b) 动态配置与命令行参数

• 虽然GD-Plug的核心配置主要通过上述脚本进行，但在运行时还可以通过命令行参数传递附加选项或执行特定动作，如更新、初始化、卸载等。
• 例如，使用godot --headless -s plug gd install来安装插件，或通过gd-plug-ui进行图形化配置和管理。

通过这种方式，GD-Plug提供了一个灵活且强大的方式来管理和维护Godot项目的插件生态，简化了开发者的插件管理工作流。

gd-plugMinimal plugin manager for Godot项目地址:https://gitcode.com/gh_mirrors/gd/gd-plug