fcp7xml-to-unreal 0.2.0

Filter FCP XML files for import into Unreal Engine.

FCP7XML to Unreal

fcp7xml-to-unreal is a utility for filtering FCP XML (FCP 7 XML v5) editorial output for import into Unreal Engine.

Edit shots rendered from Unreal Engine in your preferred editing software and import the edits back into Unreal Engine, without crashing. Only FCP 7 XML v5 is supported.

This is the readme for developers. The documentation for users is available here: https://nick-animation-studio.github.io/fcp7xml-to-unreal/

Prerequisites

You will need Python installed. Tested with Python 3.9, expected to work with Python 3.9+.

Quickstart

Install using pip or pipx.

$ pip install fcp7xml-to-unreal

or

$ pipx install fcp7xml-to-unreal

This will provide the command-line utilities:

• fcp7xml-to-unreal - an XML filtering utility, fixing XML (FCP 7 XML v5 format only) exports for import into Unreal Engine.

See the user documentation for examples.

Developer Setup

Clone this repository (or fork on GitHub).

In the local repository directory, set up for Python development. The steps below show Astral's uv in use - but using Python venv is also fine.

# Create and activate Python virtual environment
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install development dependencies with the project set as editable
uv pip install -e ".[dev]"

or (not using uv)

python -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate

# update pip in venv
python -m pip install -U pip

# install
python -m pip install .
python -m pip install ".[dev]" # install with optional development packages

# Install Git pre-commit hooks
pre-commit install

Contributing

Contributions to improve this utility are welcome! Please submit issues and pull requests on GitHub.

Tests

See TESTS.md for details on running this product's tests.

License

This code is MIT licensed. See the LICENSE file for details.

References

• FCP7 XML Reference