Add acknowledgment of third party software in README and LICENSE
This commit is contained in:
parent
9589b6813a
commit
da629d82be
14
LICENSE
14
LICENSE
|
|
@ -672,3 +672,17 @@ may consider it more useful to permit linking proprietary applications with
|
|||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
|
||||
---------------------------------------
|
||||
|
||||
Third-Party Licenses
|
||||
|
||||
This project includes or relies on the following third-party libraries, which are licensed separately:
|
||||
|
||||
- FFmpeg: This project uses code from FFmpeg, licensed under the GPLv3 (https://ffmpeg.org/legal.html). FFmpeg’s source code is available at https://ffmpeg.org/download.html.
|
||||
- Qt6: This project uses Qt, which is licensed under the LGPLv3 (https://www.qt.io/licensing).
|
||||
- PySide6: The Python bindings for Qt, PySide6, are licensed under the LGPLv3 (https://doc.qt.io/qtforpython/licenses.html).
|
||||
- Shiboken6: Shiboken, used to create Python bindings, is licensed under the LGPLv3 (https://doc.qt.io/qtforpython/shiboken6/).
|
||||
|
||||
For more details, see the respective licenses included with these libraries.
|
||||
|
||||
|
|
|
|||
85
README.md
85
README.md
|
|
@ -1,40 +1,45 @@
|
|||
# Tinyblast Plugin v2.0.0-beta
|
||||
|
||||
Tinyblast is a custom playblast tool for Maya, designed to offer more flexible control over the output format, codec, and playblast settings than the default Maya playblast options.
|
||||
|
||||
## New in v2.0.0-beta
|
||||
- Removed the button from the Playblast Options window.
|
||||
- Created a new custom window that contains options to choose the file format and codec.
|
||||
- Added playblast options such as:
|
||||
- Quality slider
|
||||
- Resolution scalar
|
||||
- Frame padding
|
||||
|
||||
## Known Limitations
|
||||
|
||||
- **Windows Only**: This release is optimized for Maya’s `.avi` file output on Windows. Future versions may extend support to other platforms and formats.
|
||||
- **Uncompressed AVI Temporary File**: Tinyblast relies on Maya’s built-in playblast function, which still generates an uncompressed `.avi` file before converting it to the other format. This `.avi` file is temporary and will be deleted by Maya after a few minutes.
|
||||
|
||||
## Known Issues
|
||||
- The `.mov` format currently does not work with the DNxHD, DNxHR, or ProRes codecs.
|
||||
|
||||
## Installation
|
||||
1. Download and install Tinyblast.
|
||||
2. **Load the Plugin in Maya**:
|
||||
- Navigate to `Windows > Settings/Preferences > Plug-in Manager`.
|
||||
- If `Tinyblast.py` is not listed, click **Browse** and locate the `Tinyblast.py` file.
|
||||
- Check the **Loaded** box to enable the plugin.
|
||||
- (Optional) Check **Auto-load** to automatically load the plugin every time Maya starts.
|
||||
3. Access the Playblast Options window in Maya.
|
||||
|
||||
## How to Use
|
||||
The plugin creates a custom shelf called Tinyblast in Maya with a button that opens the Tinyblast Options window where you can choose settings and create a playblast. Use Tinyblast as you would the regular Maya playblast.
|
||||
|
||||
## Future Plans
|
||||
- Further improvements to format and codec compatibility.
|
||||
- Adding more formats and codecs if needed.
|
||||
- Refining the UI for easier access and use.
|
||||
|
||||
## Requirements
|
||||
- Maya (tested on Maya 2025, but should work with any version that supports the same OpenMaya plugin version).
|
||||
- FFmpeg bundled with the plugin.
|
||||
# Tinyblast v1.0.0
|
||||
|
||||
# **Important!**
|
||||
|
||||
FFmpeg is no longer bundled with Tinyblast directly in the source. In order to download the plugin with FFmpeg please go to the [release page on this repo](https://git.jackmchristensen.com/jack/tinyblast/-/releases/v1.0.0) and download tinyblast_v1.0.0.zip or download it [here](https://drive.proton.me/urls/JVV34W2H3R#VOJzkesz0Cgq). If you only download the source, the plugin **will not work**.
|
||||
|
||||
## Overview
|
||||
|
||||
Tinyblast is a lightweight plugin designed to enhance Maya’s playblast workflow by converting uncompressed `.avi` files to compressed `.mp4` files using the efficient H.264 codec. It adds a custom button to Maya's Playblast Options window, enabling users to save playblasts in the more storage-friendly `.mp4` format, significantly reducing file sizes without sacrificing quality.
|
||||
|
||||
## Features
|
||||
|
||||
- **Playblast to MP4 Conversion**: Automatically converts uncompressed `.avi` playblast files generated by Maya to `.mp4` format using the H.264 (libx264) codec.
|
||||
- **Seamless Integration**: Adds a custom button to Maya's Playblast Options window for quick access to conversion options.
|
||||
- **Improved File Size Efficiency**: Compresses uncompressed `.avi` files, which Maya creates by default, into `.mp4` files with minimal quality loss, freeing up disk space and improving workflow efficiency.
|
||||
|
||||
## Known Limitations
|
||||
|
||||
- **Windows Only**: This release is optimized for Maya’s `.avi` file output on Windows. Future versions may extend support to other platforms and formats.
|
||||
- **Uncompressed AVI Temporary File**: Tinyblast relies on Maya’s built-in playblast function, which still generates an uncompressed `.avi` file before converting it to `.mp4`. This `.avi` file is temporary and will be deleted by Maya after a few minutes.
|
||||
|
||||
## Installation
|
||||
|
||||
1. Download and install Tinyblast.
|
||||
2. **Load the Plugin in Maya**:
|
||||
- Navigate to `Windows > Settings/Preferences > Plug-in Manager`.
|
||||
- If `Tinyblast.py` is not listed, click **Browse** and locate the `Tinyblast.py` file.
|
||||
- Check the **Loaded** box to enable the plugin.
|
||||
- (Optional) Check **Auto-load** to automatically load the plugin every time Maya starts.
|
||||
3. Access the Playblast Options window in Maya. A new "Tinyblast" button will now be available to convert playblasts to `.mp4`.
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the GPLv3 license.
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
This project uses the following third-party libraries:
|
||||
|
||||
- **FFmpeg**: Licensed under the [GNU General Public License (GPL)](https://ffmpeg.org/legal.html). FFmpeg is a powerful multimedia framework used in this project for video conversion.
|
||||
- **Qt6**: Licensed under the [GNU Lesser General Public License (LGPL) v3](https://www.qt.io/licensing). Qt is used for building the user interface of this project.
|
||||
- **PySide6**: Licensed under the [GNU Lesser General Public License (LGPL) v3](https://doc.qt.io/qtforpython/licenses.html). PySide6 provides Python bindings for the Qt framework.
|
||||
- **Shiboken6**: Licensed under the [GNU Lesser General Public License (LGPL) v3](https://doc.qt.io/qtforpython/shiboken6/). Shiboken6 is used for generating Python bindings for Qt.
|
||||
|
||||
Please refer to the respective licenses for each library for more information.
|
||||
|
|
|
|||
Loading…
Reference in New Issue