Difference between revisions of "Elric"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
(Created page with "The Elrich is a tool to process Model Files and Texture Files into a more optimized form Fallout 4 will load. This utility is included with the Creation Kit a...")
 
imported>Alexperkins
(addition of minor image for clarity)
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
The [[Elrich]] is a tool to process [[Model File]]s and [[Texture File]]s into a more optimized form Fallout 4 will load.  
[[File:Elric Elrich disambiguation.png|right]]
 
[[Elric]] is a tool to process [[Model File]]s and [[Texture File]]s into a more optimized form Fallout 4 will load.  
This utility is included with the [[Creation Kit]] and can be found in <code>...\Steam\SteamApps\common\Fallout 4\Tools\Elrich</code>.
This utility is included with the [[Creation Kit]] and can be found in <code>...\Steam\SteamApps\common\Fallout 4\Tools\Elrich</code>.


Though some files and directories are named as "Elrich", the actual application name is "Elric".
The reasoning or origins of this naming are not known, although there appears to have been a disconnect when packaging creation kit, since the app name and internal dependencies use the older name, and details resolved just as creation kit was about to ship use the newer spelling.
[[File:Lack_of_naming_consensus.png]]
{{ClearFloats}}
== Setup ==
== Setup ==
Follow these configuration steps.
Follow these configuration steps.
# Open Elrich.exe.
# Launch Elrich.exe from the tools folder located at <code>...\Steam\SteamApps\common\Fallout 4\Tools\Elrich\Elrich.exe</code>.
# Select the File->"Load Settings" menu option.
# Select the <code>File -> Load Settings</code> menu option.
##-Navigate to your Elric/Settings/PCMeshes.esf file.
##-Navigate to your <code>...\Steam\SteamApps\common\Fallout 4\Tools\Elric\Settings\PCMeshes.esf</code> file.
##-Note: this will populate some of the properties of this tool. Additional configuration may still be required to fit your workflow.
##-Note: this will populate some of the properties of this tool. Additional configuration may still be required to fit your workflow.
# OPTIONAL: Specify an Output directory for any processed files. Defaults to Elric/Processed/...
#'''Optional:''' Specify an Output directory for any processed files. Defaults to <code>...\Steam\SteamApps\common\Fallout 4\Tools\Elric\Processed</code>.
# OPTIONAL: You can specify a log on conversion. The log supports wildcards (%m = month, %d = day, %y = year, etc...).
#'''Optional:''' You can specify a log on conversion. The log supports wildcards (%m = month, %d = day, %y = year, etc...).
##-For example: .\Logs\PCMeshes-%m-%d-%y_%h-%n-%s.elf
##-For example: <code>...\Logs\PCMeshes-%m-%d-%y_%h-%n-%s.elf</code>
# OPTIONAL: Select "Close Elric When Finished" to do exactly that (disabled by default in the settings file).
#'''Optional:''' Select ''Close Elric When Finished'' to do exactly that. This is disabled by default in the settings file.
# OPTIONAL: Select "Do Subdirectories" if you would like to process all files in a directory tree.
#'''Optional:''' Select ''Do Subdirectories'' if you would like to process all files in a directory tree.
# OPTIONAL: Select "Force Overwrite" if you would like the output files to always be written to their destination.
#'''Optional:''' Select ''Force Overwrite'' if you would like the output files to always be written to their destination.
# OPTIONAL: Select "Only Process If Source Is Newer" to ignore processing source files which already have output with a more recent timestamp (must disble Force Overwrite to use this).
#'''Optional:''' Select ''Only Process If Source Is Newer'' to ignore processing source files which already have output with a more recent timestamp. Must disable ''Force Overwrite'' to use this.


== Usage ==
== Usage ==
Line 21: Line 28:


[[Model File]]s will only process if there is a parent folder somewhere in their directory hierarchy which contains the string "Meshes".
[[Model File]]s will only process if there is a parent folder somewhere in their directory hierarchy which contains the string "Meshes".
:-'''INCORRECT:''' <code>C:\Fallout4\Data\Source\Geom\Mytest.nif</code> will NOT process correctly.
:-'''INCORRECT:''' <code>...\Steam\SteamApps\common\Fallout 4\Data\Source\Geom\Mytest.nif</code> will NOT process correctly.
:-'''CORRECT:''' <code>C:\Fallout4\Data\Source\Meshes\MyTest.nif</code>
:-'''CORRECT:''' <code>...\Steam\SteamApps\common\Fallout 4\Data\Source\Meshes\MyTest.nif</code>


# To convert a set of files, select the "Convert Files" button. Navigate to the directory with the files you want to process, and select any number of files for processing.
# To convert a set of files, select the ''Convert Files'' button. Navigate to the directory with the files you want to process, and select any number of files for processing.
# To convert a directory, select the "Convert Directory" button. Navigate to the directory to process.
# To convert a directory, select the ''Convert Directory'' button. Navigate to the directory to process.
# Errors may be output for some processing failures, which can aid in debugging bad source assets.
# Errors may be output for some processing failures, which can aid in debugging bad source assets.
# Assuming proper configuration, and no errors, any resulting processed files will be output in the specified Output directory.  
# Assuming proper configuration, and no errors, any resulting processed files will be output in the specified output directory.  


== Command Line ==
== Command Line ==
Line 42: Line 49:


== See Also ==
== See Also ==
*[[Script File]]
*[[Model File]]
*[[Model File]]
*[[Texture File]]
*[[Texture File]]

Latest revision as of 07:39, 25 June 2019

Elric Elrich disambiguation.png

Elric is a tool to process Model Files and Texture Files into a more optimized form Fallout 4 will load. This utility is included with the Creation Kit and can be found in ...\Steam\SteamApps\common\Fallout 4\Tools\Elrich.

Though some files and directories are named as "Elrich", the actual application name is "Elric". The reasoning or origins of this naming are not known, although there appears to have been a disconnect when packaging creation kit, since the app name and internal dependencies use the older name, and details resolved just as creation kit was about to ship use the newer spelling. Lack of naming consensus.png

Setup[edit | edit source]

Follow these configuration steps.

  1. Launch Elrich.exe from the tools folder located at ...\Steam\SteamApps\common\Fallout 4\Tools\Elrich\Elrich.exe.
  2. Select the File -> Load Settings menu option.
    1. -Navigate to your ...\Steam\SteamApps\common\Fallout 4\Tools\Elric\Settings\PCMeshes.esf file.
    2. -Note: this will populate some of the properties of this tool. Additional configuration may still be required to fit your workflow.
  3. Optional: Specify an Output directory for any processed files. Defaults to ...\Steam\SteamApps\common\Fallout 4\Tools\Elric\Processed.
  4. Optional: You can specify a log on conversion. The log supports wildcards (%m = month, %d = day, %y = year, etc...).
    1. -For example: ...\Logs\PCMeshes-%m-%d-%y_%h-%n-%s.elf
  5. Optional: Select Close Elric When Finished to do exactly that. This is disabled by default in the settings file.
  6. Optional: Select Do Subdirectories if you would like to process all files in a directory tree.
  7. Optional: Select Force Overwrite if you would like the output files to always be written to their destination.
  8. Optional: Select Only Process If Source Is Newer to ignore processing source files which already have output with a more recent timestamp. Must disable Force Overwrite to use this.

Usage[edit | edit source]

Some Model Files may only process properly if they are exported from the "BGS Fallout 4 NIF Export Plugin Toolset", included with the Creation Kit modding tools. This process will convert Havok data in an exported Model File to a format Fallout 4 will be able to load.

Model Files will only process if there is a parent folder somewhere in their directory hierarchy which contains the string "Meshes".

-INCORRECT: ...\Steam\SteamApps\common\Fallout 4\Data\Source\Geom\Mytest.nif will NOT process correctly.
-CORRECT: ...\Steam\SteamApps\common\Fallout 4\Data\Source\Meshes\MyTest.nif
  1. To convert a set of files, select the Convert Files button. Navigate to the directory with the files you want to process, and select any number of files for processing.
  2. To convert a directory, select the Convert Directory button. Navigate to the directory to process.
  3. Errors may be output for some processing failures, which can aid in debugging bad source assets.
  4. Assuming proper configuration, and no errors, any resulting processed files will be output in the specified output directory.

Command Line[edit | edit source]

Elric can be executed at the command line using the following parameters.

Update parameters to use full paths to any files or directories.

"fullpath/Elric/Elrich.exe" "fullpath/PCMeshes.esf" -ElricOptions.ConvertTarget="fullpath1,fullpath2,fullpath3,..." -ElricOptions.OutputDirectory="fulloutputpath"
-The first parameter is the ESF file.
-The ConvertTarget is a list of files or directories to process, delimited by a ",".
-Note: Any XML options in the PCMeshes.ESF can be passed at the command line as optional overrides, if necessary.

Notes[edit | edit source]

  • The texture process functions as a configuration wrapper to Microsoft's DirectXTex (texconv.exe) processing tool.

See Also[edit | edit source]