Creating preview information for Fluffy Manager mods
Added 2022-01-24 20:31:14 +0000 UTCHere's detailed information on how mod preview works in Fluffy Manager
In the root folder for a mod, you'll want to make a text file called modinfo.ini. Its contents can look something like this:
name=Crazy Mod
version=v1.0
description=This crazy mod does some crazy stuff.\n\nBelieve me, you've seen nothing yet.
author=Crazy Modder Person
category=Animations
category=Enemies
homepage=patreon.com
screenshot=preview.jpg
Here are details on how every token is handled:
- "Name" - This will be used as the name for the mod in the mod list (if this entry doesn't exist, the mod manager will use the archive filename or folder name as mod name)
- "Author" - When a mod is selected, mod author name will be shown in the corner of the mod preview window on the left part of the screen.
- "Version" - Works the same way as the "author" entry, occupying a different corner.
- "Description" - The majority of the mod preview window for a selected mod is dedicated to this entry which should contain a description of what the mod does. Linebreaks are added automatically when the text is shown on screen, but you can forcibly add them by writing instances of "\n".
- "Screenshot" - Filename for a screenshot to use a visual preview when the mod is selected. Supported formats include jpg, png, tga, and bmp. To ensure mod size doesn't become unnecessarily large, I recommend a jpg with a resolution close to 720p. The image needs to be stored in the same folder as modinfo.ini. If this entry doesn't exist, the mod manager will try to load a file called "screenshot.jpg" and "screenshot.png".
- "Category" - This makes it possible to browse mods differently in the mod manager by clicking on the "Filter mods" option and selecting a tag to filter mods by. A mod can have multiple tag entries. You can also use this category entry to override the automatic category assignment in the mod manager, more info here: https://www.patreon.com/posts/77627854
- "Homepage" - If this entry exists, there will be a homepage icon in the corner in the mod preview window. If the button is pressed, the mod manager will (with a prompt) request the default browser in Windows to load the webpage link written in this entry.
- "AddonFor" - The text for this entry should be the name of another mod (that is, it should be identical to the "Name" entry for another mod). Its "master" mod and the addon will then be bundled into one menu option in the mod list that leads to a list of the master mod (at that top of the submenu) and its addons. An addon can also be a "master mod" making it possible to have submenus lead into submenus.
- "NameAsBundle" - If multiple mods have identical "NameAsBundle" entries, they will be bundled into one menu option in the mod list leading to a submenu that includes every mod with the same "NameAsBundle" entry. This behaviour is similar to how the "AddonFor" entry works.