Cinema4d MCP

🚀 Cinema 4D API English Documentation

This documentation provides a comprehensive guide to the Cinema 4D API, enabling users to interact with Cinema 4D using Python. It covers installation, quick start, detailed API usage, compatibility, best practices, and more.

🚀 Quick Start

Core Concepts

Scene Objects

Interact with Cinema 4D using server.py. All operations are based on the current active scene.

# Get the pointer to the current active scene
scene = c4d.GetActiveScene()

Attribute Settings

Most attributes of Cinema 4D can be accessed and modified via Python. The specific method depends on the object type.

Basic Command Examples

# Add a cube
cube = c4d.utils.create_object(c4d.OBJECT_TYPE_Cube)
c4d.EventAdd()

# Get the current active object
active_obj = doc.GetActiveObject()

✨ Features

• Comprehensive API: Covers various aspects of Cinema 4D, including scene management, object creation, camera and animation control, lighting and material settings, etc.
• Python Integration: Allows users to use Python to automate operations in Cinema 4D, improving efficiency.
• Compatibility: Supports multiple versions of Cinema 4D and specific Python versions.

📦 Installation

Installation Steps

1. Download and install the official Python binding plugin.
2. Launch Cinema 4D, then go to Menu > Plugins > Python > Manager.
3. Add a new Python interpreter and select the path of the installed Python.

Compatibility Information

• Supported Versions: Cinema 4D 2023.2 and above (R25, S26 and higher).
• Python Version: 3.10.
• Minimum Requirement: Cinema 4D 2024.0 or a later version ensures optimal compatibility.

📚 Documentation

Scene Information and Execution

• get_scene_info: Get a summary of the current scene.
• list_objects: List all objects in the scene (including the hierarchical structure).
• group_objects: Group selected objects under a new empty object.
• execute_python: Execute custom Python code in Cinema 4D.
• save_scene: Save the current Cinema 4D project to disk.
• load_scene: Load a .c4d file into the scene.
• set_keyframe: Set keyframes for object attributes (position, rotation, etc.).

Object Creation and Modification

• add_primitive: Add a basic shape (cube, sphere, cone, etc.) to the scene.
• modify_object: Modify the transformation or attributes of the selected object.
• create_abstract_shape: Create an organic, non - standard abstract form.

Camera and Animation

• create_camera: Add a new camera to the scene.
• animate_camera: Animate the camera along a path (linear or spline curve).

Lighting and Materials

• create_light: Add a light (ambient light, spotlight, etc.) to the scene.
• create_material: Create a standard Cinema 4D material.
• apply_material: Apply a material to the target object.
• apply_shader: Generate and apply a stylized or procedural shader.

Redshift Support

• validate_redshift_materials: Check the Redshift material settings and their connections.

MoGraph and Fields

• create_mograph_cloner: Add a MoGraph cloner (linear, radial, grid, etc.).
• add_effector: Add a MoGraph effector (random, plane, etc.).
• apply_mograph_fields: Add and link a MoGraph field to an object.

Dynamics and Physics

• create_soft_body: Add a soft body tag to the selected object.
• apply_dynamics: Apply rigid or soft body physical properties to an object.

Rendering and Preview

• render_frame: Render the current frame and save it to disk (file output only).
• render_preview: Render a quick preview and return a Base64 image (for AI use).
• snapshot_scene: Capture a snapshot of the scene (including objects and preview images).

Compatibility Plan and Roadmap

💡 Best Practices

Logging and Debugging

# Log key operations
import logging
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

Error Handling

Always use exception handling to ensure code robustness:

try:
    # Operation code
except Exception as e:
    logger.error(f"An error occurred: {str(e)}")

🛠️ Resolved Issues

• Issue: The plugin did not appear in the menu after the first installation.
  • Solution: Restart Cinema 4D and check again.
• Issue: Unable to access certain object attributes.
  • Solution: Ensure that all necessary modules are imported correctly and check the logs for more information.

🤝 Contribution Guide

How to Contribute Code

1. Fork the local repository to your own account.
2. Create a new feature branch.
3. Commit your changes and create a pull request.

How to Report Issues

• Use GitHub Issues to report issues, including detailed operation steps and error information.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for specific terms.

📞 Contact Us

If you have any questions or suggestions, please contact us via the following methods:

• Email: support@cinema4dapi.com
• GitHub: https://github.com/cinema4d/cinema4d-api