Vimdow

About

Tired of godot's in-house script editor? Vimdow can let you use the comfort of your own neovim config to edit text for any file you want!

Vimdow can be installed like a regular plugin off of the asset store, or it can be downloaded as a standalone neovim client for your system.

What's neovim?

If you don't know, watch this.

In short it's a keyboard centric text editor that can enable high productivity should you choose to master it. It also follows the philosophy of "Configuration as Code", meaning you can create a highly personalized environment suited to your needs.

Vimdow aims to provide this accessibility to Godot developers!

Project Goals / Features

• A customizable neovim frontend, configurable via themes
• Portability, vimdow can work wherever Godot can
• A neovim experience that is seamless between both the Godot editor and using Neovim on your own system

Configuration

Requirements: Neovim 0.11 or later.

Vimdow only needs to know where Neovim's binary is located on your system to get working. By default both modes assume that your on linux and set the path to /usr/bin/nvim

Plugin mode

Path to neovim

To tell the plugin where Neovim is, check your Project Settings and paste the path to the binary in "vimdow/path_to_nvim"

Theme

Edit addons/vimdow/vimdow_theme.tres in the editor to do things like change fonts and default font size.

Shortcuts

Keyboard shortcuts (such as font size) are located under Editor Settings > Shortcuts > Vimdow.

Lua plugin

Vimdow is also a neovim plugin. The code for it is located in addons/vimdow/lua. In it is the init.lua script that is used on neovim startup with the -S flag. The other file is the configurations, the defaults of which are:

{
    -- Default keybindings for vimdow actions
    keybinds = {
        toggle_breakpoint = "<leader>gb",
        clear_breakpoints = "<leader>cb",
        release_focus = "<C-Esc>"
    },

    -- default color themes
    colors = {
        -- color when a brekpoint gutter is hovered with a mouse
        breakpoint_hover = "#ffabb2",

        -- color when a breakpoint is set
        set_breakpoint = "#ff0016"
    },
}

Standalone mode

Vimdow as a standalone client looks for a godot ConfigFile on your system. It checks for an environment variable called VIMDOW_CONFIG_PATH, but by default it will search for user://vimdow.cfg.

Default config file

[neovim]

path_to_nvim="/usr/bin/nvim"

[theme]
font_size=16

# Set these keys for font files. 
# They can be relative to the path of the config file
normal = "./path/to/normal.ttf"
bold = "../path/to/bold.ttf"
italic = "/path/to/italic.ttf"

Contributing

Vimdow is open source and open to any and all contributions. If you need a quick and easy introduction to the steps of compilation and source code, check out [CONTRIBUTING.md]