How to use the plug-in function

Updated: 12/25/2024

Click here for information for developers.

How to Connect Plug-ins

1. Click the Settings and other information icon -> Plug-ins.

2. After the Plug-in Manager starts, use the toggle at the top of the screen to enable the plug-in function.

The port number must be the same for nizima LIVE and the plug-in to communicate.
If the configured port number is not available, the port is automatically changed to one that is available.

3. Download the sample plugin from GitHub.

Select “Mouse Extender.

Select “Mouse Extender 1.0.0” in the releases on the right side of the screen.

Download mouse-extender-X.X.X.zip, or mouse-extender-X.X.X-macOS-Apple.dmg for mac.

4. Start the plug-in and connect with connect.

5. The plugin will be added to the Plugin Manager on the nizimaLIVE 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 Remove button.

6. 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.

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 unconnected, 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.

Download and usage of color change plug-ins

Download 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.

Downloading and Using Gamepad Plug-ins

Download Plug-in

Name	The name of the connected controller is displayed.
power	Displays the controller connection status
Various parameters (Axis 0, LStickY, etc.)	The names of user-defined parameters that are automatically added to nizima LIVE are displayed. When you connect the parameters of the model to 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, RButtonRight, etc. in parentheses. Generic parameters marked with [Motionable] can execute motions of the same name. If you set the “Display Name” of a motion to “RButtonBottom” in nizima LIVE’s Expression/Motion window, the motion will automatically start when the button is pressed. After setting the display name, the plug-in needs to be reconnected, so please turn the plug-in on/off or restart the plug-in from the Plug-in window of nizima LIVE.