Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SpontanCombust committed Jun 7, 2024
1 parent ff588aa commit 73434e9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/dev-manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Here you will find the information you need if you want to contribute to this pr
- `crates` - Rust packages forming WIDE. The main crate is `lsp`, which contains language server implementation
- `docs` - project documentation from which this website is built
- `editors` - contains implementations of WitcherScript language client, currently just `vscode` client written in TypeScript
- `media` - all sorts of visual assets used throughout the repository
- `schemas` - contains `witcherscript.toml` schema
- `xtask` - code for build commands to speed up development

Expand Down
9 changes: 6 additions & 3 deletions docs/user-manual/editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
<source src="../../assets/user-manual/editor/project-creation.mp4" type="video/mp4">
</video>

:material-information-outline: Loading REDkit projects is also natively supported with some prior requirements outlined [here](./project-system.md#redkit-project).

- syntax highlighting

![Syntax Highlighting](../assets/user-manual/editor/syntax-highlighting.jpg)
Expand All @@ -34,8 +36,6 @@
<source src="../../assets/user-manual/editor/goto-definition.mp4" type="video/mp4">
</video>

- support for REDKit projects

**More coming soon!**


Expand Down Expand Up @@ -88,5 +88,8 @@ Path to Witcher 3's root game directory (containing bin, content, Mods folders e
### `witcherscript-ide.contentRepositories`
Paths to custom directories containing WitcherScript contents. Useful when not having Witcher 3 installed on your local machine or when simply storing scripts outside of game directory.

### `witcherscript-ide.enableLanguageServer`
Enable the language server. True by default. You can disable this if you only want syntax highlighting. Change requires extension reload.

### `witcherscript-ide.debug.enableDebugFeatures`
Enables debug features used for development. False by default. Requires extension reload when changed.
Enables debug features used for development. False by default. Change requires extension reload.

0 comments on commit 73434e9

Please sign in to comment.