-
Notifications
You must be signed in to change notification settings - Fork 0
ModInfo.xml Additions
A creator can add three main things:
- Better mod information in
ModInfo.xml. - Optional icon and banner images in a
ModsManagerfolder. - Optional editable settings through
ModsManagerConfig.xml.
A recommended mod layout looks like this:
YourModFolder/
ModInfo.xml
Config/
Your normal mod XML and config files
ModsManager/
icon.png
banner.png
ModsManagerConfig.xml
Mods Manager searches the whole mod folder for files named ModsManagerConfig.xml, including subfolders. The recommended location is still ModsManager/ModsManagerConfig.xml because it keeps all manager-facing files together.
Mods Manager reads normal mod metadata from ModInfo.xml. Add as much of this as you can:
<?xml version="1.0" encoding="utf-8"?>
<xml>
<Name value="FolderName_MyModExample" />
<DisplayName value="My Mod" />
<Description value="A short player-facing description of what your mod does." />
<Author value="YourName" />
<Version value="1.0.0" />
<GameVersion value="3.0" />
<Website value="https://example.com/my-mod-page" />
<SkipWithAntiCheat value="true" />
<ModIcon value="ModsManager/icon.png" />
<ModBanner value="ModsManager/banner.png" />
<UpdateManifest value="https://raw.githubusercontent.com/YourName/YourManifestRepo/main/manifests/zz_Author_MyMod.xml" />
</xml>Name
: The internal mod folder/name identifier. This should match your actual mod identity and update manifest file.
DisplayName
: The clean name players see in Mods Manager.
Description
: A short explanation shown in the Details tab. Keep it readable. One or two sentences is usually best.
Author
: Creator name shown beside the version.
Version
: Your mod version. Mods Manager compares this to the remote update manifest.
GameVersion
: The game version your current release targets. Mods Manager can show a game-version update notice if your remote manifest lists a newer supported game version.
Website
: The button players can click to visit your mod page. This does not need to be a direct download.
SkipWithAntiCheat
: Use true if your mod has a DLL or otherwise requires EAC off. Use false for XML-only mods unless your mod has another reason to require EAC off.
ModIcon
: Optional square icon shown in Details. Recommended path: ModsManager/icon.png.
ModBanner
: Optional wide banner shown in Details. Recommended path: ModsManager/banner.png.
UpdateManifest
: Optional remote XML file used for update notices. This only tells players an update exists. Mods Manager does not download or install updates.
Icon and Banner may also be read if present, but ModIcon and ModBanner are the recommended names.