pynizima 1.0

Python library for interacting with the NizimaLIVE API via WebSocket

PyNizima

A python library for interacting with NizimaLIVE API

Quick Start

Install

pip install pynizima

Get Started

Exemple

📖 Read tutorial for more details

from pynizima import NizimaRequest
import asyncio

async def main():
    nz = NizimaRequest()
    plugin_name = 'YourPluginName'
    token = await nz.register_plugin(plugin_name)
    connection_enabled = await nz.establish_connection(plugin_name, token)
    while connection_enabled:
        # do your plugin logic here

if __name__ == "__main__":
    asyncio.run(main())

---

List of Methods

📖 Read methods documentation for more details.

Plugin Management

• register_plugin
• establish_connection
• register_plugin_path
• get_connection_status

Parameter Control

• insert_live_parameters
• set_live_parameter_values
• set_cubism_parameter_values
• reset_cubism_parameter_values
• get_live_parameters
• get_live_parameter_values
• get_cubism_parameter_values
• get_cubism_parameters

Scene Management

• add_model
• remove_model
• move_model
• reset_pose
• get_scenes
• get_current_scene_id

Model Manipulation

• register_model

• change_model

• get_registered_model_icons

• get_registered_models

• get_current_model_id

• get_models

Model Parts Manipulation

• set_drawables_color
• set_parts_color
• set_model_color
• get_drawables
• get_parts
• get_parts_tree

Item Management

• add_item
• remove_item
• move_item
• get_registered_items
• get_items

Motion Control

• start_motion
• stop_motion
• get_motions

Expression Management

• start_expression
• stop_expression
• stop_all_expressions
• get_expressions