language-servers/mcshader-lsp
1
0
Fork 0
mirror of https://github.com/Strum355/mcshader-lsp.git synced 2025-08-04 00:49:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated readme for new 'direction'

Browse source
This commit is contained in:
Noah Santschi-Cooney 2021-01-29 21:24:19 +00:00
parent 37ed094941
commit ff57236283
No known key found for this signature in database
GPG key ID: 3B22282472C8AE48
1 changed files with 18 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -1,25 +1,25 @@
# Minecraft GLSL Shaders
## vscode-mc-shader
# Minecraft GLSL Shaders Language Server
## mcshader-lsp
[![Marketplace Version](https://vsmarketplacebadge.apphb.com/version/strum355.vscode-mc-shader.svg)](https://marketplace.visualstudio.com/items?itemName=strum355.vscode-mc-shader) [![Installs](https://vsmarketplacebadge.apphb.com/installs/strum355.vscode-mc-shader.svg)](https://marketplace.visualstudio.com/items?itemName=strum355.vscode-mc-shader)
[![license](https://img.shields.io/github/license/Strum355/vscode-mc-shader.svg)](https://github.com/Strum355/vscode-mc-shader)
[![Issues](https://img.shields.io/github/issues-raw/Strum355/vscode-mc-shader.svg)](https://github.com/Strum355/vscode-mc-shader/issues)
[![Build Status](https://cloud.drone.io/api/badges/Strum355/vscode-mc-shader/status.svg)](https://cloud.drone.io/Strum355/vscode-mc-shader)
[![license](https://img.shields.io/github/license/Strum355/vscode-mc-shader.svg)](https://github.com/Strum355/mcshader-lsp)
[![Issues](https://img.shields.io/github/issues-raw/Strum355/mcshader-lsp.svg)](https://github.com/Strum355/mcshader-lsp/issues)
[![Build Status](https://img.shields.io/drone/build/Strum355/mcshader-lsp)](https://cloud.drone.io/Strum355/mcshader-lsp)
<!-- It doesnt seem to like these :<
[![CI](https://ci.netsoc.co/api/badges/Strum355/vscode-mc-shader/status.svg?branch=master)](https://ci.netsoc.co/Strum355/vscode-mc-shader)
-->
mcshader-lsp is a [Language Server](https://langserver.org/) and collection of editor extensions for developing Minecraft GLSL Shaders for [Optifine](http://optifine.net). It currently provides linting and syntax highlighting.
VSCode-mc-shader is a [Visual Studio Code](https://code.visualstudio.com/) extension for developing Minecraft GLSL Shaders for [Optifine](http://optifine.net). It currently provides linting and syntax highlighting (by stef-levesque/vscode-shader dependency).
Currently supported editors:
<img src="https://github.com/Strum355/vscode-mc-shader/raw/master/logo.png" width="20%" height="20%">
- [Visual Studio Code](https://code.visualstudio.com/)
<img src="https://github.com/Strum355/mcshader-lsp/raw/master/logo.png" width="20%" height="20%">
## Features
- Linting
- Syntax highlighting (by extension dependency)
- Support for `#include` directives
- Auto-complete prompts (incomplete and rough)
<!-- - Auto-complete prompts (incomplete and rough) -->
## Installation (assumes installing from VSCode extension tab)
@ -30,21 +30,19 @@ VSCode-mc-shader is a [Visual Studio Code](https://code.visualstudio.com/) exten
## Requirements
- Visual Studio Code (v1.23.0 or higher - minimum requirement untested).
- Visual Studio Code (v1.43.0 or higher - minimum requirement untested).
- The [Shader languages support for VS Code](https://marketplace.visualstudio.com/items?itemName=slevesque.shader) 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](https://github.com/KhronosGroup/glslang). The extension will give you an option to download it and update your settings automatically.
## Extension Settings
<!-- ## Extension Settings
| Option Name | Data Type | Description | Default Value |
| ----------- | --------- | ----------- | ------------- |
| `mcglsl.glslangValidatorPath` | string | The path to the glslangValidator executable. | In your `PATH`.|
| `mcglsl.glslangValidatorPath` | string | The path to the glslangValidator executable. | In your `PATH`.| -->
## Contributing
Please see [CONTRIBUTING.md](https://github.com/Strum355/vscode-mc-shader/blob/master/CONTRIBUTING.md).
Please see [CONTRIBUTING.md](https://github.com/Strum355/mcshader-lsp/blob/master/CONTRIBUTING.md).
## Planned
@ -56,12 +54,12 @@ Got a feature request? Chuck it into an Issue!
## Known Issues
Check the issues on Github [here](https://github.com/Strum355/vscode-mc-shader/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug).
Check the issues on Github [here](https://github.com/Strum355/mcshader-lsp/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug).
## Release Notes
Check [CHANGELOG.md](https://github.com/Strum355/vscode-mc-shader/blob/master/CHANGELOG.md).
Check [CHANGELOG.md](https://github.com/Strum355/mcshader-lsp/blob/master/CHANGELOG.md).
## License
This code is released under the [MIT License](https://github.com/Strum355/vscode-mc-shader/blob/master/LICENSE). Copyright (c) 2018 Noah Santschi-Cooney
This code is released under the [MIT License](https://github.com/Strum355/mcshader-lsp/blob/master/LICENSE). Copyright (c) 2018 Noah Santschi-Cooney