quickgd.nvim's Introduction

quickgd.nvim

Tools for neovim that comes with helpfull godot / tscn launch commands, setup for treesitter and auto-completion for gdshader.

quickgd.nvim_example_1.mp4

✨ Features

Dynamic auto-completion for gdshaders including all shader types.
Use GLSL to setup up treesitter in gdshaders.
Quick launch commands.

⛑ Requirements

nvim-telescope needed to use telescope else disable in settings.
nvim-treesitter needed for auto completion make sure you have GLTF parser installed.
nvim >= 0.8

📜 Commands

GodotRun - Opens a selecter where you can pick a tscn to run.
GodotRunLast - Runs the last chosen tscn from GodotRun.
GodotStart - Opens your current Godot project located in your working directory.

🔌 Install

💤 Lazy

{
  "QuickGD/quickgd.nvim",
  ft = {"gdshader", "gdshaderinc"}
  cmd = {"GodotRun","GodotRunLast","GodotStart"},
  -- Use opts if passing in settings else use config
  init = function()
    vim.filetype.add {
      extension = {
        gdshaderinc = "gdshaderinc",
      },
    }
  end,
  config = true
  opts = {} -- remove config and use this if changing settings.
}

📦 Packer

{
  "QuickGD/quickgd.nvim",
  config = function()
    vim.filetype.add {
      extension = {
        gdshaderinc = "gdshaderinc",
      },
    }
    require("quickgd").setup() {
      -- settings
    } 
  end,
}

📝 CMP

    sources = {
      { name = "nvim_lsp", priority = 1000 },
      { name = "quickgd", priority = 750 }, -- make sure to add quickgd to your source list
      { name = "luasnip", priority = 700 },
      { name = "path", priority = 650 },
      { name = "buffer", priority = 400 },
    },

⚙ Settings

   {
    -- Sets the path of your Godot executable.    
    -- Will look for path in GODOT environment variable if not set.
    godot_path = "/path/to/godot"
    -- If opened in project root folder path will already be set.
    project_path = "path/to"
    -- If set to false will use internal selector.
    telescope = true
    -- Enables GLSL treesitter for gdshader / gdshaderinc. 
    treesitter = true, -- optional: needed for cmp
    -- Disable if you don't want the autocompletion.
    cmp = true, -- optional
  }

Recommend Projects