Godot 与 Vim 集成插件使用教程

Godot 与 Vim 集成插件使用教程

vim-godot Use vim and godot engine to make games 项目地址: https://gitcode.com/gh_mirrors/vi/vim-godot

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

vim-godot 插件旨在将 Godot 游戏引擎的开发流程与 Vim 编辑器相结合，提供一个更加舒适的开发环境。项目目录结构如下：

• autoload: 存放自动加载的 Vim 脚本文件。
• ftdetect: 用于检测文件类型并为其设置相应的文件类型插件。
• ftplugin: 文件类型插件的具体实现，包括语法高亮、代码折叠等功能。
• indent: 代码缩进相关的配置文件。
• syntax: 语法高亮定义文件。
• LICENSE: 项目许可证文件，本项目采用 MIT 许可。
• README.adoc: 项目说明文档。

2. 项目的启动文件介绍

项目的启动主要依赖于 Vim 的自动加载机制。当打开 .gd 或 .gsl 文件时，Vim 会自动加载 autoload 目录下的脚本，从而为 Godot 的脚本文件提供语法高亮、代码折叠等功能。

启动文件主要包括：

• autoload/godot.vim: 主启动脚本，定义了与 Godot 相关的 Vim 命令和映射。
• ftdetect/godot.vim: 用于检测 Godot 脚本文件类型。

3. 项目的配置文件介绍

配置文件用于自定义插件的各项功能，包括快捷键映射、代码折叠方式等。

• after/ftplugin/gdscript.vim: 用户自定义的文件类型插件设置，通常放置于 ~/.vim/after/ftplugin/ 目录下。可以在此文件中设置代码折叠方法、缩进宽度、制表符宽度等。

  例如：

  setlocal foldmethod=expr
  setlocal shiftwidth=4
  setlocal tabstop=4
  

• init.vim: Vim 的初始化文件，可以在这里添加自定义的快捷键映射。

  例如：

  nnoremap <buffer> <F4> :GodotRunLast<CR>
  nnoremap <buffer> <F5> :GodotRun<CR>
  nnoremap <buffer> <F6> :GodotRunCurrent<CR>
  nnoremap <buffer> <F7> :GodotRunFZF<CR>
  

以上是 vim-godot 插件的目录结构、启动文件和配置文件的简要介绍。通过这些配置，开发者可以在 Vim 中享受到更加便捷的 Godot 开发体验。

vim-godot Use vim and godot engine to make games 项目地址: https://gitcode.com/gh_mirrors/vi/vim-godot