jack
/
tinyblast
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 4 Wiki Activity

Updated README

This commit is contained in:
Jack 2024-09-18 11:00:16 -04:00
parent 6406da40a3
commit 22b6c1e598
1 changed files with 28 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -1,32 +1,45 @@
# Tinyblast v1.0.0
# Tinyblast Plugin v2.0.0-beta
## Overview
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.
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.
## 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 `.mp4`. This `.avi` file is temporary and will be deleted by Maya after a few minutes.
- **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. A new "Tinyblast" button will now be available to convert playblasts to `.mp4`.
3. Access the Playblast Options window in Maya.
## License
## How to Use
Currently, there is no menu button to open Tinyblast. You will need to run the following command in Maya's script editor:
This project is licensed under the GPLv3 license.
```python
import maya.cmds as cmds
cmds.tinyblastOptions()
```
It also includes FFmpeg, which is licensed under GPLv3. You can download the FFmpeg source code from [https://ffmpeg.org/download.html](https://ffmpeg.org/download.html).
## 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.