Baltram
10.09.2014, 02:13
[Deutscher Text - klick mich!] (http://forum.worldofplayers.de/forum/threads/1381917-tool-Risen-3-Resource-Manager?p=23508403&viewfull=1#post23508403)
With Risen 3 Resource Manager you can view and modify Risen 3 textures, sounds, music, speech, templates and sectors (world files).
This makes it possible to create various types of mods, including balancing mods, texture mods and music mods.
To get started, have a look at the tutorials section (http://forum.worldofplayers.de/forum/threads/1411254-Risen-3-Tutorials).
http://upload.worldofplayers.de/files9/r3resman.png
(276KB) (http://www.baltr.de/r3resman.zip)
Download (http://www.baltr.de/r3resman.zip)
Update: To create archives with the _z suffix for Risen 3: Enhanced Edition, use this new version (http://forum.worldofplayers.de/forum/threads/1381917-tool-Risen-3-Resource-Manager?p=24516618&viewfull=1#post24516618) of the tool.
------
------
Risen 3 Resource Manager v1.0 by Baltram <baltram-lielb@web.de> (January 14th 2014)
------
Risen 3 Resource Manager supports conversion of multiple file types related to Risen 3,
including images/textures, sounds/music, dialogs/speech, templates, sectors:
<folder>, .pak, .r3img, .r3snd, .r3dlg, .r3tpl, .r3sec, .dds, .wav,
.r3dlgdoc, .r3tpldoc, .r3secdoc, .r3secmod
Below are short instructions on how to perform these conversions.
For non-interactive use of this tool, see the list of command line parameters at the end of this document.
Unpacking Risen 3 volumes (.pak)
Drag the .pak file onto the r3resman.exe.
A folder will be created (in the same place as the .pak) containing the volume's contents.
Packing Risen 3 volumes (.pak)
Drag a folder onto the r3resman.exe and enter the archive generation of your choice (0-9).
A .pak volume will be created (in the same place as the folder) containing the folder's contents.
The archive generation affects the order in which Risen 3 loads volumes of the same type (e.g. 'img').
It is recommended to use 4-9 as a generation to avoid conflicts with potential upcoming official patches.
PAK volumes may only contain resources of ONE type (e.g. .r3img, .r3snd).
Converting Risen 3 images (.r3img) to .dds
Drag the .r3img file onto the r3resman.exe.
To convert all .r3img files in a folder, copy r3resman.exe and r3resman_r3img.cmd in that folder and
execute the .cmd file.
Converting Risen 3 sounds (.r3snd) to .wav
Drag the .r3snd file onto the r3resman.exe.
To convert all .r3snd files in a folder, copy r3resman.exe and r3resman_r3snd.cmd in that folder and
execute the .cmd file
Converting Risen 3 dialogs (.r3dlg) to .wav and .r3dlgdoc
Drag the .r3dlg file onto the r3resman.exe.
To convert all .r3dlg files in a folder, copy r3resman.exe and r3resman_r3dlg.cmd in that folder and
execute the .cmd file.
A .r3dlgdoc file contains facial animation and gesture data. It may be viewed and edited in a
text editor. There are approx. 30 frames per second of facial animation data (one byte per blend shape).
Converting Risen 3 templates (.r3tpl) to .r3tpldoc
Drag the .r3tpl file onto the r3resman.exe.
To convert all .r3tpl files in a folder, copy r3resman.exe and r3resman_r3tpl.cmd in that folder and
execute the .cmd file.
.r3tpldoc files can be modified using a text editor.
Converting Risen 3 sectors (.r3sec) to .r3secdoc
Drag the .r3sec file onto the r3resman.exe.
To convert all .r3sec files in a folder, copy r3resman.exe and r3resman_r3sec.cmd in that folder and
execute the .cmd file.
.r3secdoc files can be modified using a text editor.
Converting DDS images to Risen 3 images (.r3img)
Drag the .dds file onto the r3resman.exe.
To convert all .dds files in a folder, copy r3resman.exe and r3resman_dds.cmd in that folder and
execute the .cmd file.
Use DXT1 as compression algorithm for opaque textures and DXT3/5 for textures with hard/soft transparency.
Converting WAV sounds to Risen 3 sounds (.r3snd)
Drag the .wav file onto the r3resman.exe.
To convert all .wav files in a folder, copy r3resman.exe and r3resman_wav.cmd in that folder and
execute the .cmd file.
Converting WAV sounds and .r3dlgdoc files to Risen 3 dialogs (.r3dlg)
Drag the .r3dlgdoc file onto the r3resman.exe. There needs to be a .wav file with the same file name
in the same folder.
To convert all .r3dlgdoc files in a folder, copy r3resman.exe and r3resman_r3dlgdoc.cmd in that folder and
execute the .cmd file.
Converting Risen 3 template documents (.r3tpldoc) to .r3tpl
Drag the .r3tpldoc file onto the r3resman.exe.
To convert all .r3tpldoc files in a folder, copy r3resman.exe and r3resman_r3tpldoc.cmd in that folder and
execute the .cmd file.
Converting Risen 3 sector documents (.r3secdoc) to .r3sec
Drag the .r3secdoc file onto the r3resman.exe.
To convert all .r3secdoc files in a folder, copy r3resman.exe and r3resman_r3secdoc.cmd in that folder and
execute the .cmd file.
Processing Risen 3 sector modification files (.r3secmod)
Drag the .r3secmod file onto the r3resman.exe.
The program will open and modify all sector documents (.r3secdoc) in the same folder as the .r3secmod
file. It will also open and read template document files in this folder to obtain the property set data as
specified in the .r3secmod file. Property sets in the sectors are replaced by those from the templates.
.r3secmod files are text documents that contain one or multiple lines. Each line starts with the GUID or
the name of a template (the name must be in quotes). The rest of the line consists of a list of property
set names separated by spaces. Example of a two-line .r3secmod file:
"It_Pl_Maki" gCItem_PS gCInteraction_PS
{5F97FAE7-0F15-4549-B0DB-B9488CFE2212} gCSkillsNPC_PS
Command line parameters:
--non-interactive - Disables requests for user interaction (like pressing the enter key)
--generation [number in range 0-9] - Specifies the generation when creating .pak volumes
r3resman.exe <file or folder> <parameters>
[technical details]
When packing/unpacking PAK archives, this tool resolves resource hashes, thus giving the resource files meaningful names.
File format description of the generated resource files (.r3img, .r3msh, .r3tpl etc.):
Header {
char8_t Magic[4]; // "R3RF"
uint32_t ResourceHeaderOffset;
}
uint8_t _unknown[36]; // 0
ResourceData {
uint8_t Data1[ResourceOffsetTable.Data1Size];
uint8_t Data2[ResourceOffsetTable.Data2Size];
uint8_t Data3[ResourceOffsetTable.Data3Size];
uint8_t Data4[ResourceOffsetTable.Data4Size];
}
ResourceOffsetTable {
uint32_t Data1Offset;
uint32_t Data1Size;
char8_t _unknown1; // 0x00
uint32_t Data2Offset;
uint32_t Data2Size;
char8_t _unknown2; // 0x00
uint32_t Data3Offset;
uint32_t Data3Size;
char8_t _unknown3; // 0x00
uint32_t Data4Offset;
uint32_t Data4Size;
char8_t _unknown4; // 0x00
}
ResourceHeader {
uint32_t ResourceClassHash; // djb2
char8_t ResourceClassRevision[4];
uint32_t DatabaseEntrySize; // sizeof(ResourceHeader) - 12
uint32_t RawFileTime[2]; // FILETIME with high/low swapped
uint32_t _unknown1[2]; // FILETIME with high/low swapped - Raw created?
uint32_t _unknown2[2]; // FILETIME with high/low swapped - Raw created?
uint32_t CompiledFileTime[2]; // FILETIME with high/low swapped, not rounded to nearest 10000
ResourceName {
uint32_t Length;
char8_t String[Length];
}
ResourceOffsetTable {
uint32_t Data1Offset;
uint32_t Data1Size;
char8_t _unknown1; // 0x00
uint32_t Data2Offset;
uint32_t Data2Size;
char8_t _unknown2; // 0x00
uint32_t Data3Offset;
uint32_t Data3Size;
char8_t _unknown3; // 0x00
uint32_t Data4Offset;
uint32_t Data4Size;
char8_t _unknown4; // 0x00
}
uint32_t ReferencedFileCount;
for( ReferencedFileCount )
uint32_t FileTime[2]; // FILETIME with high/low swapped
for( ReferencedFileCount ) {
FileName {
uint32_t Length;
char8_t String[Length];
}
}
uint32_t _unknown; // 0x00000000
uint32_t ResourceObjectSize;
ResourceObject {
char8_t Magic[4]; // "GEC2"
uint32_t ResourceClassHash;
uint16_t Version;
uint32_t Size; // ResourceObjectSize - 14
{
Prop {
uint16_t Count;
for( Count ) {
uint32_t TypeHash;
uint32_t NameHash;
uint32_t Size;
uint8_t Data[Size];
}
}
ClassData {
uint32_t Count;
for( Count ) {
uint32_t ClassHash;
uint16_t Version;
uint32_t Size;
uint8_t Data[Size];
}
}
}
}
}
(It's basiacally the .rom file (http://forum.worldofplayers.de/forum/threads/1374683-Risen-3-File-Formats-and-other-things?p=23324092&viewfull=1#post23324092) plus the corresponding entry in the .db file (http://forum.worldofplayers.de/forum/threads/1374683-Risen-3-File-Formats-and-other-things?p=23324092&viewfull=1#post23324092) glued together.)
[source code] (https://github.com/Baltram/rmtools/blob/master/mimicry/source/MimicryApp/r3resourceman.cpp)
With Risen 3 Resource Manager you can view and modify Risen 3 textures, sounds, music, speech, templates and sectors (world files).
This makes it possible to create various types of mods, including balancing mods, texture mods and music mods.
To get started, have a look at the tutorials section (http://forum.worldofplayers.de/forum/threads/1411254-Risen-3-Tutorials).
http://upload.worldofplayers.de/files9/r3resman.png
(276KB) (http://www.baltr.de/r3resman.zip)
Download (http://www.baltr.de/r3resman.zip)
Update: To create archives with the _z suffix for Risen 3: Enhanced Edition, use this new version (http://forum.worldofplayers.de/forum/threads/1381917-tool-Risen-3-Resource-Manager?p=24516618&viewfull=1#post24516618) of the tool.
------
------
Risen 3 Resource Manager v1.0 by Baltram <baltram-lielb@web.de> (January 14th 2014)
------
Risen 3 Resource Manager supports conversion of multiple file types related to Risen 3,
including images/textures, sounds/music, dialogs/speech, templates, sectors:
<folder>, .pak, .r3img, .r3snd, .r3dlg, .r3tpl, .r3sec, .dds, .wav,
.r3dlgdoc, .r3tpldoc, .r3secdoc, .r3secmod
Below are short instructions on how to perform these conversions.
For non-interactive use of this tool, see the list of command line parameters at the end of this document.
Unpacking Risen 3 volumes (.pak)
Drag the .pak file onto the r3resman.exe.
A folder will be created (in the same place as the .pak) containing the volume's contents.
Packing Risen 3 volumes (.pak)
Drag a folder onto the r3resman.exe and enter the archive generation of your choice (0-9).
A .pak volume will be created (in the same place as the folder) containing the folder's contents.
The archive generation affects the order in which Risen 3 loads volumes of the same type (e.g. 'img').
It is recommended to use 4-9 as a generation to avoid conflicts with potential upcoming official patches.
PAK volumes may only contain resources of ONE type (e.g. .r3img, .r3snd).
Converting Risen 3 images (.r3img) to .dds
Drag the .r3img file onto the r3resman.exe.
To convert all .r3img files in a folder, copy r3resman.exe and r3resman_r3img.cmd in that folder and
execute the .cmd file.
Converting Risen 3 sounds (.r3snd) to .wav
Drag the .r3snd file onto the r3resman.exe.
To convert all .r3snd files in a folder, copy r3resman.exe and r3resman_r3snd.cmd in that folder and
execute the .cmd file
Converting Risen 3 dialogs (.r3dlg) to .wav and .r3dlgdoc
Drag the .r3dlg file onto the r3resman.exe.
To convert all .r3dlg files in a folder, copy r3resman.exe and r3resman_r3dlg.cmd in that folder and
execute the .cmd file.
A .r3dlgdoc file contains facial animation and gesture data. It may be viewed and edited in a
text editor. There are approx. 30 frames per second of facial animation data (one byte per blend shape).
Converting Risen 3 templates (.r3tpl) to .r3tpldoc
Drag the .r3tpl file onto the r3resman.exe.
To convert all .r3tpl files in a folder, copy r3resman.exe and r3resman_r3tpl.cmd in that folder and
execute the .cmd file.
.r3tpldoc files can be modified using a text editor.
Converting Risen 3 sectors (.r3sec) to .r3secdoc
Drag the .r3sec file onto the r3resman.exe.
To convert all .r3sec files in a folder, copy r3resman.exe and r3resman_r3sec.cmd in that folder and
execute the .cmd file.
.r3secdoc files can be modified using a text editor.
Converting DDS images to Risen 3 images (.r3img)
Drag the .dds file onto the r3resman.exe.
To convert all .dds files in a folder, copy r3resman.exe and r3resman_dds.cmd in that folder and
execute the .cmd file.
Use DXT1 as compression algorithm for opaque textures and DXT3/5 for textures with hard/soft transparency.
Converting WAV sounds to Risen 3 sounds (.r3snd)
Drag the .wav file onto the r3resman.exe.
To convert all .wav files in a folder, copy r3resman.exe and r3resman_wav.cmd in that folder and
execute the .cmd file.
Converting WAV sounds and .r3dlgdoc files to Risen 3 dialogs (.r3dlg)
Drag the .r3dlgdoc file onto the r3resman.exe. There needs to be a .wav file with the same file name
in the same folder.
To convert all .r3dlgdoc files in a folder, copy r3resman.exe and r3resman_r3dlgdoc.cmd in that folder and
execute the .cmd file.
Converting Risen 3 template documents (.r3tpldoc) to .r3tpl
Drag the .r3tpldoc file onto the r3resman.exe.
To convert all .r3tpldoc files in a folder, copy r3resman.exe and r3resman_r3tpldoc.cmd in that folder and
execute the .cmd file.
Converting Risen 3 sector documents (.r3secdoc) to .r3sec
Drag the .r3secdoc file onto the r3resman.exe.
To convert all .r3secdoc files in a folder, copy r3resman.exe and r3resman_r3secdoc.cmd in that folder and
execute the .cmd file.
Processing Risen 3 sector modification files (.r3secmod)
Drag the .r3secmod file onto the r3resman.exe.
The program will open and modify all sector documents (.r3secdoc) in the same folder as the .r3secmod
file. It will also open and read template document files in this folder to obtain the property set data as
specified in the .r3secmod file. Property sets in the sectors are replaced by those from the templates.
.r3secmod files are text documents that contain one or multiple lines. Each line starts with the GUID or
the name of a template (the name must be in quotes). The rest of the line consists of a list of property
set names separated by spaces. Example of a two-line .r3secmod file:
"It_Pl_Maki" gCItem_PS gCInteraction_PS
{5F97FAE7-0F15-4549-B0DB-B9488CFE2212} gCSkillsNPC_PS
Command line parameters:
--non-interactive - Disables requests for user interaction (like pressing the enter key)
--generation [number in range 0-9] - Specifies the generation when creating .pak volumes
r3resman.exe <file or folder> <parameters>
[technical details]
When packing/unpacking PAK archives, this tool resolves resource hashes, thus giving the resource files meaningful names.
File format description of the generated resource files (.r3img, .r3msh, .r3tpl etc.):
Header {
char8_t Magic[4]; // "R3RF"
uint32_t ResourceHeaderOffset;
}
uint8_t _unknown[36]; // 0
ResourceData {
uint8_t Data1[ResourceOffsetTable.Data1Size];
uint8_t Data2[ResourceOffsetTable.Data2Size];
uint8_t Data3[ResourceOffsetTable.Data3Size];
uint8_t Data4[ResourceOffsetTable.Data4Size];
}
ResourceOffsetTable {
uint32_t Data1Offset;
uint32_t Data1Size;
char8_t _unknown1; // 0x00
uint32_t Data2Offset;
uint32_t Data2Size;
char8_t _unknown2; // 0x00
uint32_t Data3Offset;
uint32_t Data3Size;
char8_t _unknown3; // 0x00
uint32_t Data4Offset;
uint32_t Data4Size;
char8_t _unknown4; // 0x00
}
ResourceHeader {
uint32_t ResourceClassHash; // djb2
char8_t ResourceClassRevision[4];
uint32_t DatabaseEntrySize; // sizeof(ResourceHeader) - 12
uint32_t RawFileTime[2]; // FILETIME with high/low swapped
uint32_t _unknown1[2]; // FILETIME with high/low swapped - Raw created?
uint32_t _unknown2[2]; // FILETIME with high/low swapped - Raw created?
uint32_t CompiledFileTime[2]; // FILETIME with high/low swapped, not rounded to nearest 10000
ResourceName {
uint32_t Length;
char8_t String[Length];
}
ResourceOffsetTable {
uint32_t Data1Offset;
uint32_t Data1Size;
char8_t _unknown1; // 0x00
uint32_t Data2Offset;
uint32_t Data2Size;
char8_t _unknown2; // 0x00
uint32_t Data3Offset;
uint32_t Data3Size;
char8_t _unknown3; // 0x00
uint32_t Data4Offset;
uint32_t Data4Size;
char8_t _unknown4; // 0x00
}
uint32_t ReferencedFileCount;
for( ReferencedFileCount )
uint32_t FileTime[2]; // FILETIME with high/low swapped
for( ReferencedFileCount ) {
FileName {
uint32_t Length;
char8_t String[Length];
}
}
uint32_t _unknown; // 0x00000000
uint32_t ResourceObjectSize;
ResourceObject {
char8_t Magic[4]; // "GEC2"
uint32_t ResourceClassHash;
uint16_t Version;
uint32_t Size; // ResourceObjectSize - 14
{
Prop {
uint16_t Count;
for( Count ) {
uint32_t TypeHash;
uint32_t NameHash;
uint32_t Size;
uint8_t Data[Size];
}
}
ClassData {
uint32_t Count;
for( Count ) {
uint32_t ClassHash;
uint16_t Version;
uint32_t Size;
uint8_t Data[Size];
}
}
}
}
}
(It's basiacally the .rom file (http://forum.worldofplayers.de/forum/threads/1374683-Risen-3-File-Formats-and-other-things?p=23324092&viewfull=1#post23324092) plus the corresponding entry in the .db file (http://forum.worldofplayers.de/forum/threads/1374683-Risen-3-File-Formats-and-other-things?p=23324092&viewfull=1#post23324092) glued together.)
[source code] (https://github.com/Baltram/rmtools/blob/master/mimicry/source/MimicryApp/r3resourceman.cpp)