gdshader-language-server

README

Godot Shader Language Server

External editor support for .gdshader files.

[!WARNING] 🚧 Early Work in Progress

This project is in its infancy and currently only supports some basic keyword completion. Feel free to ⭐ the repo to track progress and signal to me that there is interest!

Godot's shader language is powerful, but editing .gdshader files outside the Godot editor is painful. This project aims to bring proper language tooling (autocomplete, hover, references, etc.) to editors like Neovim and VSCode.

📦 Install

Neovim

1. Install from source:

   go install github.com/armsnyder/gdshader-language-server@latest
   

2. Create a ~/.config/nvim/after/ftplugin/gdshader.lua file with the following content, adjusting the path to the gdshader-language-server binary if necessary:

   vim.lsp.start({
     name = "gdshader",
     cmd = { vim.fs.expand('~/go/bin/gdshader-language-server') },
     capabilities = vim.lsp.protocol.make_client_capabilities(),
   })
   

VSCode

Coming soon? Contributions welcome!

Roadmap

Planned features:

• Basic keyword completion
• Basic shader-type-dependent global built-in completion (VERTEX, NORMAL, etc.)
• More advanced completion (functions, variables, etc.)
• Go to definition
• Find references
• Formatting
• Hover (show documentation)
• Signature help
• VSCode wrapper extension

🤝 Contributing

I love to see issues and pull requests! Just note that this is a side project for me, and I cannot promise to respond quickly. I will generally accept pull requests which are relevant to the project goals, are tested, and follow existing code conventions.

📁 Code structure

.
├── main.go  # Entry point
└── internal
    ├── app       # Main application logic
    ├── ast       # .gdshader file parser library (application agnostic)
    ├── lsp       # LSP server library (application agnostic)
    └── testutil  # Test utilities for all packages

License

MIT