Star growth

Today—

This week—

This month—

Repository activity

Activity history will appear here once this repo has been tracked for a couple of days.

Embed badge

Show this repository's current trending rank in your README.

Trending badge for amirmushichge/unreal-home-wizard

Markdown for your README

[![Trending on Repoburst](https://www.repoburst.com/api/badge/amirmushichge/unreal-home-wizard)](https://www.repoburst.com/repo/amirmushichge/unreal-home-wizard)

README

Unreal Home Wizard

Turn photographs of a room, apartment, or house into a reviewable, walkable Unreal Engine project with Codex.

This is a guided production workflow for complete beginners. It does not promise a measured digital twin from photographs alone, and it does not silently install Unreal Engine or accept third-party terms for the user.

Install in Codex

Paste this into a new Codex task:

Install the Unreal Home Wizard skill from:
https://github.com/amirmushichge/unreal-home-wizard/tree/v0.2.0/skills/unreal-home-wizard

After Codex confirms installation, restart Codex and paste:

$unreal-home-wizard - start a new project from scratch.

The wizard asks one simple question at a time. If photographs already exist, it asks the user to attach them. Technical setup is inspected before construction.

What is automatic

installing the Codex skill from this public repository;
checking the local Windows or macOS system, Codex, Unreal, disk, memory, GPU, and project setup;
creating and running reviewed Unreal Editor Python scripts after authorization;
organizing private references, evidence, matched cameras, defects, and results;
repeated photo-match and physical-logic QA.

What still needs the user

signing in to Epic Games and accepting Epic's terms;
approving the multi-gigabyte Unreal Engine installation;
approving purchases or third-party asset downloads;
supplying photographs and confirming publication rights;
approving the rough layout and final result.

Requirements

Windows 10 22H2 (64-bit) or newer; Windows 11 is recommended by Epic; or
an Apple Silicon Mac running macOS Sonoma 14 or newer for the macOS beta path;
Codex desktop or Codex CLI with local workspace access;
Epic Games Launcher and Unreal Engine 5.8 for the tested path;
recommended for Windows UE5 authoring: 32 GB RAM, 8 GB or more graphics memory, a DirectX 12-compatible GPU, and current drivers;
recommended for macOS: Apple Silicon with 32 GB unified memory; UE 5.8 no longer supports rendered Unreal Editor work on Intel Macs;
enough free SSD space for Unreal Engine, source assets, caches, and output.

Python does not need to be installed separately. Unreal Engine 5.8 includes its own Python 3.11.8 environment. The project must enable PythonScriptPlugin and EditorScriptingUtilities.

See DEPENDENCIES.md for the verified dependency boundary and docs/SETUP.md for the beginner setup path.

Current status

v0.2.0 is a public beta of the workflow and local automation bridge. On Windows, the bridge uses UnrealEditor-Cmd.exe; on macOS it uses the executable inside UnrealEditor.app. Both pass Epic's documented -ExecutePythonScript argument and do not require a third-party MCP server.

The Windows path has completed a real Unreal Engine 5.8 smoke test. The macOS shell workflow is covered by a native macOS CI test, but its Unreal launch path is still beta until it completes the same smoke test on an Apple Silicon Mac with Unreal Engine 5.8 installed. A successful preflight proves local automation, not the visual accuracy of a finished reconstruction.

The Mostar client project, client photographs, paid assets, and local caches are not included.

Official documentation

License

Original repository content is licensed under Apache-2.0. Unreal Engine is licensed separately by Epic Games. This project is not affiliated with or endorsed by Epic Games or OpenAI.