mirror of https://github.com/Strum355/mcshader-lsp.git synced 2025-08-04 00:49:17 +00:00

A language server and Visual Studio Code extension for Minecraft GLSL Shaders

glsl language-server-protocol minecraft minecraft-glsl-shaders opengl rust-language-server visual-studio-code

Find a file

Noah Santschi-Cooney 19f92baba9 geometry shader support apparently? idfk		2021-01-25 23:20:27 +00:00
.vscode	Small cleanup of project files	2020-08-15 21:07:06 +01:00
client	Updated validator output parsing for new method	2021-01-12 00:01:56 +00:00
server	geometry shader support apparently? idfk	2021-01-25 23:20:27 +00:00
.drone.yml	Fixed getting nodes root ancestors	2020-08-07 00:58:34 +01:00
.gitignore	Include graph building	2020-02-15 19:29:20 +00:00
CHANGELOG.md	v0.8.5	2018-08-25 23:55:19 +01:00
CONTRIBUTING.md	Small cleanup of project files	2020-08-15 21:07:06 +01:00
LICENSE	Small cleanup of project files	2020-08-15 21:07:06 +01:00
logo.png	Hopefully the last time i work the logo : )	2018-07-04 01:27:43 +01:00
package-lock.json	Improved client-server integration	2020-07-17 15:31:27 +01:00
package.json	Added "Show flattened file" command to display a fully flattened top-level file in vscode virtual doc	2021-01-10 23:40:46 +00:00
README.md	Fixed getting nodes root ancestors	2020-08-07 00:58:34 +01:00
shaders.py	Some basic completion provider. Need to go through all the options and tweak them	2018-06-04 20:25:57 +01:00
tsconfig.json	Moved to vscode provided global file storage path to DL glslangValidator	2020-07-18 23:11:26 +01:00

README.md

Minecraft GLSL Shaders

vscode-mc-shader

VSCode-mc-shader is a Visual Studio Code extension for developing Minecraft GLSL Shaders for Optifine. It currently provides linting and syntax highlighting (by stef-levesque/vscode-shader dependency).

Features

Linting
Syntax highlighting (by extension dependency)
Support for #include directives
Auto-complete prompts (incomplete and rough)

Installation (assumes installing from VSCode extension tab)

After reloading, open a shaderpack's folder.
You should be prompted to set your shaderpacks folder e.g. "mcglsl.shaderpacksPath": "C:/Users/Noah/AppData/Roaming/.minecraft/shaderpacks"
You should then be prompted saying glslangValidator isn't installed. Hit the download button and wait for a notification saying that it's been installed.
You should now be good to go!

Requirements

Visual Studio Code (v1.23.0 or higher - minimum requirement untested).
The Shader languages support for VS Code extension. This should automatically install when you install this extension.
That the shader(s) you're editing are in the shaderpacks folder in .minecraft.
That you've only one shader folder open. Multiple workspaces aren't currently supported.
The OpenGL / OpenGL ES Reference Compiler. The extension will give you an option to download it and update your settings automatically.

Extension Settings

Option Name	Data Type	Description	Default Value
`mcglsl.glslangValidatorPath`	string	The path to the glslangValidator executable.	In your `PATH`.

Contributing

Please see CONTRIBUTING.md.

Planned

Multi-workspaces (currently only one is supported and using multiple is very undefined behaviour)
Warnings for unused uniforms/varyings
Some cool DRAWBUFFERS stuff

Got a feature request? Chuck it into an Issue!

Known Issues

Check the issues on Github here.

Release Notes

Check CHANGELOG.md.