diff --git a/docs/README.md b/docs/README.md index 077e9e2..ebc84ec 100644 --- a/docs/README.md +++ b/docs/README.md @@ -11,9 +11,11 @@ **Metaburner** is an Advanced Metadata Generator for Final Cut Pro. -> Metaburner is currently being publicly beta tested on Apple's TestFlight. -> -> If you're interested in helping with development, you can learn more [here](/how-to-use/). +!!!success Download Now! +If you already have FxFactory installed, [click here](fxfactory://app/store?product=metaburner&show) to download **Metaburner**. + +You can download FxFactory [here](https://fxfactory.com/download/). +!!! You can access it via a **Title** in the Titles sidebar. diff --git a/docs/buy.md b/docs/buy.md index 0e07f48..ed67e89 100644 --- a/docs/buy.md +++ b/docs/buy.md @@ -1,9 +1,23 @@ # Buy on FxFactory -**Metaburner** is still in **active development**, and not yet for sale. +**Metaburner** is a one-time payment of **USD$149** on [FxFactory](https://fxfactory.com/info/metaburner/?action=buy). -We are aiming to release before the end of **January 2024**. +**Metaburner** is currently a **public beta testing phase**. -> If you're interested in helping with development, you can learn more [here](/how-to-use/). +We are actively developing it based on [user feedback](https://github.com/latenitefilms/metaburner/issues). -**Metaburner** will be a one-time payment of **USD$149** on [FxFactory](https://fxfactory.com). \ No newline at end of file +You can download and install a watermarked version for free on [FxFactory](https://fxfactory.com). + +If you want to remove the watermark during the beta period, you can purchase Metaburner [here](https://fxfactory.com/info/metaburner/?action=buy). + +!!!success Download Now! +If you already have FxFactory installed, [click here](fxfactory://app/store?product=metaburner&show) to download Metaburner. + +You can download FxFactory [here](https://fxfactory.com/download/). +!!! + +We hope to finish public beta testing by the end of January 2024. + +Got ideas or questions? Post them on our [Discussions page](https://github.com/latenitefilms/metaburner/discussions)! + +![](static/fxfactory.png) \ No newline at end of file diff --git a/docs/how-to-use.md b/docs/how-to-use.md index 1b6cd33..c455356 100644 --- a/docs/how-to-use.md +++ b/docs/how-to-use.md @@ -1,80 +1,42 @@ # How To Use -**Metaburner** is currently in **active development**. We are aiming to release before the end of January 2024. +**Metaburner** is currently in a **public beta testing phase**. -> **UPDATE:** _We've renamed Metaburner Pro to Metaburner in Build 21, so as of 3rd January, there's a new TestFlight link below:_ +We are actively developing it based on [user feedback](https://github.com/latenitefilms/metaburner/issues). -If you're interested in helping with development, you can sign up to **TestFlight** (Apple's beta-testing service) for free [here](https://testflight.apple.com/join/BIll53h2). +You can download and install a watermarked version for free on [FxFactory](https://fxfactory.com). -We will be posting regular beta builds to TestFlight as we add new features and functionality. +!!!success Download Now! +If you already have FxFactory installed, [click here](fxfactory://app/store?product=metaburner&show) to download **Metaburner**. -Got ideas or questions? Post them on our [Discussions page](https://github.com/latenitefilms/metaburner/discussions)! - -![](/static/metaburner-pro-screenshot.jpeg) - ---- - -### Known Issues & Bugs - -Please check the [Issues page](https://github.com/latenitefilms/metaburner/issues) for any known bugs or issues. - -You can find the full release notes [here](/release-notes/). - ---- - -### Error Logs - -You can press the **Reveal Log Files** button in the **Controls** section of the Inspector to access the, for example, `Metaburner Renderer - 1.0.0 (22).log` file in Finder: - -![](static/reveal-log-files.png) - -The log file is located in this folder with the name of the current version and build: - -``` -~/Library/Containers/com.latenitefilms.MetaburnerRenderer/Data/Library/Application Support/Metaburner Renderer - 1.0.0 (22).log -``` - -You can press the **Reveal Crash Logs** button in the **Controls** section of the Inspector to access the `DiagnosticReports` folder in Finder. - -![](static/reveal-log-files.png) - -The crash logs are located here: - -``` -~/Library/Logs/DiagnosticReports -``` - -The crash logs will have file names like `Metaburner Renderer-2023-12-24-103301.ips`. They might also be in the `Retired` sub-folder (these are reports that have already been posted to Apple). +You can download FxFactory [here](https://fxfactory.com/download/). +!!! -Alternatively, you can access your User Library, by clicking on your **Desktop**, then holding down **OPTION** as you click the **Go** menu item in Finder. A **Library** option will appear: +We hope to finish public beta testing by the end of January 2024. -![](static/finder-library.png) +Got ideas or questions? Post them on our [Discussions page](https://github.com/latenitefilms/metaburner/discussions)! -You can also copy the above paths, press **COMMAND+SHIFT+G** from Finder (or via the **Go > Go to Folder...** menubar item), and paste in that path into the **Go to Folder** popup. +![](/static/metaburner-pro-screenshot.jpeg) --- ### 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**. +Simply search for **Metaburner** in [FxFactory](https://fxfactory.com) and click **DOWNLOAD TRIAL**. -![](static/install-01.png) +If you already have FxFactory installed, [click here](fxfactory://app/store?product=metaburner&show) to download Metaburner. -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**. +You can download FxFactory [here](https://fxfactory.com/download/). -![](static/install-02.png) +![](static/fxfactory.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) +### Known Issues & Bugs -The button will now be disabled, and will say **Motion Template Installed**. You can now close the Gyroflow Toolbox application. +Please check the [Issues page](https://github.com/latenitefilms/metaburner/issues) for any known bugs or issues. -![](static/install-05.png) +You can find the full release notes [here](/release-notes/). --- @@ -199,22 +161,32 @@ You can learn more [here](/lua-scripting/). --- -### Final Cut Pro Bug +### Error Logs + +You can press the **Reveal Log Files** button in the **Controls** section of the Inspector to access the, for example, `Metaburner Renderer - 1.0.0 (22).log` file in Finder: + +![](static/reveal-log-files.png) + +The log file is located in this folder with the name of the current version and build: -> **UPDATE:** _As of Metaburner 1.0.0 (Build 20) we now workaround this issue._ +``` +/Users/YOUR-USER-NAME/Library/Application Support/Metaburner/Logs/Metaburner Renderer - 1.0.0 (27).log +``` -There is currently a bug in Final Cut Pro 10.7.1, where it incorrectly exports FCPXML `v1.11` when projects have Multicam Clips with individual Audio Role Voice Isolation. +You can press the **Reveal Crash Logs** button in the **Controls** section of the Inspector to access the `DiagnosticReports` folder in Finder. -Because Metaburner only accepts valid FCPXML files, if you have a project that has Multicam Clips with individual Audio Role Voice Isolation, it won't import into Metaburner. +![](static/reveal-log-files.png) -You can confirm this is the issue by exporting a FCPXML to your Desktop, then bringing it back it. +The crash logs are located here: -If you're hitting this bug you'll see something like this: +``` +~/Library/Logs/DiagnosticReports +``` -![](static/invalid-fcpxml.png) +The crash logs will have file names like `Metaburner Renderer-2023-12-24-103301.ips`. They might also be in the `Retired` sub-folder (these are reports that have already been posted to Apple). -The workaround is to instead export a FCPXML `v1.10` instead, then use the **Controls > Import Project via FCPXML** to bring it into Metaburner. +Alternatively, you can access your User Library, by clicking on your **Desktop**, then holding down **OPTION** as you click the **Go** menu item in Finder. A **Library** option will appear: -You can learn more about the bug on FCP Cafe [here](https://github.com/CommandPost/FCPCafe/issues/314). +![](static/finder-library.png) -We encourage you to also report it to Apple so they can fix it in the next update. \ No newline at end of file +You can also copy the above paths, press **COMMAND+SHIFT+G** from Finder (or via the **Go > Go to Folder...** menubar item), and paste in that path into the **Go to Folder** popup. \ No newline at end of file diff --git a/docs/lua-scripting.md b/docs/lua-scripting.md index 81382cf..ba16c6c 100644 --- a/docs/lua-scripting.md +++ b/docs/lua-scripting.md @@ -16,11 +16,19 @@ You can also do maths: ![](/static/lua-scripting.png) -You have access to the full FCPXML via the `fcpxmlData` global variable, which is stored as a `string`: +Each instance of Metaburner has it's own `uniqueIdentifier`. You can find this by using this Lua code: + +```lua +result = uniqueIdentifier +``` + +You can use this `uniqueIdentifier` to access the FCPXML and Processed Data. + +You have access to the full FCPXML via the `fcpxmlData_uniqueIdentifier` global variable, which is stored as a `string`: ![](/static/lua-fcpxml.png) -You have access to Metaburner's processed data via the `processedData` global variable, which is stored as a `table`: +You have access to Metaburner's processed data via the `processedData_uniqueIdentifier` global variable, which is stored as a `table`: ![](/static/lua-processed-data.png) diff --git a/docs/privacy.md b/docs/privacy.md index b0111cc..966c2e5 100644 --- a/docs/privacy.md +++ b/docs/privacy.md @@ -1,18 +1,16 @@ # Privacy Policy -This is the privacy policy for the Metaburner, macOS Application that is available on the Apple's TestFlight and FxFactory. +This is the privacy policy for the **Metaburner**, a macOS Application that is available on [FxFactory](https://fxfactory.com). -Metaburner does not collect any user data. No personal information is transmitted, stored, or used by this application. +**Metaburner** does not collect any user data. No personal information is transmitted, stored, or used by this application. -Metaburner does not use any third-party analytics or tracking tools. It does not contain any in-app purchases or advertisements. +**Metaburner** does not use any third-party analytics or tracking tools. It does not contain any in-app purchases or advertisements. -Metaburner does not communicate with any external servers or services, aside from FxFactory's licensing system, and it does not access any data on your device beyond what is necessary for the application to function properly. +**Metaburner** does not communicate with any external servers or services, aside from FxFactory's licensing system, and it does not access any data on your device beyond what is necessary for the application to function properly. -Apple may collect and use certain usage and performance data from the apps that are available on TestFlight. This data is used to help improve the App Store and the overall user experience. +FxFactory may collect and use certain usage and performance data from the apps that are available on FxFactory. This data is used to help improve FxFactory and the overall user experience. -This data collection is not specific to any individual user, and it is not possible for app developers to opt out of this data collection by Apple. - -You can read Apple's App Store Privacy Policy [here](https://www.apple.com/legal/privacy/data/en/app-store/). +This data collection is not specific to any individual user, and it is not possible for app developers to opt out of this data collection by FxFactory. You can read FxFactory's Privacy Policy [here](https://fxfactory.com/privacy-policy/). diff --git a/docs/release-notes.md b/docs/release-notes.md index 94ade3f..231ded2 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -1,5 +1,16 @@ # Release Notes +### 1.0.0 (27) + +**🎉 Released:** +- 9th January 2024 + +🔨 **Changes:** +- Actually removed the App Sandbox this time, so it works properly on FxFactory. +- This is the first public beta on FxFactory! Woohoo! + +--- + ### 1.0.0 (26) **🎉 Released:** diff --git a/docs/static/fxfactory.png b/docs/static/fxfactory.png new file mode 100644 index 0000000..8f44b80 Binary files /dev/null and b/docs/static/fxfactory.png differ diff --git a/docs/uninstall.md b/docs/uninstall.md index 3a48ee7..6d04883 100644 --- a/docs/uninstall.md +++ b/docs/uninstall.md @@ -1,3 +1,3 @@ # Uninstall -To uninstall Metaburner, simply drag the application to the trash/bin. \ No newline at end of file +To uninstall **Metaburner**, hold down the **OPTION** key when hovering over the **OPEN** button in FxFactory. \ No newline at end of file