|
1 | | -## Houdini add-on for Sublime Text |
2 | | -Syntax highligting, completions, snippets and documentation popups for VEX and HScript languages bundled with Houdini. |
| 1 | +## HScript add-on for Sublime Text |
| 2 | +Syntax highligting, completions, snippets and documentation popups for HScript and HScript Expression languages bundled with Houdini. |
3 | 3 |
|
4 | | - |
5 | | -### Installation |
6 | | -See [Releases](https://github.com/teared/vex/releases). |
7 | | - |
8 | | - |
9 | | -### Features |
10 | | - |
11 | | -#### VEX |
12 | | - |
13 | | - |
14 | | - |
15 | | -#### VEX Wrangle (and function completion) |
16 | | -Press `Ctrl+Space` or start typing to open completions list. Choose function you need. Navigate back and forth using `Tab` and `Shift+Tab`. |
17 | | - |
18 | | - |
19 | | - |
20 | | -#### Popups |
21 | | -Default shortcut is `Ctrl+Alt+D`, also available as command "VEX: Show Documentation for Function" in Command Palette. |
22 | | - |
23 | | - |
24 | | - |
25 | | -#### Compiler Errors |
26 | | -Press `F7` to build code and see compiler errors. Two build systems available in Command Palette: |
27 | | - |
28 | | -1. `VEX Build` is an experimental and most useful: it will wrap source code into a function definition and build as CVex shader. It is possible to compile small pieces of code like wrangles. |
29 | | -2. `VEX Build - As Shader` is a simple wrapper for VCC, build VEX shaders with it. |
30 | | - |
31 | | -It's not possible to evaluate expressions outside Houdini session, therefore they are not supported by this feature. Stuff like `$PI` or embedded backticks will produce syntax errors but will work normally inside Houdini. Evaluate parameter with middle mouse button and use resulting string as code. |
32 | | - |
33 | | - |
34 | | - |
35 | | -#### HScript Expressions |
36 | | - |
37 | | - |
38 | | - |
39 | | -#### HScript |
40 | | - |
41 | | - |
42 | | - |
43 | | - |
44 | | -### License |
45 | | -Public domain. Some files contains pieces of publicly available Houdini documentation. Such parts are property of SideFX. |
| 4 | +## Installation |
| 5 | +Work in progress. Check in a few days. |
0 commit comments