Skip to content

Dev mac update documentation#6

Merged
sir306 merged 3 commits intomainfrom
dev-mac-update-documentation
Apr 7, 2026
Merged

Dev mac update documentation#6
sir306 merged 3 commits intomainfrom
dev-mac-update-documentation

Conversation

@sir306
Copy link
Copy Markdown
Owner

@sir306 sir306 commented Apr 1, 2026

Packaging the project on Mac platforms has been confirmed to work with the new documentation. Will perform a final check of the new documentation to ensure spelling and grammar is correct. This will be confirmed in the coming days and will be able to close the roadmap implement git LFS.

Testing of the mac cloning and packaging steps was limited due to only having one Mac device to test on. While this satisfies internal testing procedures, other users and developers may have problems that I didn't encounter.

sir306 added 3 commits March 31, 2026 11:33
Add robust macOS screenshot flow and packaging guidance. Implement macOS-specific preflight write probe, FScreenshotRequest delegate handler, async PNG compression/save, timeout handling, and state reset; add BeginDestroy override to unbind the screenshot delegate. Introduce platform-specific Engine.ini files (Mac/Windows) and move renderer MegaLights setting into per-platform configs; add local mac signing setting to DefaultEngine.ini. Update .gitignore to exclude hdf5 share and MobiusCaptures test data. Expand docs/BUILD-AND-RUN.md with macOS packaging entitlements and runtime Files & Folders permission guidance.

Will perform a clean clone and test following documentation steps to ensure the process is correct and no steps are missed. Once confirmed will create tutorial video to aid mac users
Update docs/BUILD-AND-RUN.md to clarify Unreal Engine build workflow: recommend opening the .uproject and allowing Unreal to rebuild missing modules automatically, and only generate IDE/Visual Studio project files and manually build the editor if the automatic rebuild fails or IDE integration is required. Replace "Xcode Command Line Tools" with requiring full Xcode selected via xcode-select and add Unreal 5.5 Xcode compatibility details (min 15.2.0, max 16.9.0) plus note that local setup used Xcode 16.4.
Clarify macOS build and packaging guidance in BUILD-AND-RUN.md. Reword Xcode compatibility to state UE5.5 supports Xcode 15.2.0 through 16.9.0 and note the docs were last tested with Xcode 16.4. Add a known macOS limitation: heatmap Gaussian blur depends on Epic's OpenCV plugin and Mac OpenCV libs are not shipped, requiring a custom plugin or code replacement. Improve Unreal build instructions to prefer letting the editor rebuild missing modules and explain IDE integration options (Visual Studio/Xcode) only when needed. Expand macOS packaging notes to describe local entitlement templates, warn that they may not be present in a fresh checkout, instruct developers to run a local packaging pass to generate and review them, and remind contributors not to commit local packaging resources or generated StagedBuilds. Also adjust wording to make clear disabling the App Sandbox does not bypass macOS privacy prompts.
@sir306
Copy link
Copy Markdown
Owner Author

sir306 commented Apr 1, 2026

perform fresh windows test of this branch as we have modified a couple source files and .ini files. While these shouldn't break windows packaging the new platform specific megalight setting needs to be checked

@sir306 sir306 merged commit 741fa8b into main Apr 7, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant