Skip to content

Modding

srkizer edited this page Sep 25, 2021 · 7 revisions

This method of applying mods will not modify any game data file. XivAlexander will apply an overlay which is only visible to the game process, making the game think that the data files are as how we would like it (mods applied), while leaving the original files untouched.

Setup

  • You will have to do one of the following to have this feature applied.
    • Install XivAlexander.
    • Use XivAlexanderLoader to launch the game.
    • Restart game via XivAlexander menu (Force Restart).
  • Check Enable in Modding.

Installing mod files

  • Drag TTMP2 or TTMPL file into XivAlexander main window. You can either drag from explorer, or any kind of sane file archiving program.
    • Drag and drop
    • Or, use Modding > TexTools ModPacks > Import from XivAlexander control window, if above option does not work.
  • If the mod you've installed is configurable, you should be given additional options in Modding > TexTools ModPacks > (mod name).

Installing individual mod files manually

You probably won't have to do this, but if you want to change the order of mods loaded, you can change the names of the folders that contain TTMPL.mpl and TTMPD.mpd files.

  • XivAlexander will look for files to override in:
    • If UseDefaultTexToolsModPackSearchDirectory is true:
      • <Installation Folder>\TexToolsMods for TTMPL/D files
      • <Game Folder>\TexToolsMods for TTMPL/D files
    • If UseDefaultGameResourceFileEntryRootDirectory is true:
      • <Installation Folder>\ReplacementFileEntries for one-to-one file replacements
      • <Game Folder>\sqpack\*\###### for one-to-one file replacements
      • <Game Folder>\sqpack\*\######.win32 for one-to-one file replacements
    • AdditionalGameResourceFileEntryRootDirectories in runtime configuration for one-to-one file replacements
    • AdditionalTexToolsModPackSearchDirectories in runtime configuration for TTMPL/D files
      • Paths are relative to the folder where XivAlexander DLL is, when given as relative paths.
  • To use TTMPL/D files, you first have to extract the TTMP file (which is basically a ZIP file in a specific extension), and copy the folder into aforementioned TTMPL/D related folders. XivAlexander will load files in case-sensitive alphabetical order of file paths (see this)
    • For example, there will be:
    • %APPDATA%\XivAlexander\TexToolsMods\00001 - First ModPack to Load\TTMPD.mpd
    • %APPDATA%\XivAlexander\TexToolsMods\00001 - First ModPack to Load\TTMPL.mpl
    • %APPDATA%\XivAlexander\TexToolsMods\00002 - Second ModPack to Load\TTMPD.mpd
    • %APPDATA%\XivAlexander\TexToolsMods\00002 - Second ModPack to Load\TTMPL.mpl
    • and so on.

Per mod entry configuration

  • Make disable file in TTMPL/D folder to make XivAlexander ignore that entry.
  • To use TTMPL/D files with installation wizard (ModPackPages), make choices.json in the folder with TTMPL.mpl. File looks like the following:
    [
     [1, 2, 5, 8],
     [4, 6],
     [2, 15]
    ]
    • Outer array stands for "pages".
    • Inner array stands for "groups".
    • 1 means that you are going to use 2nd (0-based) option for the 1st mod group in the 1st page.
    • 15 means that you are going to use 16th option for the 2nd mod group in the 3rd page.
    • If choices.json is not given, XivAlexander will choose the 1st items for every mod group in every page.
Clone this wiki locally