Skip to content

Commit d095438

Browse files
committed
update README.md
1 parent 0b651d2 commit d095438

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

Docs/diagram.png

44.9 KB
Loading

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
## Assets conversion description
88

9+
![Flowchart showing conversion process](Docs/diagram.png)
10+
911
FEZ stores its game assets in four `.pak` package files: `Essentials.pak`, `Music.pak`, `Other.pak` and `Updates.pak`. These packages can contain three different file types:
1012

1113
- **Ogg** - digital multimedia container. Stores music.
@@ -34,16 +36,17 @@ Here's a list of all 13 asset types handled by FEZ and file types Repacker conve
3436

3537
You can read about conversion formats in detail [here](https://fezmodding.github.io/wiki/content/content_conversion).
3638

37-
> [!WARNING]
38-
>
39-
> By default, the Repacker converts ArtObject and TrileSet 3D models with all-in-one binary glTF bundles
40-
> for proper import and export process with popular 3D viewers and editors (i.e. Blender).
41-
>
42-
> However, early versions of the Repacker used the legacy bundle format with separate files.
43-
> If you want to use this early format, check the flags of the CLI commands to activate this.
44-
4539
If you want to learn more about the technical process of reading PAK packages and XNB files, read [this page on the wiki.](https://fezmodding.github.io/wiki/game/content_formats).
4640

41+
### Legacy conversion notice
42+
43+
By default, the Repacker converts ArtObject and TrileSet assets with all-in-one binary glTF bundles
44+
for proper import and export process with popular 3D viewers and editors (i.e. Blender).
45+
46+
However, early versions of the Repacker used the legacy format consisting of OBJ, PNG and JSON file bundle.
47+
If you want to use this early format, check the flags of the CLI commands to activate this.
48+
49+
4750
## Usage
4851

4952
As of right now, FEZ Repacker is a command line tool. In order to see a list of available commands, use `FEZRepacker.exe --help`. Launching executable with no parameters will start an interactive mode.
@@ -103,7 +106,7 @@ Most of the work with building is handled by MSBuild.
103106

104107
The solution is separated into two projects: `Core` and `Interface`.
105108

106-
`Core` contains nearly all of the logic, and is meant to be a stand-alone binary that can be used by other software (most notably, HAT mod loader).
109+
`Core` contains nearly all the logic, and is meant to be a stand-alone binary that can be used by other software (most notably, HAT mod loader).
107110

108111
`Interface` contains console line interface layer and can be used as a reference for interacting with `Core` library. It is distributed as a self-contained executable using the following command:
109112
`dotnet publish -c Release -r win-x86 --self-contained`
@@ -120,7 +123,7 @@ This project uses:
120123
Sources used in a process of writing this tool and documentation:
121124

122125
- [.pak structure reverse-engineering by Mathias Panzenböck (panzi)](http://hackworthy.blogspot.com/2017/08/reverse-engineering-simple-game-archive.html)
123-
- [Official XNB format documentation by Microsoft Corportation](https://docplayer.net/49383763-Microsoft-xna-game-studio-4-0-compiled-xnb-content-format.html)
126+
- [Official XNB format documentation by Microsoft Corporation](https://docplayer.net/49383763-Microsoft-xna-game-studio-4-0-compiled-xnb-content-format.html)
124127
- [XNB reader code from open source implementation of MonoGame](https://github.com/labnation/MonoGame/blob/d270be3e800a3955886e817cdd06133743a7e043/MonoGame.Framework/Content/ContentManager.cs#L405)
125128
- [xnb_parse repository by fesh0r](https://github.com/fesh0r/xnb_parse/)
126129
- My own decompilation of the latest FEZ release (as of 2022)

0 commit comments

Comments
 (0)