mcshader-lsp/README.md

2.7 KiB

vscode-mc-shader

CI Issues license Maintainability

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 (unpolished)
  • Syntax highlighting (by extension dependency)
  • Support for #includes directives
  • Auto-complete prompts (incomplete)

Planned

  • Warnings for unused uniforms/varyings
  • Some cool DRAWBUFFERS stuff

Got a feature request? Chuck it into an Issue!

Requirements

  • Visual Studio Code (v1.17.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.
  • The OpenGL / OpenGL ES Reference Compiler (for convenience, put it in your PATH, this is the assumed location if not specified). If, for some reason, you're using MacOS, there are no pre-compiled binaries of this.
  • [MacOS] Not MacOS. Not that you're making MC Shaders on/for MacOS anyways...right?

Extension Settings

Option Name Data Type Description Default Value
mcglsl.glslangValidatorPath string The path to the glslangValidator executable. In your PATH.
mcglsl.lintOnType bool Whether or not to lint while typing. Can decrease performance. false
mcglsl.shaderpacksPath string The path to the shaderpacks folder in your Minecraft installation folder. None

Contributing

Please see CONTRIBUTING.md.

Known Issues

I'll fill this in once this actually gets released.

Release Notes

None yet.

License

This code is released under the MIT License. Copyright (c) 2018 Noah Santschi-Cooney