cgtoolbox / vscode-houdinivexhelp

vscode extension to display Houdini vex help page from selection.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Houdini Vex Help

This extension mimics the behavior of the wrangle nodes "open help from selected text", but directly in vscode.

Features

Select a function name in your code, run the command "Open Vex Help" from the command palette (ctrl+shift+p) or press F2, and it opens the help pages from the Houdini help of the function you selected.

Requirements

This extension is very handy to use with the VEX language support for VSCode by Mel Massadian.

In order to use VSCode seamlessly on your wrangle nodes, you can use the plugin HoudiniExprEditor from www.cgtoolbox.com.

If you want to use builtin Houdini help server (see 'settings'), Houdini must be installed on your machine.

Settings

houdinivexhelp.houdiniHelpURL can be set to the base URL you want to use, you can set it to either sidefx website or local default builtin help from Houdini (http://127.0.0.1:48626/vex/functions/")

Default: https://www.sidefx.com/docs/houdini18.5/vex/functions/

it MUST end with '/'. Your current text selection will be added at the end of the URL.

Release Notes

0.0.3

Clean selected text before constructing the url adress. Change default value of the setting houdinivexhelp.houdiniHelpURL.

0.0.2

Add setting "houdinivexhelp.houdiniHelpURL"

0.0.1

Initial release of Houdini Vex Help for VSCode


Any issues or feedback, feel free to reach me here:

www.cgtoolbox.com

contact@cgtoolbox.com

https://github.com/cgtoolbox


**Enjoy! :) **

About

vscode extension to display Houdini vex help page from selection.


Languages

Language:TypeScript 100.0%