mirror of
https://github.com/4sval/FModel.git
synced 2026-03-22 01:34:37 -05:00
Updated Getting Started (markdown)
Valentin
parent
a1ed33c189
commit
c9a3dfb7cc
|
|
@ -1,6 +1,6 @@
|
|||
**FModel is a [Freeware](https://www.gnu.org/philosophy/free-sw.html)** made to explore Unreal Engine games archives. This means that you don't have to pay for it and this won't change. Its [code](https://github.com/4sval/FModel) is open and available to everyone and reusable under certain conditions (see the [license text](https://github.com/4sval/FModel/blob/master/LICENSE) for more information).
|
||||
|
||||
FModel –of course– does not contain any malware, spyware, advertisements or undesired third-party programs.
|
||||
FModel –of course– does not contain any malware, spyware, advertisements, or undesired third-party programs.
|
||||
|
||||
## Get Started
|
||||
Once FModel is installed and launched, it will verify the integrity of a bunch of files and folders before any window appears.
|
||||
|
|
@ -44,7 +44,7 @@ We've spent a lot of time engineering the UX of this window in order to make the
|
|||
As said before, not to waste space, we bundled all navigation-related views into a single panel. Each view has its own information area to show stuff like archive's GUID, folder's package count, or package compression used. You can easily switch between views thanks to the shortcuts set under your [settings]().
|
||||
|
||||
### Archives
|
||||
This view will display your game archives, whether they are encrypted or not. **FModel doesn't allow you to load exported game packages, but you can use [CUE4Parse](https://github.com/FabianFG/CUE4Parse)** to do so. If your game archives are encrypted, you will need an [AES encryption key]() in order to decrypt them. If done correctly, your archives able to be loaded will have <img src="https://github.com/4sval/FModel/blob/master/FModel/Resources/archive_enabled.png" alt="archive_enabled" width="20"/> next to them, otherwise it will be <img src="https://github.com/4sval/FModel/blob/master/FModel/Resources/archive_disabled.png" alt="archive_disabled" width="20"/>.
|
||||
This view will display your game archives, whether they are encrypted or not. **FModel doesn't allow you to load exported game packages, but you can use [CUE4Parse](https://github.com/FabianFG/CUE4Parse)** to do so. If your game archives are encrypted, you will need an [AES encryption key]() in order to decrypt them. If done correctly, your archives able to be loaded will have <img src="https://github.com/4sval/FModel/blob/dev/FModel/Resources/archive_enabled.png" alt="archive_enabled" width="20"/> next to them, otherwise it will be <img src="https://github.com/4sval/FModel/blob/dev/FModel/Resources/archive_disabled.png" alt="archive_disabled" width="20"/>.
|
||||
|
||||
You can choose to load a single archive, several or all of them, but also compare 2 states and only show new or modified packages. If you choose to compare, you will need a [backup file]() older than the state of your current game archives.
|
||||
|
||||
|
|
@ -55,11 +55,33 @@ This view will display your archives folder tree structure. You can open folders
|
|||
This view will display packages stored under your selected folder. You can extract, export, and save the properties of all game packages no matter their type.
|
||||
|
||||
## Property
|
||||
In order to see packages' properties, you have at your disposal **up to 25 tabs**. Each tab is cut in half between the text area and the image area, both resizable.
|
||||
In order to see packages' properties, you have at your disposal **up to 25 tabs**. Each tab is cut in half between the text area and the image area, both resizable.
|
||||
|
||||
### Text
|
||||
Packages are made out of multiple exports that will all be displayed here and depending on the package extension, you will see different human-readable data formats (`INI`, `XML`, `TXT`, ...). Most of the time though, you will see the `JSON` format. If you don't know what is JSON or how to read it, you better [learn now](https://www.json.org/json-en.html). Since it is the most commonly seen, we've tweaked it a little bit:
|
||||
-  Represents an object name
|
||||
-  Represents an object value as string
|
||||
-  Represents a package, you can <kbd>Left Click</kbd> it
|
||||
-  Represents a color, you can <kbd>Mouse Hover</kbd> it
|
||||
-  Represents a link, you can <kbd>Ctrl</kbd><kbd>Left Click</kbd> it
|
||||
-  Represents an object value as a number
|
||||
-  Represents an object value as a boolean
|
||||
|
||||
With a <kbd>Right Click</kbd> on the tab, you can open a dedicated window where you will be able to fold/unfold the data. Keyboard shortcuts are as follow:
|
||||
- <kbd>Ctrl</kbd><kbd>K</kbd><kbd>J</kbd> to unfold all regions
|
||||
- <kbd>Ctrl</kbd><kbd>K</kbd><kbd>L</kbd> to toggle fold the region your mouse cursor is in
|
||||
- <kbd>Ctrl</kbd><kbd>K</kbd><kbd>0-9</kbd> to toggle fold a region by its index
|
||||
|
||||
### Image
|
||||
Whether the image is [generated by FModel]() or is a `Texture2D` embedded in the package, you will have the possibility to open it on a bigger window with a <kbd>Double Left Click</kbd>. On this new window, you can <kbd>Hold Left Click</kbd> to zoom in the image or <kbd>Hold Left Click</kbd><kbd>Scroll</kbd> to zoom even deeper.
|
||||
|
||||
### Sound
|
||||
A package that triggers the Audio Player (AD) is a package that holds audio. Supported types are either `SoundWave` or `AkMediaAssetData`, so if you are expecting to see the AD pops up, the package you selected simply doesn't have any of these export types. The AD is made out of 2 panels.
|
||||
1. The first panel displays your available output devices, the volume set, as well as a playlist containing your audio files set to be played one after the other. **DO NOT close the AD if you don't want your playlist to be cleared**.
|
||||
2. The second panel displays **a timeline to seek to a position** in your currently playing audio file. But most importantly, it contains an audio spectrum just so you don't get bored while listening to your favorite audio files.
|
||||
|
||||
Each individual audio file or the whole playlist can be saved with a <kbd>Right Click</kbd> on any of the files in your playlist.
|
||||
|
||||
### Mesh
|
||||
### Material
|
||||
### Animation
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user