IsseW-Item_Stat_Display icon

Item Stat Display

This mod adds extra info when hovering over items and powerups telling you exactly what they do.

Last updated 3 years ago
Total downloads 98334
Total rating 6 
Categories Quality of Life
Dependency string IsseW-Item_Stat_Display-1.1.0
Dependants 13 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack_Muck-5.4.1101 icon
BepInEx-BepInExPack_Muck

BepInEx pack for Muck. Preconfigured and ready to use.

Preferred version: 5.4.1101

README

Item_Stat_Display for Muck

This mods adds additional data when hovering over a powerup or item.

This mod is designed to not conflict with other mods, but another mod can make this mod not work.

This is a client only mod, meaning this mod works even if the host doesn't play with modded.

Installation (manual)

If you are installing this manually, do the following

  1. Extract the archive into a folder. Do not extract into the game folder.
  2. Move the contents of plugins folder into <GameDirectory>\Bepinex\plugins.
  3. Run the game.

For developers

If you want to add descriptions to a powerup with this mod you can do so without having a dependency to this mod.

Just simply use the SendMessage function in your mods main class "Start" function. It's important that it's "Start" and not "Awake".

The signature of the function is RegisterPowerUp(Tuple<string, Func<int, bool, string>>) where the string is the name of the powerup and the function is the extra description. That function takes in an int (count of that powerup) and a bool (if you should show extra info) and returns a string explaining what stats it gives etc.

So for example you can do

SendMessage(new Tuple<string, Func<int, bool, string>>("Speeeeed Item", (count, extraInfo) => extraInfo ? string.Format("({0} ^ 2)% movement speed", count) : string.Format("{0}% movement speed", count * count)));

Keep in mind though, this mod only adds text it does nothing else. Gamelogic you have to add yourself.