A simple mod that adds various UI improvements.
Each can be disabled and configured in the config file.
If you like what I'm doing, consider supporting me through GitHub Sponsors so I can keep doing it:
https://github.com/sponsors/xoxfaby (preferred) https://patreon.com/xoxfaby or directly through paypal: https://streamelements.com/xoxfaby/tip
- ItemStats
- Item Counters
- DPS Meter
- StatsDisplay
- Ordered Inventory, Scrapper Menu, Command Menu
- Command/Scrapper Menu Item Counters and Tooltips
- Close the command menu with escape, WASD or a custom keybind
- Automatically resize the command window if there are more items
- Remove background blur from command window
- Advanced Item Descriptions
- Advanced Equipment Descriptions
- Hide Pickup Notifications
- Skill Proc Coefficients with calculated effects based on the items you are carrying
- Buff Timers and Tooltips
- Show Hidden Items
If you need help or have suggestions, create an issue on github, join my discord or find me on the RoR2 Modding Discord
My Discord XoXFaby#1337
Please do not add me on discord, join of the the two servers and ping me there.
https://github.com/xoxfaby/BetterUI
Show calculcated stat bonuses for your items.
Customizable ItemCounters. Choose which tiers you want counted, choose which tiers to show.
Use ItemScore to not just see how many items you have but how good they are.
By default item score is based on tiers, but you can change how much each tier is worth or even set custom values for each item!
Fully clientside DPS Meter that can be integrated into the StatsDisplay. Counts minion damage!
Show all of your character's stats! Completely customizable!
See how many items you have when using the scrapper or picking an item using the command artifact! Tooltips with ItemStats! Close the command/scrapper window with Escape, WASD or a custom keybind!
Sort items alphabetically, by tier, stacks or even tags like "Scrap" or "Damage". EVEN RANDOMLY?!
Buff timers currently only work if you are the host because the timers are not networked in multiplayer.
Use the advanced item descriptions from the logbook that show the actual numbers for all the changes. Integration with ItemStats in the command and scrapper windows.
Show Hidden Items
Show hidden items like the hidden monsoon/drizzle items
The StatsDisplay parses the StatString in the config file and replaces all the parameters it finds.
The StatsDisplay can also be moved, resized and recolored and formatted ( See: http://digitalnativestudios.com/textmeshpro/docs/rich-text/ )
If you want another parameter added, feel free to suggest it to me (See Help & Feedback)
Here is a list of all valid parameters right now
$exp $level $luck
$dmg $crit $luckcrit $atkspd
$hp $maxhp $shield $maxshield $barrier $maxbarrier
$armor $armordmgreduction $regen
$movespeed $jumps $maxjumps
$killcount $multikill $highestmultikill
$dps $dpscharacter $dpsminions
$mountainshrines
$blueportal $goldportal $celestialportal
The sorting is completely customizable. The default sorting value is S134
S means the items are first sorted by the "Scrap" tag and all the scrap is put at the end of the list.
1 then sorts it by tier, in descending order, putting higher tier items at the front.
3 sorts it by the stack size in descending order, meaning if you have more of an item, it will come first.
4 then sorts it by pickup order, meaning items you got first, come first.
You can customize this in any way you like.
Filters:
# + a tag will apply the next sorting to only items that match the tag.
You can use any tags from the tag based sorting.
Examples:
#s0 to sort scrap by tier ascending.
#t14#t28 to sort Tier 1 items by pickup order and tier 2 items randomly
The full options:
0 = Tier Ascending
1 = Tier Descending
2 = Stack Size Ascending
3 = Stack Size Descending
4 = Pickup Order
5 = Pickup Order Reversed
6 = Alphabetical
7 = Alphabetical Reversed
8 = Random
i = ItemIndex
I = ItemIndex Descending
Tag Based:
s = Scrap First
S = Scrap Last
d = Damage First
D = Damage Last
h = Healing First
H = Healing Last
u = Utility First
U = Utility Last
o = On Kill Effect First
O = On Kill Effect Last
e = Equipment Related First
E = Equipment Related Last
p = Sprint Related First
P = Sprint Related Last
t1 = Tier 1 First t2 = Tier 2 First t3 = Tier 3 First tL = Lunar Tier First tB = Boss Tier First tN = NoTier First
T1 = Tier 1 Last T2 = Tier 2 Last T3 = Tier 3 Last TL = Lunar Tier Last TB = Boss Tier Last TN = NoTier Last
- Small Addition: DPSMeter: Added option to hide the DPSMeter when the chatbox is open (enabled by default)
- Small Change: ItemStats: Rounded non-chance percentages to 2 digits as well
- Bugfix: DPSMeter: Fixed DPSMeter window being active but nonfunctional if the whole module is disabled
- Bugfix: ItemStats: Fixed scaling on EquipemntCooldown Items
- Bugfix: ItemCounters: Fixed void items not counting towards item sums for each tiers and the total. In the future, there will be options for each void tier seperately, but for now they are counted together with the non-void counterparts.
- Bugfix: ItemStats: Fixed typo & scaling on Alien Head
- Bugfix: ItemStats: Reused the old ItemStatsIntegration setting to toggle ItemStats for now.
- Bugfix: ItemStats: Fixed seer's rounding error
- API: Added public ItemScore getter method.
- Bugfix: ItemStats: Added luck modifer to some items that were missing it
- Bugfix: ItemStats: Corrected 2 incorrect ItemStats
- Small Change: ItemStats: Changed default formatting to round numbers to 2 decimal places
- Small Addition: ProcCoefiicients: Added proc effects from void items
- Bugfix: ItemStats: Fixed issue that froze the game at the end screen
- Addition: ItemStats:
- This adds calculated stat bonuses to the descriptions of items.
This is a huge update, if you spot any errors or you feel anything is missing, please submit an issue on the Github: https://github.com/xoxfaby/BetterUI/issues
- This adds calculated stat bonuses to the descriptions of items.
- Small Addition: Added ability for Proc Coefficient skill names to use language tokens.
- Note: In the changelog for the latest versions, $critdamage was incorrectly listed as $critdmg, this has been retroactively fixed.
- Small Addition: Added different descriptions for survivor that has skills that work differently sometimes.
- Small Addition: Void Portal has been added to the StatsDisplay ($voidportal)
- Small Addition: Proc Coefficients for new survivors have been added.
- Bugfix: StatsDisplay: Added null-check to jumps to fully fix StatsDisplay for
CharacterBodys without a CharacterMotor - Bugfix: ItemScores: ItemScores work again. Void tiers are counted as their normal counterparts (for now.)
- Bugfix: DPSMeter: DPSMeter window now correctly hides when the rest of the HUD is hidden.
- Bugfix: Actually fix $critdamage
- Bugfixes:
- Fixed $critdamage matching with $crit and showing the crit chance + the letters "damage" instead of showing the critical damage
- Fixed the StatsDisplay breaking if the current CharacterBody doesn't have a CharacterMotor
- Change:
- Valid Parameter description for StatsDisplay is now automatically generated from all of the valid options.
- Bugfix: Moved HUD object aquisition back to Awake to fix bug where multiple StatsDisplays were being created when someone died and respawned.
- Addition: Added crit damage to StatsDisplay
- Bugfix: Sort Void items the same as their normal items to quickly fix the game breaking when picking up a void item. Proper system to come later
- Bugfix: Get HUD and ObjectivePanelController from HudObjectiveTargetSetter because HUD.objectivePanelController was removed
- README update only
- Addition: Item Sorting: New sortString options:
- Tier Tag: use t (lowercase) + the tier to sort items of that tier first.
Use T (uppercase) to sort them last:
t1 = Tier 1
t2 = Tier 2
t3 = Tier 3
tL = Lunar Tier
tB = Boss Tier
tN = NoTier
Examples:
tL4to put Lunar items first, and the rest of the items by pickup order.
Tn6to put NoTier items last, and the rest of the items alphabetically. - Filters: # + a tag will apply the next sorting to only items that match the tag.
You can use any tags from the tag based sorting.
Examples:
#s0to sort scrap by tier ascending.
#t14#t28to sort Tier 1 items by pickup order and tier 2 items randomly
- Tier Tag: use t (lowercase) + the tier to sort items of that tier first.
- Change: CommandImprovements: Command window will now resize both horizontally and vertically right away.
- Bugfix: (Temporary) Disabled BetterUI command window sorting for command windows that contain both items and equipment. In the future, BetterUI will be able to sort these windows and provide configuration options for their sorting.
- Bugfix: Configuration: Fixed certain config options always resetting to their default value due to a bug in the logic for porting over renamed config options.
- Addition: CommandImprovements: Command window will now resize if it was going to overflow the screen
- Bugfix: Fixed error when user attemps to change language
- Addition: Added API for StatsDisplay to let other mods add their own parameters
- Bugfix: Fixed item score config options not loading item names
- Localization: Fixed some vanilla buff tooltips
- Localization: Fixed some config option verbiage ( Thank you ethall )
- Internal: Added ability to change config parameters while keeping user set values ( Thank you ethall )
- Addition: Buffs: Buff tooltips now have better names and descriptions. Comes with a public API for other mods to register the names and descriptions of their buffs. Uses the Language system if you want to provide translated names/descriptions. Buffs registered with BetterAPI have their names imported if registered there.
- Bugfix: AdvancedIcons: Fixed issue where skill tooltips didn't update if the skill was overridden.'
- Bugfix: ItemScores: Fixed issue if mods added items with duplicate nametokens, uses ItemDef.name instead.
- Bugfix: Fixed ItemScores:
- Bugfix: StatsDisplay: Fixed $exp.
- Addition: StatsDisplay: Added $maxexp which shows the exp needed to level up
- Addition: StatsDisplay: Added $velocity and $2dvelocity to show how fast you are moving, $2dvelocity ignores the y axis.
- Internal: Removed MMHook Dependency
- Internal: Implemented ManivestV2 alongside normal manifest to hopefully allow local installation into mod managers.
- Bugfix: Fixed command/scrapper not working after new update.
- Bugfix: AdvanvedIcons: No longer breaks when bad items are added.
- ModCompat: AdvancedIcons: Now accepts ItemDefs as well.
- Depend on MMHOOK Standalone instead of shipping own MMHOOK.
- Bugfix: Stopped R2API from adding BetterUI to the networkModList
- No longer requires R2API
- Anniversary Update: Added Proc coefficient values for new Character, Items & Item changes.
- New Config Option: Added option to toggle StatsDisplay instead of holding to show.
- Bugfix: Fixed HighestMultiKill in Statsdispaly only updating when the statsdisplay is open.
- Bugfix: Fixed BuffIcon issues cause by new update.
- Bugfix: Fixed tooltips showing seconds for cooldowns that are only 1 second
- Bugfix: Fixed tooltips in lobby showing incorrect cooldowns
- Internal: Removed deprecated ProcItemCatalog methods, if you were somehow still using these to add your custom proc effects please contact me for help to use the new ones.
- Update simply to update the tags on the Thunderstore listing
- Bugfix: Fixed bug when setting up config files for ItemCounters if a modded item had an invalid character in its name token.
- Bugfix: Fixed bug in AdvancedIcons that could cause various issues when playing with an unmodded host.
- Bugfix: Fixed small logic issue in CommandImprovements ( Thank you ethall )
- Bugfix: Fixed bug in CommandImprovements if a specific set of config options was selected ( Thank you ethall )
- Config change: Updated configuration tooltips for grammar, consistency, and clarity. ( Thank you ethall )
- Actual upload of version 1.6.13
- Bugfix: Fixed error that equipment cooldown tooltip
- Bugfix: Fixed error that broke dpsmeter and statsdisplay
- Bugfix: Fixed issues with AdvnacedIcons portion of BetterUI
- Bugfix: Fixed bug that would mess up skill tooltips.
- Bugfix: Removed debug code that would massively slow down the game when opening scoreboard. oops.
- Bugfix: Fixed issue that prevented luck from being updated.
- Internal Change: More stringbuilder stuff
- Addition: Added config file to entirely disable modcomponents ( these are the big internal parts the mod is split into )
- Internal Change: Stopped using the ror2 built in sharedStringBuilder because some mods seem to be misuing it and bug out.
- Bugfix: Fixed scrapper/command breaking.
- Bugfix: Fixed more BuffIcon related console spam.
- Bugfix: Fixed BuffIcon related console spam.
- Internal Change: Many internal changes to improve performance and memory usage.
- New Feature: Added ability to show item description on the pickup interaction text
- Bugfix: Readded all functionality from the Misc config
- Bugfix: change nameLabel line space, overflow mode and word wrapping to work for more names
- Internal Change: ItemCounters custom item score now uses the name token to increase compatibility with modded items.
- Bugfix: Corrected Huntress Arrow Rain Proc Coefficient
- Bugfix: Scrapper Tooltips w/ ItemStatsMod no longer shows you have one extra item.
- Internal Change: Lots of things moved around, but none of this should affect anything.
- New Feature: Item Counters: Fully customizable. Simple counting of items, groups by tier or item score by tier or even individual items
- New Feature: Skill cooldowns: Base cooldown & calculated cooldown in the tooltip. Base cooldown in the loadout screen.
- Addition: Added $difficulty parameter to display the Difficulty Coefficient in the StatsDisplay
- Addition: Added the ability to change the custom bind for showing/changing the StatsDisplay, by default it replaces the old Scoreboard bind.
- Addition: Added the Proc Coefficient information to the loadout screen.
- Change: Replaced $crit with $luckcrit in the StatString, added both and $difficulty to StatStringCustomBind
- Bugfix: Fixed $luckcrit not working.
- Notes: The custom bind changes will reset your StatStringScoreboard because it was moved to a different config variable. It felt wrong to keep the same name when it is no longer tied to the scoreboard directly.
- Bugfix: Added formatting for more numbers in StatsDisplay
- Internal Change: more changes to allow modders to more easily register their items for display in skill tooltips
- Oops: Removed debug console spam from FINALLY FIXING THIS BUG YAY anyways sorry
- Bugfix: ACTUAL fix that fixes issues with scrapper/command sorting in multiplayer
- Bugfix: Made a change that could potentially fix issues with scrapper/command sorting in multiplayer
- Internal Change: Changed the way skills are registered to allow makers of custom skills to more easily register their skills.
- Bugfix: Fixed a few incorrect proc coefficient values.
- New Feature: Advanced Skill Tooltips: Proc Coefficients have been added to skill tooltips. Calculated effects based on the items you are carrying. Includes public methods so other mod makers can integrate their information into BetterUI.
- New Feature: Equipment cooldown: Show the base cooldown of your equipment and the effective cooldown if it has been reduced by your items
- New Feature: Skills and equipment show the cooldown remaining even if you can have multiple stacks.
- New Feature: Ability to disable pickup notifications for items/equipemnts/artifacts
- Bugfix Scrapper window no longer shows before/after ItemStatsIntegration text, only the normal one.
- Bugfix $luckcrit now works correctly
- Bugfix Fixed a bug with command windows if sorting was enabled on the scrapper window but not the command window
- Note: Some default options have been changed, such as the default command sorting not changing the item order anymore because it was found to be disruptive. I encourage everyone to look back at features they might've previously disabled because it's possible they have been improved since then.
- Note: If you want something added to the mod feel free to create an issue on GitHub, many features and options for the StatsDisplay were added because they were requested.
- Fixed command bug when picking equipment due to leftover code and hook typo
- undid the debug code i pushed on accident that locked all items in command.
- Added $luckcrit for StatsDisplay to show the crit chance considering luck.
- Changed default command sortorder to "6" ( Alphabetical ). I believe that sorting that changes the order in the command window during a run leads to more confusion than it helps.
- Fixed some small mistakes with config values and hooks
- Moved command sorting optionmap application to OnCreateButton to remove an unnecesary hook and attempt to improve compatibility with mods that call SubmitChoice directly
- Rewrote DPSMeter calculations for performance
- Rewrote StatsDisplay StatsString parser for performance
- Fixed bug that would break StatsDisplay in levels without a teleporter and spam the console with errors.
- Added BuffTimers and Tooltips
- Added seperate StatsDisplay StatString for when the scoreboard is open.
- Added StatsDisplay parameters: $armordmgreduction $mountainshrines $blueportal $goldportal $celestialportal
- Potential fix for (harmless) DPSMeter console spam
- Added $highestmultikill for StatsDisplay to keep track of your largest multikill of the run
- This was added by request, if you want anything else added to the StatsDisplay, please just let me know.
- Fixed CommandCountersHideOnZero not showing tooltips without counters
- Clientside DPS Meter
- StatsDisplay can now list DPS
- StatsDisplay can now attach to the objective panel to automatically move out of the way
- StatsDisplay can be fully formatted (See: http://digitalnativestudios.com/textmeshpro/docs/rich-text/)
- Added ability remove background blur from the command menu
- ItemStatsMod integration for the command and scrapper window
- Many of these changes were directly requested so feel free to make suggestions to me on discord or on github.
- The config file has moved and split up which means your settings will be reset, but with all the new changes I encourage you to check options you might've disabled before.
- Fixed a potential scrapper multiplayer bug
- Added ability to close command/scrapper menu with Escape, WASD or a custom key
- Added ability to scale the command window to the number of items shown, this should help with mods that add new items.
- removed debug spam ( sorry )
- Fixed bug with command and scrapper menu
- Added command menu item counters and tooltips
- Added AdvancedTooltips for equipement
- Added ItemIndex (ID) Sorting
- Added special command menu sorting which keeps most recently picked item in the middle
- Fixed Equipments with sorted command window.
- Added Sorting to Scrapper and Command Menu
- Fixed $killcount not working
- Added StatsDisplay
- Fixed up the README
- Internal Changes
- Inital Release