Unofficial KeyShot Python Libraries and Documentation
Welcome to the KeyShot Python API Documentation repository. This resource is created to provide comprehensive guides, detailed documentation, and practical script examples for users of KeyShot's Python API. Whether you're automating tasks in KeyShot, extending its functionalities, or integrating KeyShot into your digital pipeline, this repository aims to be your go-to reference.
- Introduction
- lux Library Documentation
- luxmath Library Documentation
- Headless Mode Documentation
- Example Scripts
- Contributing
- License
KeyShot by Luxion is a leading real-time 3D rendering and animation software. The KeyShot Python API allows for scripting and automation of various KeyShot functionalities, enhancing productivity and enabling advanced customizations. This repository documents the lux and luxmath libraries, provides insights into running KeyShot in headless mode, and shares useful script examples.
The lux library is KeyShot's primary interface for scripting, offering functions to control scenes, materials, cameras, rendering, and more. Explore the lux library documentation.
For mathematical operations, the luxmath library provides Vector and Matrix classes, essential for transformations and other calculations in scripts. Learn more about luxmath.
Running KeyShot in headless mode enables automation and integration into pipelines without the GUI. This section covers the essentials for both lux and luxmath libraries in headless operation.
Documentation specific to using the lux library without the KeyShot interface. Dive into lux headless mode.
Similar to the luxmath library, but focused on headless applications. Discover luxmath in headless mode.
A collection of scripts demonstrating the practical application of KeyShot's Python API for common tasks and advanced customizations. Browse example scripts.
Contributions to this repository are welcome! Whether it's improving documentation, adding new scripts, or reporting issues, your input helps make this resource better for everyone. Find out how to contribute.
This project is licensed under MIT License - see the LICENSE file for details.