README.zh.md

GDScript Formatter

Click here to English README.

一个用于格式化GDSCript脚本的Godot4.x插件。

特性

• 使用快捷键进行脚本格式化
  • 默认快捷键为Shift+Alt+F
• 保存脚本时自动格式化
  • 默认关闭，通过在编辑器设置中编辑偏好设置进行开启。
• 通过工具菜单进行格式化
  • 项目 -> 工具 -> GDScript Formatter: Format script
• 通过命令面板进行格式化
  • 打开命令面板(默认快捷键为Ctrl+Shift+P)并运行命令Format GDScript。

安装

GDScript Formatter依赖于GDToolkit。如果你没有自行安装GDToolKit，可使用本插件安装/更新GDToolkit的功能，这需要你先自行安装Pip（通过安装Python获得），具体步骤如下：

1. 安装Python（如果你没有安装的话）

   • 从 [https://www.python.org/downloads/] 下载Python安装包。
   • 确保在安装时开启了"Add python.exe to PATH"选项
     • 如果你忘记开启该选项，亦可在安装之后将"python.exe"添加到PATH中
   • Pip将被包含在Python中。

2. 在你的Godot项目中安装"GDScript Formatter"插件

   • 在Godot编辑器中，点击"AssetLib"并搜索"GDScript Formatter"
   • 安装该插件
   • 通过项目 -> 项目设置 -> 插件开启"GDScript Formatter"

3. 安装GDToolkit

   • 项目 -> 工具 -> GDScript Formatter: Install/Update gdtoolkit

   注意：如果你的Python仅为部分部分用户安装，可能需要前往编辑器设置来调整偏好设置中的命令。

偏好设置

你可以通过编辑编辑器设置来修改GDScript Formatter的行为（编辑器->通用->GDScript Formatter）。其中包括格式化时每行的最大长度，是否开启保存时自动格式化，快捷键，实际使用的pip命令，实际使用的gdformat命令等。

其他

如果这个插件能帮到你还请为我充电，我也会尽力推出新的插件和维护老的插件。