Leahnaya/FModel
1
0
Fork 0
mirror of https://github.com/4sval/FModel.git synced 2026-03-22 01:34:37 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated Getting Started (markdown)

Valentin 2023-01-14 02:22:21 +01:00
parent 67e0010e15
commit fdf628dd63
1 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Getting-Started.md

@ -36,6 +36,7 @@ We've spent a lot of time engineering the UX of this window in order to make the
4. [Mesh](#mesh)
5. [Material](#material)
6. [Animation](#animation)
7. [Level](#level)
3. [Console](#console)
![image](https://user-images.githubusercontent.com/26126862/184534306-7a618be2-2330-4279-a9ee-675c9a1a733d.png)
@ -85,21 +86,31 @@ Each individual audio file or the whole playlist can be saved with a <kbd>Right
![image](https://user-images.githubusercontent.com/26126862/184900761-fb60976d-10ff-4dd9-9bb0-72a7d10ae63e.png)
### Mesh
A package that triggers the Mesh Viewer (MV) is a package that holds some kind of 3D model. Supported types are either `StaticMesh` or `SkeletalMesh`, so if you are expecting to see the MV pops up, the package you selected simply doesn't have any of these export types. The MV is made out of 2 panels.
1. The first panel displays the list of models you loaded. Models can contain 1 or more sections, each section will have its own material, and each [material can be overwritten]() with a <kbd>Right Click</kbd>. You also have the ability to hide or make that section a wireframe with buttons right next to them.
2. The second panel is the [viewport](https://en.wikipedia.org/wiki/Viewport) where you can rotate, pan, or zoom around the selected model.
A package that triggers the 3D Viewer (3V) is a package that holds some kind of 3D model. Supported types are either `StaticMesh` or `SkeletalMesh`, so if you are expecting to see the 3V pops up, the package you selected simply doesn't have any of these export types. The 3V is a powerful window dedicated to showing models, maps, materials, and animations. It contains:
1. An outliner where all loaded models will be shown. Models can contain 1 or more sections, each section will have its own material, and each [material can be swapped]() with a <kbd>Right Click</kbd>. You also have the ability to hide the whole mesh, change its position/rotation/scale, wireframe it, and more.
2. A material inspector where you can see materials' properties and play with some of their settings.
3. A [viewport](https://en.wikipedia.org/wiki/Viewport) where you can fly around or rotate, pan, and zoom around the selected model. If you <kbd>Right Click</kbd> the model, it will select it.
4. A world tab where you can save all loaded models, and play with some of the world properties.
5. You can press <kbd>H</kbd> to hide the 3V, and the next time you extract a model it will be added to the world while keeping old loaded models. Press ESC to clear the world and close the 3V.
You can save the loaded models as `.psk` for use in other programs such as Blender or 3DS Max.
![image](https://user-images.githubusercontent.com/26126862/184927047-3ed00d01-6892-44ed-bcfa-1ef3c67b8aed.png)
![FModel_JaEY0NKmui](https://user-images.githubusercontent.com/26126862/212442433-4447e9c4-07a9-46b6-b38f-6afe1a6905d3.png)
### Material
There is no "Material Viewer" per se. Instead, we use the Model Viewer (MV) to display materials. Everything works the same, the only difference is that the model used will simply be a cube. The only supported type is `MaterialInstance`, so if you are expecting to see the MV pops up, the package you selected simply doesn't have any of this export type.
There is no "Material Viewer" per se. Instead, we use the 3DViewer (3V) to display materials. Everything works the same, the only difference is that the model used will simply be a cube. The only supported type is `MaterialInstance`, so if you are expecting to see the 3V pops up, the package you selected simply doesn't have any export type like this.
When saving a material, you will get a `.mat` file as well as all its textures as `.png`.
When saving a material, you will get a `.json` file containing the properties of the material as well as all its textures as `.png`.
### Animation
There is currently no Animation Viewer and no possibility to preview animations in FModel. Instead, if one of your package's exports type is a `AnimSequence`, it will automatically be saved as `.psa`.
Coming soon. In the meantime, if one of your package's exports type is a `AnimSequence`, <kbd>Right Click</kbd> it to save the animation it contains as `.psa`.
### Level
There is no "Level Viewer" per se. Instead, we use the 3DViewer (3V) to display levels. Everything works the same, the only difference is that all models referenced in the level will be loaded and it may take some time. The only supported type is `World`, so if you are expecting to see the 3V pops up, the package you selected simply doesn't have any export type like this. You can also load lighting levels to add lights to your world, you'll have to enable the lights under the World tab though.
While you can save individual models by <kbd>Right Clicking</kbd> them in the outliner, it is not recommended to save them all and there's currently no way to save the whole world into a single file.
![FModel_qQ5dAZ40C4](https://user-images.githubusercontent.com/26126862/212443486-4e13621a-33e0-48cc-a129-81742c863a68.png)
## Console
A little panel to **display warnings, errors, and other information** about what FModel does in the background. There is much more information in log files but _less is more_, so here you go. If needed, you can close this panel but we do not recommend doing so as you won't be able to see, if any, the cause of issues.