---
title: "Plugininfo Tool"
canonical: "https://documentation.chaos.com/space/VRHINO/116131044/Plugininfo%20Tool"
format: markdown
---
<span style="color: #172b4d">The following page provides information on the plugininfo tool.</span>

## **Overview**

---

<span style="color: #172b4d">The plugininfo tool generates documentation for all V-Ray plugins. It can be used to list all V-Ray plugins or to display a detailed information for a specific one by using the commands from the </span><span style="color: #172b4d">**Options**</span><span style="color: #172b4d"> table.</span>  
Note that plugininfo displays only core V-Ray plugin parameters. User data parameters are not listed.

*User data* parameters are employed in the communication between V-Ray for Rhino and its UI, whereas the actual scene parameters (V-ray core) are set accordingly only at render time.  
The precise names of such *user data *parameters can be found in exported V-Ray files:

- for Settings - export a .*vropt* file
- for Assets - export an asset of the required type as a .*vrmat* file

Their parameter handlers contain `isUserData="1"`

## **Usage**

---

<span style="color: #172b4d">To run the plugininfo tool, its active directory needs to be changed to the V-Ray bin directory. A simple way to do it is by running the following line in command prompt:</span>

```
cd "C:\Program Files\Chaos\V-Ray\V-Ray for Rhinoceros\vrayappsdk\bin" && "C:\Program Files\Chaos\V-Ray\V-Ray for Rhinoceros\vrayappsdk\bin\plugininfo.exe"
```

The tool's options can be accessed using the following syntax:


**plugininfo [ options ] -list [ <plugin name> ]**

Lists all V-Ray plugins.

When <plugin name> is given, only plugins that match the given name are printed. Note that the wildcard symbol '*'  is supported.


**plugininfo [ options ] <plugin name>**

Displays detailed description for the specified plugin - plugin id, location, supported interfaces, parameters, their types, default values, description, and optional ui guides in the following format:

<parameter name> : <type> <default value> /* <optional description> */  { <optional ui guides> }


### **Options**

---

| **Option** | **Description** |
| --- | --- |
| **-plugindir <plugin** **directory>** | Passes plugin search directory. If not specified, the directory './plugins' is used by default.  
More than one directory can be specified, separated by '**;**' (on Windows) or '**:**' (on Linux). The [environment variable](https://docs-chaos.atlassian.net/wiki/spaces/VNS/pages/115605616) VRAY_PLUGINS_x64 can be used to specify additional plugin paths. |
| **-listByCategory** | Lists plugins by categories. |
| **-pluginInterface <interface id/name>** | Processes plugins that support only specified interface. Valid interface names are:  
EXT_BITMAP, EXT_BSDF, EXT_GEOM_GEN, EXT_GEOM_PARTICLE_DATA, EXT_LIGHT,  
EXT_LIGHT_LINKER, EXT_LIGHT_LIST, EXT_MAPPED_SURFACE, EXT_MATERIAL,  
EXT_REFERENCED_SURFACE, EXT_RENDER_CHANNEL, EXT_RENDER_VIEW, EXT_STATIC_GEOM_SOURCE,  
EXT_TEXTURE, EXT_TEXTURE_FLOAT, EXT_TEXTURE_INT, EXT_TEXTURE_MATRIX,  
EXT_TEXTURE_TRANSFORM, EXT_TEXTURE_VECTOR, EXT_UVWGEN, EXT_VOLUMETRIC,  
EXT_VRAY_PER_PARTICLE_DATA |
| **-json** | Displays plugin description in JSON format. If plugin name is given, only formatting for that plugin is generated; otherwise all plugins are formatted. When -outputDir is given, JSON formatting for each plugin is saved in a separate file in that directory. The file should be saved as '<plugin name>.json', otherwise output is passed to the standard output. |
| **-html** | Generates HTML documentation. |
| **-htmlOutput|-outputDir <output directory>** | Sets output directory for HTML/JSON formatting. |
| **-id** | Displays unique plugin identifier. |
| **-interfaces** | Displays supported interfaces. |
| **-lib** | Displays path to the plugin shared library. |
| **-ui** | Displays UI guides for plugin parameters. |
| **-paramName <param name>** | Searches for parameters that match specified string (supports the wildcard symbol '*****'). |
| **-input <param type>** | Displays input parameters of a given type. If plugin is not specified, all plugins with such input parameter type are displayed.  
Valid input types are:  
integer, float, double, bool, vector, color, acolor, matrix, transform, string, plugin, acolor texture, float texture, integer texture, vector texture, matrix texture, transform texture, any |
| **-output <param type>** | Displays output parameters of a given type. If plugin is not specified, all plugins with such output parameter type are displayed.  
Valid output types are:  
transform, acolor texture, float texture, integer texture, vector texture, matrix texture, transform texture, any. |
| **-printRawData** | Prints only raw data with additional info (suitable for 'pipes'). |