Skip to content

Commit a810829

Browse files
committed
chore: Update docs
1 parent d99d397 commit a810829

File tree

3 files changed

+24
-6
lines changed

3 files changed

+24
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ aims to be memory-efficient and editor-agnostic.
7070

7171
### VSCode
7272

73-
Work in progress
73+
[Install the extension](https://marketplace.visualstudio.com/items?itemName=armsnyder.gdshader-language-server)
7474

7575
## Roadmap
7676

@@ -79,14 +79,14 @@ Planned features:
7979
- [x] Basic keyword completion
8080
- [x] Basic shader-type-dependent global built-in completion
8181
(`VERTEX`, `NORMAL`, etc.)
82+
- [x] VSCode wrapper extension
8283
- [ ] Built-ins for shader types other than `spatial`
8384
- [ ] More advanced completion (functions, variables, etc.)
8485
- [ ] Go to definition
8586
- [ ] Find references
8687
- [ ] Formatting
8788
- [ ] Hover (show documentation)
8889
- [ ] Signature help
89-
- [ ] VSCode wrapper extension
9090
- [ ] Make the code more maintainable by generating rules based on the official
9191
Godot documentation
9292
- [ ] [Grammar](https://code.visualstudio.com/api/references/contribution-points#contributes.grammars)

vscode-extension/README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,28 @@
1+
# GDShader
2+
13
[![GitHub Repo Stars](https://img.shields.io/github/stars/armsnyder/gdshader-language-server)](https://github.com/armsnyder/gdshader-language-server)
24
[![GitHub Issues](https://img.shields.io/github/issues/armsnyder/gdshader-language-server)](https://github.com/armsnyder/gdshader-language-server/issues)
35
[![Go Report Card](https://goreportcard.com/badge/github.com/armsnyder/gdshader-language-server)](https://goreportcard.com/report/github.com/armsnyder/gdshader-language-server)
46

57
This extension provides language support for Godot's `.gdshader` files.
68

7-
### 🚧 Preview Status
9+
## 🚧 Preview Status
810

911
This extension is in its early stages and currently only supports basic keyword
10-
completion. Once I deem it useful enough I will remove the preview status.
12+
completion. Once it reaches a more stable and useful state, I will remove the
13+
preview status.
14+
15+
## 🔄 Alternatives
16+
17+
You should know about other extensions that provide similar functionality, most
18+
of which are more mature than this one, currently.
19+
20+
- [gdshader-lsp](https://marketplace.visualstudio.com/items?itemName=godofavacyn.gdshader-lsp)
21+
- Shares similar goals. Currently has limited OS support and shows unexpected
22+
error diagnostics on code.
23+
24+
- [godot-tools](https://marketplace.visualstudio.com/items?itemName=geequlim.godot-tools)
25+
- Adds syntax highlighting. Does not include autocomplete.
26+
27+
- [Godot Files](https://marketplace.visualstudio.com/items?itemName=alfish.godot-files)
28+
- Adds syntax highlighting. Autocomplete is in early access.

vscode-extension/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"$schema": "https://www.schemastore.org/package.json",
33
"name": "gdshader-language-server",
44
"version": "0.3.0",
5-
"description": "Language support for .gdshader files",
5+
"description": "Language support for Godot's .gdshader files",
66
"author": "armsnyder",
77
"main": "./src/extension.js",
88
"type": "commonjs",
@@ -30,7 +30,7 @@
3030
"vscode-languageclient": "^9.0.1"
3131
},
3232
"publisher": "armsnyder",
33-
"displayName": "Godot Shader Language",
33+
"displayName": "GDShader",
3434
"icon": "icon.png",
3535
"preview": true,
3636
"engines": {

0 commit comments

Comments
 (0)