Updated Documentation

latenitefilms · Dec 25, 2023 · ec700d8 · ec700d8
1 parent 474098b
commit ec700d8
Show file tree

Hide file tree

Showing 22 changed files with 234 additions and 29 deletions.
diff --git a/docs/credits.md b/docs/credits.md
@@ -1,6 +1,6 @@
 # Credits
 
-Metaburner Pro has been thrown together by [Chris Hocking](https://github.com/latenitefilms) at [LateNite Films](https://latenitefilms.com).
+Metaburner Pro has been thrown together by [Chris Hocking](https://github.com/latenitefilms) at [LateNite](https://latenitefilms.com).
 
 The Metaburner Pro icon was designed by the amazing [Matthew Skiles](http://matthewskiles.com).
 
@@ -12,7 +12,7 @@ You can learn more about Chris's creations over at [FCP Cafe](https://fcp.cafe/l
 
 ## FCPXMLKit
 
-We use FCPXMLKit by [David Peterson](https://github.com/randomeizer/).
+We use **FCPXMLKit** by [David Peterson](https://github.com/randomeizer/). This is a private framework.
 
 ---
 

diff --git a/docs/how-to-use.md b/docs/how-to-use.md
@@ -14,29 +14,31 @@ Found a bug? Post about it on our [Issues page](https://github.com/latenitefilms
 
 ### Known Issues & Limitations
 
-#### Metaburner Pro v1.0.0 (Build 14)
+**Metaburner Pro v1.0.0 (Build 15) - 25th December 2023**
 
-**25th December 2023**
-
-- When using the **Primary Storyline** Content Source, sometimes the first frame of an [`asset-clip`'s](https://developer.apple.com/documentation/professional_video_applications/fcpxml_reference/story_elements/asset-clip) will display no data. This is a bug.
-- The **Preset** buttons currently don't do anything. This will be added in a future beta.
+- When using the **Primary Storyline** Content Source, sometimes the first frame of an [`asset-clip`'s](https://developer.apple.com/documentation/professional_video_applications/fcpxml_reference/story_elements/asset-clip) will display no data. This is a bug and will be fixed in a future TestFlight release.
+- The **Preset** buttons currently don't do anything. This will be added in a future TestFlight release.
 
 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).
 
+You can find the full release notes [here](/release-notes/).
+
 ---
 
 ### Error Logs
 
-You can find the error log here:
+You can press the **Reveal Log Files** button in the **Controls** section of the Inspector to access the `FxPlug.log` file in Finder.
+
+![](static/reveal-log-files.png)
+
+The log file is located here:
 
 ```
 ~/Library/Containers/com.latenitefilms.MetaburnerProRenderer/Data/Library/Application Support/FxPlug.log
 ```
 
-You can also press the **Reveal Log Files** button in the **Controls** section of the Inspector.
-
 You can find any crash logs here:
 
 ```
@@ -87,8 +89,6 @@ After installing the Motion Template, you can find the Metaburner Pro Title at t
 
 ### Title Inspector
 
-_**As Metaburner Pro is iterating rapidly, some of the below documentation may be out-of-date as we quickly push out new beta's.**_
-
 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.
@@ -127,28 +127,38 @@ For example, if you have **Project** selected in the **Content Source**, and **N
 
 You can add a **Prefix** and a **Suffix** to all text fields, regardless of the **Content Source** and **Content Field**.
 
-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:
+When you first add the Metaburner Pro Title, it will display this image in your Viewer:
+
+![](static/no-project-loaded.png)
+
+As the image explains, 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)
 
 What metadata Final Cut Pro provides when dragging a project/timeline, depends on what **Metadata View** you currently have selected in the **Info Inspector**:
 
 ![](static/metadata-view.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.
-
-We have also noticed that sometimes Final Cut Pro can crash when exporting FCPXMLs, as documented [here](https://github.com/CommandPost/FCPCafe/issues/307). We hope that Apple will address this in a future Final Cut Pro update.
+> 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.
+>
+> We have also noticed that sometimes Final Cut Pro can crash when exporting FCPXMLs, as documented [here](https://github.com/CommandPost/FCPCafe/issues/307). We hope that Apple will address this in a future Final Cut Pro update.
 
-You will see a progress alert whilst Metaburner Pro is processing:
+After dropping a FCPXML, the status text will change to **Analysing Project**:
 
-![](static/loading.png)
+![](static/loading-fcpxml.png)
 
-You can **Cancel** it if it's taking a very long time and try again.
+After a short time, if successful, the status should change to **Project Loaded**:
 
-Once you've successfully imported a project/timeline, you'll get a message like this:
+![](static/project-loaded.png)
 
-![](static/import-complete.png)
+> Final Cut Pro can be a bit temperamental in terms of updating the status, so you may need to click away from the Metaburner Pro Title and then go back to it for the text to update.
 
 Once done, Metaburner Pro has access to all the metadata within the FCPXML to populate all the Content Sources.
 
-If you make changes to the project/timeline, you'll need to drag the project back again to update the contents of Metaburner Pro.
+If you make changes to the project/timeline, you'll need to drag the project back again to update the contents of Metaburner Pro.
+
+If Metaburner Pro was unable to import the FCPXML, you'll get an error status, which you can hover over with your mouse to get more detail:
+
+![](static/error-in-inspector.png)
+
+If you do run into an error, it's most likely a bug in Metaburner Pro, so please share your Error Log and FCPXML on GitHub [here](https://github.com/latenitefilms/metaburnerpro/issues).
diff --git a/docs/lua-scripting.md b/docs/lua-scripting.md
@@ -0,0 +1,23 @@
+# Lua Scripting
+
+An incredible powerful feature of Metaburner Pro is the ability to code your own Lua scripts.
+
+Simply use the **Lua** Content Source, then use the **Custom Field** to type your code.
+
+Anything you write to the `result` global variable will be displayed in Metaburner Pro.
+
+For example:
+
+![](/static/lua-scripting.png)
+
+You have access to the full FCPXML via the `fcpxmlData` global variable, which is stored as a `string`:
+
+![](/static/lua-fcpxml.png)
+
+You have access to Metaburner Pro's processed data via the `processedData` global variable, which is stored as a `table`:
+
+![](/static/lua-processed-data.png)
+
+You can manipulate this data any way you want.
+
+You can learn more about Lua Scripting on the [CommandPost website](https://commandpost.io/developer/lua-overview/).
diff --git a/docs/lua-scripting.yml b/docs/lua-scripting.yml
@@ -0,0 +1,3 @@
+label: Lua Scripting
+icon: terminal
+order: 7890
diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -1,12 +1,181 @@
 # Release Notes
 
-During the **TestFlight** testing period, we'll be documenting any changes to the beta builds on the [How To Use page](/how-to-use/).
+### 1.0.0 (14)
+
+**🎉 Released:**
+- 24th December 2023
+
+🔨 **Improvements:**
+- Cleaned up Project Logic.
+- Exposed `processedData` and `fcpxmlData` in Lua Environment.
+
+🐞 **Bug Fix:**
+- Fixed bug if text layer was disabled.
+
+---
+
+### 1.0.0 (13)
+
+**🎉 Released:**
+- 24th December 2023
+
+🔨 **Improvements:**
+- Added Filename Metadata for Inside Video Container.
+- Added Basic Lua Support.
+
+---
+
+### 1.0.0 (12)
+
+**🎉 Released:**
+- 23rd December 2023
+
+🔨 **Improvements:**
+- Added **Primary Storyline - Inside Container - 1st Video Clip** and **Primary Storyline - Inside Container - 1st Audio Clip** Content Sources.
+- Added **Filename** and **Note** Content Fields.
+- Added **Project Note**.
+- Updated Motion Template.
+
+---
+
+### 1.0.0 (11)
+
+**🎉 Released:**
+- 23rd December 2023
+
+🔨 **Improvements:**
+- Added full error message to tooltip.
+- Improved error messaging.
+
+---
+
+### 1.0.0 (10)
+
+**🎉 Released:**
+- 21st December 2023
+
+🔨 **Improvements:**
+- Added a "Welcome" image when no FCPXML is loaded.
+- Removed all alerts/popups when importing a FCPXML. It now just updates the text in the Inspector.
+- Added "Import Project via FCPXML".
+- Added **Background Padding** & **Background Offset**.
+- Update Motion Template.
+
+🐞 **Bug Fix:**
+- We now ensure all text is over the top of the background.
+
+---
+
+### 1.0.0 (9)
+
+**🎉 Released:**
+- 20th December 2023
+
+🔨 **Improvements:**
+- Added internal tests.
+
+---
+
+### 1.0.0 (8)
+
+**🎉 Released:**
+- 20th December 2023
+
+🐞 **Bug Fix:**
+- Fixed Opacity Bugs.
+
+---
+
+### 1.0.0 (7)
+
+**🎉 Released:**
+- 20th December 2023
+
+🔨 **Improvements:**
+- Added Project Loaded Status.
+- Attempted to solve some UI glitches with dragging and dropping. Not sure I made it any better.
+- Tweaked error handling.
+- Updated Motion Template.
+
+---
+
+### 1.0.0 (6)
+
+**🎉 Released:**
+- 19th December 2023
+
+🔨 **Improvements:**
+- Disabled **Lane 1**, **Lane 2**, etc. from menu for now.
+- We now write "-" instead of "TBC".
+- We now write log files to disk.
+- We now display `-` when metadata fails.
+- Updated Motion Template.
+
+🐞 **Bug Fixes:**
+- Fixed **Project > Start Timecode** typo.
+- Added missing Text Layer.
+
+---
+
+### 1.0.0 (5)
+
+**🎉 Released:**
+- 19th December 2023
+
+🔨 **Improvements:**
+- Under-the-hood improvements to our FCPXML Processing Engine.
+- Added a "Cancel" button to the Progress Alert incase it stalls for some reason.
+- Hooked up **Project Duration**, **Timecode Format** and **Start Timecode**.
+- Added **Primary Storyline > HH:MM:SS:FF**.
+
+🐞 **Bug Fix:**
+- Fixed bug in Right Alignment.
+
+---
+
+### 1.0.0 (4)
+
+**🎉 Released:**
+- 18th December 2023
+
+🔨 **Improvements:**
+- Tweaked parameter defaults.
+- Started building the FCPXML Processing Engine.
+- Updated Motion Template.
+
+---
+
+### 1.0.0 (3)
+
+**🎉 Released:**
+- 18th December 2023
+
+🔨 **Improvements:**
+- Added **Alignment**, **Background Colour**, **Background Opacity** and **All Caps**.
+- We now use an XY parameter for position.
+- Improved how we draw text.
+- Changed Default Font & Size.
+- Changed the internal ID numbering to avoid a weird Final Cut Pro bug with ID `300`.
+- Added ability to install the Motion Template from the Wrapper Application.
+- Updated Motion Template.
+
+---
+
+### 1.0.0 (2)
+
+**🎉 Released:**
+- 17th December 2023
+
+🔨 **Improvements:**
+- The FCPXML drop zone is now working.
+- Added placeholder **Preset** buttons.
+- Updated the Motion Template.
+
+---
 
-<!--
 ### 1.0.0 (1)
 
 **🎉 Released:**
-- COMING SOON!
+- 16th December 2023
 
-This is the first release of Metaburner Pro. Woohoo!
--->
+This is the first release of Metaburner Pro Beta on TestFlight. Woohoo!
diff --git a/docs/static/content-field.png b/docs/static/content-field.png
diff --git a/docs/static/content-source.png b/docs/static/content-source.png
diff --git a/docs/static/drop-zone.png b/docs/static/drop-zone.png
diff --git a/docs/static/error-in-inspector.png b/docs/static/error-in-inspector.png
diff --git a/docs/static/global-settings.png b/docs/static/global-settings.png
diff --git a/docs/static/inspector.png b/docs/static/inspector.png
diff --git a/docs/static/loading-fcpxml.png b/docs/static/loading-fcpxml.png
diff --git a/docs/static/loading.png b/docs/static/loading.png
diff --git a/docs/static/lua-fcpxml.png b/docs/static/lua-fcpxml.png
diff --git a/docs/static/lua-processed-data.png b/docs/static/lua-processed-data.png
diff --git a/docs/static/lua-scripting.png b/docs/static/lua-scripting.png
diff --git a/docs/static/no-project-loaded.png b/docs/static/no-project-loaded.png
diff --git a/docs/static/project-loaded.png b/docs/static/project-loaded.png
diff --git a/docs/static/reveal-log-files.png b/docs/static/reveal-log-files.png
diff --git a/docs/static/text-layer.png b/docs/static/text-layer.png
diff --git a/docs/support.md b/docs/support.md
@@ -4,7 +4,7 @@ If you run into any bugs, crashes, or you have a feature request, you can post a
 
 If you have any general questions or feedback, you can discuss [here](https://github.com/latenitefilms/metaburnerpro/discussions).
 
-GitHub registration is free, and this GitHub repository is actively monitored by [LateNite Films](https://github.com/latenitefilms).
+GitHub registration is free, and this GitHub repository is actively monitored by the developer, [Chris Hocking](https://github.com/latenitefilms).
 
 You can also email us: [[email protected]](mailto:[email protected])
 

diff --git a/docs/system-requirements.md b/docs/system-requirements.md
@@ -1,6 +1,6 @@
 # System Requirements
 
-Metaburner Pro requires **Final Cut Pro 10.6.5** or later, although we recommend **Final Cut Pro 10.7**.
+Metaburner Pro requires **Final Cut Pro 10.6.5** or later, although we recommend **Final Cut Pro 10.7.1**.
 
 It requires **macOS Ventura** or later, although we recommend **Sonoma**.