Use the plugininfo tool to list V-Ray plugins and inspect their parameters in V-Ray for SketchUp.
Overview
The plugininfo tool generates documentation for all V-Ray plugins. Use the commands in the Options table to list all plugins or view details for a specific plugin.
The tool lists only core V-Ray plugin parameters. It does not list user data parameters.
User data parameters handle communication between V-Ray for SketchUp and its UI. V-Ray sets the corresponding core scene parameters only at render time.
To find the exact user data parameter names, export these V-Ray files:
- For Settings, export a .vropt file.
- For Assets, export an asset of the required type as a .vrmat file.
The parameter handlers for user data parameters contain isUserData="1".
Installation
Windows | C:\Program Files\Chaos\V-Ray\V-Ray for SketchUp\extension\vray\bin |
Windows | C:\Program Files\Chaos\V-Ray\V-Ray for SketchUp\extension\vray\bin |
macOS | /Applications/Chaos/V-Ray/V-Ray for SketchUp/extension/vray/bin |
Usage
Options
Use this syntax to access the tool's options:
plugininfo [ options ] -list [ <plugin name> ]
Lists all V-Ray plugins.
If you specify <plugin name>, the tool prints only plugins with matching names. You can use the wildcard symbol '*'.
plugininfo [ options ] <plugin name>
Displays the specified plugin's ID, location and supported interfaces. It also lists its parameters, their types, default values, descriptions and optional UI guides in this format:
<parameter name> : <type> <default value> /* <optional description> */ { <optional ui guides> }
Option | Description |
|---|
Option | Description |
|---|---|
-plugindir <plugin directory> | Sets the plugin search directory. The default is './plugins'. |
-listByCategory | Lists plugins by category. |
-pluginInterface <interface id/name> | Processes only plugins that support the specified interface. Valid interface names are: |
-json | Displays plugin descriptions in JSON format. If you specify a plugin name, it formats only that plugin. Otherwise, it formats all plugins. With -outputDir, it saves each plugin's JSON in a separate file in that directory. The filename should be '<plugin name>.json'. Otherwise, it sends the output to standard output. |
-html | Generates HTML documentation. |
-htmlOutput|-outputDir <output directory> | Sets the output directory for HTML or JSON files. |
-id | Displays the plugin's unique identifier. |
-interfaces | Displays supported interfaces. |
-lib | Displays the path to the plugin's shared library. |
-ui | Displays UI guides for plugin parameters. |
-paramName <param name> | Searches for parameters that match the specified string. You can use the wildcard symbol '*'. |
-input <param type> | Displays input parameters of the specified type. If you do not specify a plugin, it displays all plugins with that input parameter type. |
-output <param type> | Displays output parameters of the specified type. If you do not specify a plugin, it displays all plugins with that output parameter type. |
-printRawData | Prints only raw data with additional information, suitable for use in pipes. |