Item Tips

Shows helpful UI tips about items when you are in proximity to them. This included coolness, curse, synergies, and a short description. Adds extended description to the ammonomicon entry for the item.

Additional features:

• load tips from external files
• cooldown counter for active items

External tip files

External tip files are json formatted files. The ItemTips will search all mod folders for files matching the pattern "itemtips-*.tip".

The format of the files:

{
    // note metadata is optional.
    "metadata": {
        "name": "My Item Tips",
        "url": "url to find updates",
        "version": "1.0.0"
    },
    "items": {
        // Key is the console name used in the mtg api console.
        "prefix:item_name": {
            "name": "Item Name", // item name is optional.
            "notes": "A description of the item."
        }
    },
    "synergies": {
        // Key is the AdvancedSynergyEntry.NameKey of the synergy.
        "Synergy Name": {
            "notes": "A description of the synergy."
        }
    }
}

The console command itemtips generate will generate a sample file for all loaded items and synergies. To show only items for a specific prefix use itemtips generate my_prefix.

To load external files, either include tip files in a mod or set the "External Data Path" configuration value for the ItemTips mod to a directory to load from.

Special Thanks

• Dallan for making the icon.

Changelog

• 2.0.0 - Initial BepInEx port.
• 2.0.1 - Fix missing internal data.
• 2.1.0 - Support external tip files.

version 2.2.0

• In-game configuration section from Gunfig.
• Configuration items for label positioning.

version 2.1.0

• Support external tip files.

version 2.0.1

• Fix missing internal data.

version 2.0.0

• Initial BepInEx port.

Pre-BepInEx changes:

version 1.3.0

• Cooldown indicator: shows damage/time/rooms needed for active item cooldown to expire.
• Load external tips from zip files in the ext folder.

version 1.2.2

• Work better with cross-mod synergies. Detect added synergies after loading.

version 1.2.1

• Don't show synergies with empty names (caused by certain mods, not the base game).
• Additional description for Ruby Bracelet.

version 1.2.0

• Adds info on source of external items to ammonomicon entry.
• Fixes showing unused/cut synergies.
• Fixes issues with some custom synergies.
• Fixes issue with 'Smart Bombs' synergy not displaying correctly.

version 1.1.2

• Fixed issue with map tip not disappearing after pickup.
• Added indicator in ammonomicon for active synergies on an item/gun.
• Support custom synergies. Added several external description files as addons.

version 1.1.1

• Fix incorrect Gunderfury description.

version 1.1

• Fixed issue with some ammonomicon entries not appearing correctly.
• Fixes to work better with modded items.
• Fixes to work better with non-English language settings.
• Show synergy description when it will be activated in tip.
• Add / override builtin descriptions .
• Add commands: config, reload, generate, help.

version 1.0

• Tips for items and guns in-game.
• Expanded ammonomicon entries.