Using the Mod Manager - Kizari/Flagrum GitHub Wiki

WARNING

To ensure your mods work correctly, please carefully read at least the Important Preparation section of this document.

 

Flagrum's Mod Manager can effortlessly install mods in just a couple of clicks. As of Flagrum 1.5, this is done without even needing to alter the original game files! Due to the nature of the Mod Manager, Flagrum mods are also much smaller and have fewer conflicts than traditional mods. However, Flagrum can also install most legacy mods as well for those mods that haven't been updated.
 

Mod Manager

A huge thanks to Rinual for providing feedback and helping test the Mod Manager functionality.

 


Table of Contents


Important Preparation

Flagrum works by patching the game files at runtime. Because of this, Flagrum will not work on any version of FFXV except the latest Steam version of the game. To clarify, Flagrum will likely not work if you have altered the game's .exe, either by using the Avatara Patch mod on Nexus, Special K, pirated game copies, Debug version of the game, or use any other .DLL / patch / game injectable at the same time.

If you have already modded your files prior to installing Flagrum, it is advised to delete the game installation fully. Remove the folder that ffxv_s.exe is in, and all folders around it, to make sure that no programs are interfering with Flagrum. At a minimum, you should restore your game files to the original state. Using Flagrum on top of modded files may have unintended consequences, as the Mod Manager has no way of knowing what the original files were, nor what changes the modders may have made to those files.

The quickest way to restore the original game files is to use Steam's "Verify Integrity of Game Files" functionality. This will not affect your saved games, so it is safe to use at any time, however, if you still have issues, we recommend fully deleting your FFXV game folder.  

                    You can skip the rest of this section if your game is not already modded.

 

  1. Go to your Steam Library and right-click FINAL FANTASY XV WINDOWS EDITION—then click "Properties..."

FF15 Properties

  1. From the window that appears, click the "Local Files" tab and then click "Verify Integrity of Game Files."

FF15 Verify

This process will take several minutes and may take longer on slower internet connections. It will complete automatically, so once it is done, your files are back to their original state. Be aware that this process isn't always 100% perfect due to the way Steam handles the verification. If you have any doubts, you can always perform a full reinstallation of the game.

If you had already installed Flagrum before restoring your game files, you should also re-index your game files to ensure Flagrum has a correct map of the original game files.

  1. Go to the "Settings" tab and click the "Regenerate File Index" button.

Settings Tab

  1. Click the "Regenerate Index" button.

Regnerate Index

  1. Wait a moment while the process completes. If the process has not completed after a while, switch to another tab on the left-menu as the UI may not have updated correctly.
     

You are now all ready to start using the Mod Manager!


Getting Mods

We upload our mods to curseforge.com as it is a great platform that respects the creative integrity of modders and does not claim ownership over their work like many other platforms. You may download our mods from there. Keep in mind that anyone can upload to this and other public websites, so use any mods at your own risk. There are FFXV mods on other platforms as well, so feel free to browse.

For other mods like outfits and weapons, you can subscribe to those through Steam Workshop.


Installing Mods

Mods come in .fmod and .zip files and can be installed via Flagrum to allow for ease-of-installation, and the ability to turn each mod on/off at will. If your mod comes in a different archive format such as rar or 7z, you will need to extract it and repack it as a zip and use the legacy. If your mod is not an archive format, please refer to the original author's instructions for installation, but be aware that Flagrum will not recognize the mod and may conflict with it.

Installing

Flagrum will also do its best to install legacy mods that were created manually by the author. While we've done our best to support as many legacy mods as possible, unfortunately not every mod will be able to be handled automatically. Flagrum will inform you if it is unable to convert your legacy mod, in which case you will need to refer to the original author's instructions if you still wish to use it.

Steam Workshop mods do not need to be installed in this way. Simply subscribe to the mod and Steam will handle the installation for you.


Turning Mods On/Off

Flagrum's Mod Manager allows you to turn your mods on and off any time you like so you can fully customise your experience without worrying about creating backups or remembering where you installed certain files.

To enable or disable a mod, right-click on the mod card and press the respective button at the top of the menu that appears. You can use the buttons along the top of the screen to switch between displaying Active or Disabled mods.

Enabling/Disabling


Uninstalling Mods

If you no longer have a need to keep the mod on your system, simply right-click on the mod card and hit the Delete button at the bottom of the menu that appears. The mod will be unapplied from the game and then removed from Flagrum.

Delete


Installing Incompatible Legacy Mods

Some mods that were not created with Flagrum may give an incompatibility error when attempting to install. This is because it's not possible for Flagrum to consider every possible thing that a modder may have put inside a zip file. If there is an incompatible mod that you really want to install, please defer to the author's original instructions. However, keep in mind that this may cause unpredictable behavior if the mod was built in an unexpected way. If you choose to do this and your game ends up broken later, simply refer to the Fixing a Broken Game section for guidance on how to fix it.


Fixing a Broken Game

If your game was working correctly prior to installing Flagrum, and you first installed Flagrum 1.5 or higher, all you need to do is go to the Settings tab and press the Force Reset/Cleanup button. You should also try this first even if you migrated from a lower version of Flagrum as it's quick and easy and will likely solve your problems. Flagrum will automatically disable all mods and clean up any potentially corrupted files, then you can begin enabling your mods again.

image

If something is still wrong, it's likely that your game files are corrupted. This is usually due to altering your game files manually, rare Steam bugs, or rare circumstances in versions of Flagrum prior to 1.5.

All you need to do is follow all the steps under the Important Preparation section to restore the game and Flagrum to the original state. You can then re-enable your mods and pick back up where you left off.

⚠️ **GitHub.com Fallback** ⚠️