You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-27Lines changed: 21 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,37 +2,32 @@
2
2
## Overview
3
3
This is a plugin for the Unreal Engine to load 3D assets (e.g. FBX) at runtime. Made with UE5.4.2.
4
4
5
-
## Prerequisites
6
-
- Windows is the primary supported platform. macOS (arm64 only; x86_64 not supported) and Linux support is experimental.
7
-
- Download and install [CMake](https://cmake.org/)
8
-
The check box "Add CMake to the PATH environment variable" that appears during installation must be checked.
5
+
## Recommended approach: DynamicMesh (stable)
6
+
7
+
**Use the `DynamicMesh` path for all builds.** The `ConstructDynamicMeshComponentFromAssetFile` and `ConstructDynamicMeshComponentFromMeshData` Blueprint functions are the stable, recommended methods that work correctly in both editor and packaged builds.
8
+
9
+
> **StaticMesh functions are [Experimental].**`ConstructStaticMeshComponentFromAssetFile` and related StaticMesh functions have a known limitation in packaged builds (no editor): **materials display as a checkerboard pattern**. Avoid using them unless you understand and accept this limitation.
9
10
10
-
> **Note:** The first build of the assimp library (a C++ dependency) takes approximately 5 or more minutes. Subsequent builds are fast. This is expected behavior.
11
+
## Prerequisites
12
+
- Windows (Win64) is the primary supported platform.
11
13
12
14
## How to install
13
-
Clone this repository with its submodules into the Plugins folder (or create your own if you don't have one) in the folder of the Unreal Engine project where you want to install this plugin by doing one of the following:
1.Launch "Github Desktop" application (if not available, install it first).
18
-
2.From the menu, select File > Clone repository...
19
-
3.Go to the URL tab.
20
-
4. Enter the URL of this Github repository in "URL or username/repository", select the Plugins folder of the project where you want to install this plugin in "Local path", and press Clone.
21
-
</details>
16
+
1.Copy (or clone) this plugin folder into the `Plugins/` folder of your Unreal Engine project. Create the `Plugins/` folder if it does not exist.
17
+
2.Open your project. When prompted "The following modules are missing or built with a different engine version: RuntimeAssetImport", press **Yes** to build.
18
+
3.The plugin is now enabled and ready to use.
19
+
20
+
> **Note:** Win64 prebuilt binaries for assimp are included. No CMake or manual build step is required.
2. In the Plugins folder of the project where you want to install this plug-in, start a command prompt.
28
-
3. Execute
29
-
```
30
-
git clone --recursive URL
31
-
```
32
-
Put the URL of this repository in the URL field.
33
-
</details>
23
+
<summary>Alternative: clone with Git</summary>
34
24
35
-
After installing the plugin using one of the above procedures, open the project (Press Yes when you see "The following modules are missing or built with a different engine version: RuntimeAssetImport") and the plugin is enabled.
25
+
In the `Plugins/` folder of your project, run:
26
+
```
27
+
git clone <URL of this repository>
28
+
```
29
+
Then open the project and press **Yes** when prompted to build.
30
+
</details>
36
31
37
32
## How to use
38
33
Run [Runtime Asset Import Sample](https://github.com/Udon-Tobira/RuntimeAssImpSample).
@@ -58,7 +53,7 @@ The plugin's `Content` folder includes the following assets:
58
53
## Known Bugs
59
54
60
55
-**Multiplayer (ProceduralMesh):** Clients may experience abnormal movement accompanied by a `LogNetPackageMap` warning. Use `DynamicMeshComponent` instead as a workaround.
61
-
-**Packaged game materials (StaticMesh):** Materials display as a checkerboard pattern in packaged builds. Use `DynamicMeshComponent` instead as a workaround.
56
+
-**Packaged game materials (StaticMesh — Experimental):** Materials display as a checkerboard pattern in packaged builds. Use `DynamicMeshComponent` instead as a workaround.
62
57
63
58
## Running Tests
64
59
@@ -76,5 +71,4 @@ Or from the UE Editor UI: **Window > Test Automation**, search `RuntimeAssetImpo
76
71
- Only 1 vertex color channel is supported
77
72
78
73
## Description of the technology inside
79
-
We are using assimp as a git submodule, CMake is only needed to build assimp. The actual loading of the asset files is done by assimp, and this plugin only converts them from the format loaded by assimp to a format usable by the Unreal Engine. The build of assimp is done automatically during the project build process.
80
-
74
+
We are using assimp for loading 3D asset files. Prebuilt Win64 binaries (`assimp-vc143-mt.dll` / `.lib`) are bundled under `Source/ThirdParty/assimp/Bin/Win64` and `Lib/Win64`. This plugin converts the data loaded by assimp into a format usable by Unreal Engine.
0 commit comments