Edit of asset "GDScript Formatter" Accepted
| Old/Current | New/Edit | |
|---|---|---|
| Title | GDScript Formatter | |
| Description |
## Features - Format with **shortcut** - Defaults to **Shift+Alt+F** - Format on save - Off by default, can be enabled by [editing the preferences in EditorSettings](#editing-preferences) - Format through **tool menu** - **Project -> Tool -> GDScript Formatter: Format script** - Format through **command palette** - Open the command palette (Default **Ctrl+Shift+P**) and run command `Format GDScript` ## Installation **GDScript Formatter** relies on [**GDToolkit**](https://github.com/Scony/godot-gdscript-toolkit) which uses Python and Pip package manager. You need to install them in order to use the addon. 1. Install Python (if you do not have it already) - Download installer from [https://www.python.org/downloads/] - Make sure to enable "Add python.exe to PATH" when installing - If you forget you can [add python.exe to PATH after installation](https://realpython.com/add-python-to-path/) - Pip is included with python 2. Install the Godot plugin - In Godot editor, click "AssetLib" and search "GDScript Formatter" - Install the plugin - Enable the plugin through **Project -> Project Settings -> Plugins** 3. Install GDToolkit - **Project -> Tool -> GDScript Formatter: Install/Update gdtoolkit** **Note: if your python is not install for all users, you might need to change the command by [editing the preference](# Editing Preferences)** ## Editing Preferences You can edit GDScript Formatter's behavior through the **Editor -> Editor Settings -> General -> GDScript Formatter**. You can change whether files are formatted on save, the gdformat command, line length, shortcut, and other values. If you need to change preference for specific project, you can check `GDScript_Formatter/custom_settings_enabled` and modify settings in **Project -> Project Settings -> General -> GDScript Formatter**. ## Others If this plugin can help you, please consider to [buy me a coffee](https://afdian.com/a/Daylily-Zeleen), I would try my best to release more plugins and maintain old plugins. ----------------------------------------------- 一个用于格式化GDSCript脚本的Godot4.x插件。 ## 特性 - 使用**快捷键**进行脚本格式化 - 默认快捷键为**Shift+Alt+F** - 保存脚本时自动格式化 - 默认关闭，通过在编辑器设置中[编辑偏好设置](#偏好设置)进行开启。 - 通过**工具菜单**进行格式化 - **项目 -> 工具 -> GDScript Formatter: Format script** - 通过**命令面板**进行格式化 - 打开命令面板(默认快捷键为**Ctrl+Shift+P**)并运行命令`Format GDScript`。 ## 安装 **GDScript Formatter**依赖于[**GDToolkit**](https://github.com/Scony/godot-gdscript-toolkit)。如果你没有自行安装**GDToolKit**，可使用本插件**安装/更新GDToolkit**的功能，这需要你先自行安装**Pip**（通过安装**Python**获得），具体步骤如下： 1. 安装Python（如果你没有安装的话） - 从 [https://www.python.org/downloads/] 下载Python安装包。 - 确保在安装时开启了"**Add python.exe to PATH**"选项 - 如果你忘记开启该选项，亦可[在安装之后将"python.exe"添加到PATH中](https://realpython.com/add-python-to-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命令等。 如果你需要为特定项目设置不同的偏好设置，可以在项目设置中（**项目 -> 项目设置 -> 通用 -> GDScript Formatter**）勾选上`GDScript_Formatter/custom_settings_enabled`并调整其他设置。 ## 其他 如果这个插件能帮到你还请为我[充电](https://afdian.com/a/Daylily-Zeleen)，我也会尽力推出新的插件和维护老的插件。 一个用于格式化GDSCript脚本的Godot4.x插件。 ## 特性 - 使用**快捷键**进行脚本格式化 - 默认快捷键为**Shift+Alt+F** - 保存脚本时自动格式化 - 默认关闭，通过在编辑器设置中[编辑偏好设置](#偏好设置)进行开启。 - 通过**工具菜单**进行格式化 - **项目 -> 工具 -> GDScript Formatter: Format script** - 通过**命令面板**进行格式化 - 打开命令面板(默认快捷键为**Ctrl+Shift+P**)并运行命令`Format GDScript`。 ## 安装 **GDScript Formatter**依赖于[**GDToolkit**](https://github.com/Scony/godot-gdscript-toolkit)。如果你没有自行安装**GDToolKit**，可使用本插件**安装/更新GDToolkit**的功能，这需要你先自行安装**Pip**（通过安装**Python**获得），具体步骤如下： 1. 安装Python（如果你没有安装的话） - 从 [https://www.python.org/downloads/] 下载Python安装包。 - 确保在安装时开启了"**Add python.exe to PATH**"选项 - 如果你忘记开启该选项，亦可[在安装之后将"python.exe"添加到PATH中](https://realpython.com/add-python-to-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命令等。 如果你需要为特定项目设置不同的偏好设置，可以在项目设置中（**项目 -> 项目设置 -> 通用 -> GDScript Formatter**）勾选上`GDScript_Formatter/custom_settings_enabled`并调整其他设置。 ## 其他 如果这个插件能帮到你还请为我[充电](https://afdian.com/a/Daylily-Zeleen)，我也会尽力推出新的插件和维护老的插件。 |
A Godot Editor (4.x) addon for formatting GDScript automatically. ## Features: - Format with shortcut - Defaults to **Shift+Alt+F** - Format on save - Off by default, can be enabled by [editing the preferences file](#editing-preferences) - Format through tool menu - **Project -> Tool -> GDScript Formatter: Format script** - Format through command palette - Open the command palette (Default **Ctrl+Shift+P**) and run command `Format GDScript` ## Installation GDScript Formatter relies on [GDToolkit](https://github.com/Scony/godot-gdscript-toolkit) which uses Python and Pip package manager. You need to install them in order to use the addon. 1. Install Python (if you do not have it already) - Download installer from [https://www.python.org/downloads/] - Make sure to enable "Add python.exe to PATH" when installing - If you forget you can [add python.exe to PATH after installation](https://realpython.com/add-python-to-path/) - Pip is included with python 2. Install the Godot plugin - In Godot editor, click "AssetLib" and search "GDScript Formatter" - Install the plugin - Enable the plugin through **Project -> Project Settings -> Plugins** 3. Install GDToolkit - **Project -> Tool -> GDScript Formatter: Install/Update gdtoolkit** ## Editing Preferences You can edit GDScript Formatter's behavior through the preferences file. Preferences are stored as a Godot resource located in `res://addons/gdscript_formatter/format_preference.tres`. Double click the file from Godot and you can change whether files are formatted on save, the gdformat command, line length, and other values. |
| Category | Tools | |
| License | MIT | |
| Repository Provider | GitHub | |
| Repository Url | https://github.com/Daylily-Zeleen/GDScript-Formatter | |
| Issues Url | https://github.com/Daylily-Zeleen/GDScript-Formatter/issues | |
| Godot version | Godot 4.2 | |
| Version String | 0.3.1 | |
| Download Commit | 9662dced76030eaf0df29503732fed3e9f4ee1b5 | 6703dc4b661a69463dfeff119a3419191b656304 |
| Download Url (Computed) | https://github.com/Daylily-Zeleen/GDScript-Formatter/archive/9662dced76030eaf0df29503732fed3e9f4ee1b5.zip | https://github.com/Daylily-Zeleen/GDScript-Formatter/archive/6703dc4b661a69463dfeff119a3419191b656304.zip |
| Icon Url |
https://raw.githubusercontent.com/Daylily-Zeleen/GDScript-Formatter/main/icon.png
|
|