Documentation Needs Major Updating

[prestonzen]

The documentation for the project is outdated and inconsistent, leading to multiple challenges for users. Key problems include:

1. Unreal Engine Version Mismatch:

   • Documentation states compatibility with Unreal Engine 5.2, but configuration files reference Unreal Engine 5.4.
   • While Unreal Engine 5.4 appears to work, it requires special workarounds that are not documented.

2. Build Environment and Setup:

   • No clear or comprehensive build guide for Unreal Engine 5.4.
   • Multiple issues arise during setup, including plugin errors and build failures.

3. Plugin Detection Issues:

   • Even after a successful build, plugin detection can be inconsistent.
   • In one instance, an install attempt broke Unreal Engine 5.3, requiring a re-run of the prerequisite checks to resolve.

4. Windows 11 Use:

   • Many users are now on Windows 11, yet the documentation does not address specific considerations for this OS.

Suggestions for Improvement

1. Update Documentation:

   • Clearly specify supported Unreal Engine versions and their compatibility.
   • Include step-by-step build guides for Unreal Engine 5.4.

2. Address Plugin and Build Issues:

   • Document common plugin detection problems and their fixes.
   • Provide troubleshooting steps for build failures and environment setup.

3. Clarify Ideal Environment:

   • Explicitly state the recommended OS, dependencies, and configurations.
   • Address Windows 11-specific nuances, if any.

4. Provide Known Workarounds:

   • Include a section for Unreal Engine 5.4-specific workarounds.
   • Document steps to recover from installation issues like broken setups or prerequisite re-runs.

   TL;DR

If the community sends me the proper build guides on how they got it to work then I can assist with building updated docs for the project 😎

[samiulextreem]

its very frustrating to see UE 5.2 not working as shown in the documents. After installing UE 5.4, still not working. Documents needs to be updated.