How to use the plug-in function
Updated: 10/08/2025
Click here for information for developers.
Plugin Download Procedure
The plugins provided by nizima LIVE Official can be downloaded within the app.
1. Click Settings/Other -> Plug-ins.
2.Once the Plugin Manager launches, click the v button to the right of “Plugin Download” at the bottom to download any desired plugins.
3. Once the download completes, the folder will open automatically. Open the exe file to launch the plugin.
If the downloaded file is an installer, please install the plugin and run it.
Steps for downloading a plugin from GitHub
1. Download the sample plug-in from GitHub.
Select “Mouse Extender.”
2.Select “Mouse Extender 1.0.0” in Releases on the right side of the screen.
3.Download mouse-extender-X.X.X.zip, or mouse-extender-X.X.X-macOS-Apple.dmg for mac.
4.Extract the downloaded folder and open the exe file to launch the plugin.
How to Connect Plug-ins
1. Click Settings/Other -> Plug-ins.
2. After the Plug-in Manager starts, use the toggle at the top of the screen to enable the plug-in function.
To enable communication, the port number must be the same for nizima LIVE and the plug-in.
If the configured port number is not available, the port is automatically changed to one that is available.
3. Start the plug-in and connect with Connect.
4. The plug-in will be added to the Plug-in Manager on the nizima LIVE side.
Clicking ∨ on the right side of the screen opens a panel that displays the details of the plug-in.
If you wish to remove a plug-in, you can delete its registration by clicking the Delete button.
5. Activate the plug-in with the toggle on the left side of the screen.
The first time you perform this operation, you will see a pop-up window as shown in the figure. Confirm that the plug-in is the one you intended to use, and then activate it.
When the plug-in is activated, the toggle turns green and the plug-in function is available.
For plug-ins that can be started from nizima LIVE, the display is added as shown in the figure.
Notes
- When the plug-in is closed, the toggle turns yellow.
- When the plug-in is connected again, the toggle will return to green and the plug-in will be available immediately.
If the toggle is turned off, the plug-in will be disabled and the function will not be available.
Starting the Plug-in from nizima LIVE
The display is different for plug-ins that can be started from this software (top) and those that cannot (bottom).
For plug-ins that can be started from this software, the left side shows the path to the plug-in, and the right side shows some additional functions.
1. With the plug-in disconnected, press Start to activate the plug-in.
Click Open folder to open the parent folder of the plug-in.
If you select the Auto start checkbox, the plug-in will start automatically when nizima LIVE starts or when the plug-in function is enabled.
Notes
If a plug-in is changed, such as by being moved or updated, the Start button will be disabled. In this situation, the plug-in will not be able to start and will not start automatically.
Reconnect the plug-in manually to enable it to once more be started from nizima LIVE.
If you still cannot use the plug-in, delete the registration with the Delete button and try connecting the plug-in again.
How to Download and Use the Color Change Plug-in
| Port | Changes the port number. |
| Connect button | Connects to nizima LIVE. If a connection has already been established, it is disconnected. This button turns green when a connection is possible. |
| Model and item list | Lists the currently displayed model and items. |
| Log button | This button is mainly for developer use. Click it to see the communication of the plug-in. |
| Color designation sliders | You can specify the color with these sliders or a hexadecimal value. |
| Multiply/Add | Changes the method of combining the specified colors. |
| Reset button | Initializes the color of the model. |
| Target | Select All, Part(s), or Drawable Object. For Part(s) and Drawable Object, only those items in the tree below whose check boxes are selected are enabled. |
| About button | Displays the version and other information. |
How to Download and Use the Gamepad Plug-in
| Name | Displays the name of the connected controller. |
| Power | Displays the controller connection status. |
| Various parameters (Axis 0, LStickY, etc.) | Displays the names of user-defined parameters that are automatically added to nizima LIVE. Once the model parameters are associated with the automatically added parameters, the model will move according to the controller’s input. Since the number of Axis 0, Button 1, etc. varies depending on the controller hardware, we recommend using generic parameter names such as LStickX and RButtonRight in parentheses. Generic parameters marked with [Motionable] can perform the motion of the same name. If you set the “Display name” of a motion to “RButtonBottom” in the Expression/Motion window of nizima LIVE, that motion will automatically start when the button is pressed. After setting the display name, the plug-in needs to be reconnected, so either turn the plug-in on or off from the nizima LIVE plug-in window, or restart the plug-in. |
Tracking Value Blend Plugin
You can enter multiple tracking data points into the calculation field and link the calculation results to model parameters.
You can save calculation results as new input values (custom parameters) and use them as input values for other calculations.
You can export or import created settings as JSON files.
| Connect/Disconnect | Toggle the connection to nizimaLIVE ON/OFF. |
| Input Parameter Column | arameter IDs that can be used as input values are displayed in a toggle list for each source. Clicking the + button next to “Custom Parameters” allows you to add custom parameters. |
| Parameter Calculation Column | Parameter binding settings are listed in a row format. Settings with purple backgrounds are custom parameters, while settings with gray backgrounds are output parameters (model parameters). |
| Combo Box | Specifies output parameters. This is a list of Cubism parameters from the first model found upon connection. |
| Text Input Area | Sets input values. Parameter IDs from the Input Parameter Column appear in predictive text. Multiple IDs can be used. Additionally, arithmetic operations and functions such as max(x, y) and sqrt(x) are available. |
| Add | Adds a new row for parameter binding. If added by mistake, you can revert by pressing the delete button on the added row. |
| Delete | Deletes the parameter binding for the row containing this button. Once deleted, this action cannot be undone. |
| Output Parameter Column | Displays output parameters based on the bindings created in the Parameter Calculation Column. |
Top-Left Menu
- Save As
- Allows you to export the created parameter settings.
- Load from File
- Allows you to import previously created parameter settings.
- How to Use
- Displays instructions on how to use the application.
Effect Integration Plugin
You can link individual tracking data to effect parameters, allowing the effect’s appearance to change along with tracking variations.
The plugin allows you to toggle effects on and off from the plugin side. Adding or deleting effects is not supported.
Created settings can be exported as JSON files or imported from them.
| Connect/Disconnect | Toggles the connection with nizima LIVE. |
| Update | When effects are added on the nizima LIVE side, the plugin cannot yet recognize the parameters of those newly added effects. Pressing this button synchronizes with the current nizima LIVE effect parameters. |
| Add | Adds a new row for parameter binding. If added by mistake, you can revert by pressing the delete button on the added row. |
| Delete | Deletes the parameter binding for the row containing this button. This action cannot be undone. |
Top-Left Menu
- Save As
- Allows you to export the created parameter settings.
- Load from File
- Allows you to import previously created parameter settings.