diff --git a/docs/README.md b/docs/README.md index 1aef538..0df2b92 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,12 +9,22 @@ # Metaburner Pro -Metaburner Pro is a Metadata Generator for Final Cut Pro. +**Metaburner Pro** is a Metadata Generator for Final Cut Pro. -It's currently in **early development**. We are aiming to release on TestFlight in late 2023. +You can access it via a **Title** in the Titles sidebar. + +It's currently in **early development**. + +If you're interested in helping with development, you can sign up to **TestFlight** [here](https://testflight.apple.com/join/dw7S2veN). + +Metaburner Pro gives you **25 text layers** that you can populate with whatever metadata you want. + +You can import you Final Cut Pro project/timeline back into the Metaburner Pro Title via a drop zone, so Metaburner Pro has full access to everything that's in the FCPXML. Got ideas or questions? Post them on our [Discussions page](https://github.com/latenitefilms/metaburnerpro/discussions)! - \ No newline at end of file + +![](/static/metaburner-pro-screenshot.jpeg) \ No newline at end of file diff --git a/docs/buy.md b/docs/buy.md index 8d29bb2..eaef3fd 100644 --- a/docs/buy.md +++ b/docs/buy.md @@ -1,10 +1,10 @@ # Buy on Mac App Store -Metaburner Pro is still in early development, and not yet for sale. +Metaburner Pro is still in **early development**, and not yet for sale. We hope to release in late 2023. - +If you're interested in helping with development, you can sign up to **TestFlight** [here](https://testflight.apple.com/join/dw7S2veN). + +> [:icon-desktop-download: **Buy on the Mac App Store**](https://apps.apple.com/us/app/metaburner-pro/id6474466386) **Metaburner Pro** is a one-time payment of **USD$100**. diff --git a/docs/credits.md b/docs/credits.md index d7070d2..c461ef2 100644 --- a/docs/credits.md +++ b/docs/credits.md @@ -6,4 +6,38 @@ The Metaburner Pro icon was designed by the amazing [Matthew Skiles](http://matt Chris also created [CommandPost](https://commandpost.io), [Transfer Toolbox](https://transfertoolbox.io), [BRAW Toolbox](https://brawtoolbox.io), [Marker Toolbox](https://markertoolbox.io) and [Gyroflow Toolbox](https://gyroflowtoolbox.io). -You can learn more about Chris's creations over at [FCP Cafe](https://fcp.cafe/latenite/). \ No newline at end of file +You can learn more about Chris's creations over at [FCP Cafe](https://fcp.cafe/latenite/). + +--- + +## FCPXMLKit + +We use FCPXMLKit by [David Peterson](https://github.com/randomeizer/). + +--- + +## TimecodeKit + +We use [TimecodeKit](https://github.com/orchetect/TimecodeKit) by [Steffan Andrews](https://github.com/orchetect). + +MIT License + +Copyright (c) 2018 Steffan Andrews - https://github.com/orchetect + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/docs/how-to-use.md b/docs/how-to-use.md index e2c4d9a..b72f5ce 100644 --- a/docs/how-to-use.md +++ b/docs/how-to-use.md @@ -2,8 +2,96 @@ Metaburner Pro is currently in **early development**. -We are aiming to release on TestFlight in late 2023. +If you're interested in helping with development, you can sign up to **TestFlight** [here](https://testflight.apple.com/join/dw7S2veN). -We'll update this page once we have a TestFlight release. +Got ideas or questions? Post them on our [Discussions page](https://github.com/latenitefilms/metaburnerpro/discussions)! -Got ideas or questions? Post them on our [Discussions page](https://github.com/latenitefilms/metaburnerpro/discussions)! \ No newline at end of file +Found a bug? Post about it on our [Issues page](https://github.com/latenitefilms/metaburnerpro/issues). + +--- + +### Known Issues & Limitations + +#### Metaburner Pro v1.0.0 (Build 3) + +- There's currently no **Clip** Content Sources. These will be added in future betas. +- The **Control** buttons currently don't do anything. +- The **Preset** buttons currently don't do anything. + +Got ideas or questions? Post them on our [Discussions page](https://github.com/latenitefilms/metaburnerpro/discussions)! + +Found a bug? Post about it on our [Issues page](https://github.com/latenitefilms/metaburnerpro/issues). + +--- + +### Installing + +If it's the first time installing the software, or if there's been an update to the Motion Template, you'll be prompted to **Install Motion Template**. + +![](static/install-01.png) + +Once you click the button, you'll be prompted to grant permission to your **Movies** folder. This is due to macOS's sandboxing, and you'll only need to do this once. Click **OK**. + +![](static/install-02.png) + +You then need to click **Grant Access**: + +![](static/install-03.png) + +Once done, you'll be presented with a successful message: + +![](static/install-04.png) + +The button will now be disabled, and will say **Motion Template Installed**. You can now close the Gyroflow Toolbox application. + +![](static/install-05.png) + +--- + +### Accessing in Final Cut Pro + +After installing the Motion Template, you can find the Metaburner Pro Title at the top of the Title sidebar in Final Cut Pro: + +![](static/title-browser.png) + +--- + +### Title Inspector + +Simply add the Metaburner Pro Title to the top of your timeline as an adjustment layer. + +It should start at the very start of your timeline. + +![](static/timeline.png) + +You can then control it via the Inspector: + +![](static/inspector.png) + +There are 25 customisable text layers, which you can customise however you want. + +There are **Global Settings** which apply to all Text Layers: + +![](static/global-settings.png) + +You can override these Global Settings on an individual text layer by deselecting the **Use Global Settings** checkbox: + +![](static/text-layer.png) + +The **Custom Field** allows you to input specific names related to the **Content Source** (for example, providing a custom metadata field). + +When the **Content Source** is set to **Custom Text**, then the **Custom Text** field is used as the main text source for that text layer. + +You can add a **Prefix** and a **Suffix** to all text fields. + +So that Metaburner Pro can access all the metadata in your project/timeline, you need to drag your project/timeline from the **Browser** to the drop zone at the top of the Inspector: + +![](static/drop-zone.png) + +Final Cut Pro can be a bit temperamental when dragging things from the Browser to the Inspector over the Viewer, so you might have to drag it slowly/carefully for it to work. Sometimes the Inspector will change views, which breaks the workflow, so simply try again. + +Once successful, you'll get a message like this: + +![](static/import-complete.png) + +Once done, Metaburner Pro has access to all the metadata within the FCPXML to populate all the Content Sources. \ No newline at end of file diff --git a/docs/static/drop-zone.png b/docs/static/drop-zone.png new file mode 100644 index 0000000..bf5d6c9 Binary files /dev/null and b/docs/static/drop-zone.png differ diff --git a/docs/static/global-settings.png b/docs/static/global-settings.png new file mode 100644 index 0000000..518dd3f Binary files /dev/null and b/docs/static/global-settings.png differ diff --git a/docs/static/import-complete.png b/docs/static/import-complete.png new file mode 100644 index 0000000..99eda89 Binary files /dev/null and b/docs/static/import-complete.png differ diff --git a/docs/static/inspector.png b/docs/static/inspector.png new file mode 100644 index 0000000..aef7a08 Binary files /dev/null and b/docs/static/inspector.png differ diff --git a/docs/static/install-01.png b/docs/static/install-01.png new file mode 100644 index 0000000..b5161a6 Binary files /dev/null and b/docs/static/install-01.png differ diff --git a/docs/static/install-02.png b/docs/static/install-02.png new file mode 100644 index 0000000..071db3e Binary files /dev/null and b/docs/static/install-02.png differ diff --git a/docs/static/install-03.png b/docs/static/install-03.png new file mode 100644 index 0000000..d0f34dc Binary files /dev/null and b/docs/static/install-03.png differ diff --git a/docs/static/install-04.png b/docs/static/install-04.png new file mode 100644 index 0000000..2f7023c Binary files /dev/null and b/docs/static/install-04.png differ diff --git a/docs/static/install-05.png b/docs/static/install-05.png new file mode 100644 index 0000000..a72a1a8 Binary files /dev/null and b/docs/static/install-05.png differ diff --git a/docs/static/metaburner-pro-screenshot.jpeg b/docs/static/metaburner-pro-screenshot.jpeg new file mode 100644 index 0000000..a42af4c Binary files /dev/null and b/docs/static/metaburner-pro-screenshot.jpeg differ diff --git a/docs/static/text-layer.png b/docs/static/text-layer.png new file mode 100644 index 0000000..90a0d58 Binary files /dev/null and b/docs/static/text-layer.png differ diff --git a/docs/static/timeline.png b/docs/static/timeline.png new file mode 100644 index 0000000..b1bac70 Binary files /dev/null and b/docs/static/timeline.png differ diff --git a/docs/static/title-browser.png b/docs/static/title-browser.png new file mode 100644 index 0000000..80eef5b Binary files /dev/null and b/docs/static/title-browser.png differ diff --git a/docs/system-requirements.md b/docs/system-requirements.md index 649a879..0c26012 100644 --- a/docs/system-requirements.md +++ b/docs/system-requirements.md @@ -1,5 +1,7 @@ # System Requirements -Metaburner Pro requires **Final Cut Pro 10.6.5** or later. +Metaburner Pro requires **Final Cut Pro 10.6.5** or later, although we recommend **Final Cut Pro 10.7**. + +It requires **macOS Ventura** or later, although we recommend **Sonoma**. You can find Final Cut Pro's system requirements [here](https://www.apple.com/au/final-cut-pro/specs/). \ No newline at end of file