Godot Git 插件技术文档

Godot Git 插件技术文档

godot-git-plugin Git implementation of the VCS interface in Godot 项目地址: https://gitcode.com/gh_mirrors/go/godot-git-plugin

安装指南

平台二进制文件获取

1. 访问 GitHub Releases 页面，下载适用于您平台的二进制文件。
2. 根据 安装指南 进行安装。

源码编译安装

如果您希望从源码编译插件，请按照以下步骤操作：

所需工具

• 完整的源码副本。请使用 git clone --recursive 命令克隆仓库。
• SCons (v3.0.1+)
• C++17 和 C90 编译器，能够被 SCons 检测到并存在于 PATH 中。

平台特定设置

• Windows: 除了设置编译器外，无需额外步骤。
• MacOS:
  • 如果您希望构建适用于 Apple Silicon 和 x86_64 的通用版本，可以运行 build_openssl_universal_macos.sh 自行构建 OpenSSL，并替换 thirdparty/openssl/ 中的预构建库。否则，只需运行 brew install openssl@1.1 使用本仓库提供的预构建库。
• Linux: 运行 sudo apt-get install libssl-dev，或使用本地包管理器的等效命令。

发布构建

scons platform=<platform> target=editor -j 6

开发构建

当为 Godot VCS 集成开发新功能时，可能需要开发者对 GDExtension API 进行更改。这意味着我们需要从自定义 Godot 构建中手动生成 GDExtension API，并使用它来编译 godot-cpp，然后将生成的 godot-cpp 二进制文件链接到此插件中。

1. 从自定义 Godot 构建中转储新的绑定。

cd local/copy/of/godot/source
.\bin\godot.xxx --headless --dump-gdextension-interface --dump-extension-api

2. 与 godot-cpp 库一起构建插件。

scons platform=<platform> target=editor generate_bindings=yes dev_build=yes -j 6

项目使用说明

插件功能

Godot Git 插件允许您在 Godot 编辑器中直接与 Git 进行交互，无需离开编辑器。该插件使用 libgit2 作为后端，在代码中模拟 Git 操作。

使用步骤

1. 安装插件后，启动 Godot 编辑器。
2. 在编辑器中，您可以通过插件提供的界面进行 Git 操作，如提交、拉取、推送等。

项目API使用文档

API 概述

Godot Git 插件提供了一系列 API，允许开发者在其 Godot 项目中集成 Git 功能。这些 API 包括但不限于：

• Git.init(): 初始化一个新的 Git 仓库。
• Git.commit(): 提交更改。
• Git.pull(): 从远程仓库拉取更新。
• Git.push(): 将本地更改推送到远程仓库。

API 示例

# 初始化 Git 仓库
Git.init()

# 提交更改
Git.commit("Initial commit")

# 拉取远程更新
Git.pull()

# 推送本地更改
Git.push()

项目安装方式

二进制文件安装

1. 下载适用于您平台的二进制文件。
2. 按照安装指南进行安装。

源码编译安装

1. 克隆仓库并获取完整的源码副本。
2. 安装所需的工具和依赖。
3. 使用 SCons 进行构建。

通过以上步骤，您可以顺利安装并使用 Godot Git 插件，享受在 Godot 编辑器中直接进行 Git 操作的便利。

godot-git-plugin Git implementation of the VCS interface in Godot 项目地址: https://gitcode.com/gh_mirrors/go/godot-git-plugin