Skip to content

ethall/BetterUI

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BetterUI

A simple mod that adds various UI improvements.
Each can be disabled and configured in the config file.

Currently implemented:

  • 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
  • ItemsStatsMod integration for command window
  • Buff Timers and Tooltips
  • Show Hidden Items

Support Me

If you like what I'm doing, consider supporting me through GitHub Sponsors so I can keep doing it:

https://github.com/sponsors/xoxfaby

Help & Feedback

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

https://github.com/xoxfaby/BetterUI

Features

ItemCounters

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!

ItemCounters

DPSMeter

Fully clientside DPS Meter that can be integrated into the StatsDisplay. Counts minion damage!

DPSMeter

StatsDisplay

Show all of your character's stats! Completely customizable!

StatsDisplay

Skill Proc Coefficient Information

Skill Tooltip

Command/Scrapper Improvements

See how many items you have when using the scrapper or picking an item using the command artifact! Tooltips with ItemStatsMod integration! Close the command/scrapper window with Escape, WASD or a custom keybind!

Command Counters

Improved Item Sorting

Sort items alphabetically, by tier, stacks or even tags like "Scrap" or "Damage". EVEN RANDOMLY?!

Item Sorting

Sorted Scrapper

BuffTimers & Tooltips

Buff timers currently only work if you are the host because the timers are not networked in multiplayer.

Buff Timers

Advanced item descriptions

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.

Item Description

Show Hidden Items

Show hidden items like the hidden monsoon/drizzle items

Configuration

StatsDisplay

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

Sorting

You can enable/disable any part of the mod in the config file.
The sorting is completely customizable as well. 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.

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

Changelog

v2.0.0

  • 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.

v1.6.17

  • Update simply to update the tags on the Thunderstore listing

v1.6.16

  • Bugfix: Fixed bug when setting up config files for ItemCounters if a modded item had an invalid character in its name token.

v1.6.15

  • 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 )

v1.6.14

  • Actual upload of version 1.6.13

v1.6.13

  • Bugfix: Fixed error that equipment cooldown tooltip

v1.6.12

  • Bugfix: Fixed error that broke dpsmeter and statsdisplay

v1.6.11

  • Bugfix: Fixed issues with AdvnacedIcons portion of BetterUI

v1.6.10

  • Bugfix: Fixed bug that would mess up skill tooltips.

v1.6.9

  • Bugfix: Removed debug code that would massively slow down the game when opening scoreboard. oops.

v1.6.8

  • Bugfix: Fixed issue that prevented luck from being updated.
  • Internal Change: More stringbuilder stuff

v1.6.7

  • 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.

v1.6.6

  • Bugfix: Fixed scrapper/command breaking.
  • Bugfix: Fixed more BuffIcon related console spam.

v1.6.5

  • Bugfix: Fixed BuffIcon related console spam.

v1.6.4

  • Internal Change: Many internal changes to improve performance and memory usage.

v1.6.3

  • 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

v1.6.2

  • Internal Change: ItemCounters custom item score now uses the name token to increase compatibility with modded items.

v1.6.1

  • 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.

v1.6.0

  • 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.

v1.5.7

  • 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.

v1.5.6

  • 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

v1.5.5

  • Oops: Removed debug console spam from FINALLY FIXING THIS BUG YAY anyways sorry

v1.5.4

  • Bugfix: ACTUAL fix that fixes issues with scrapper/command sorting in multiplayer

v1.5.3

  • Bugfix: Made a change that could potentially fix issues with scrapper/command sorting in multiplayer

v1.5.2

  • Internal Change: Changed the way skills are registered to allow makers of custom skills to more easily register their skills.

v1.5.1

  • Bugfix: Fixed a few incorrect proc coefficient values.

v1.5.0

  • 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.

v1.4.4

  • Fixed command bug when picking equipment due to leftover code and hook typo

v1.4.3

  • undid the debug code i pushed on accident that locked all items in command.

v1.4.2

  • 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

v1.4.1

  • Fixed bug that would break StatsDisplay in levels without a teleporter and spam the console with errors.

v1.4.0

  • 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

v1.3.2

  • 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.

v1.3.1

  • Fixed CommandCountersHideOnZero not showing tooltips without counters

v1.3.0

  • 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.

v1.2.3

  • Fixed a potential scrapper multiplayer bug

v1.2.2

  • 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 )

v1.2.1

  • Fixed bug with command and scrapper menu

v1.2.0

  • Added command menu item counters and tooltips

v1.1.6

  • Added AdvancedTooltips for equipement

v1.1.5

  • Added ItemIndex (ID) Sorting

v1.1.4

  • Added special command menu sorting which keeps most recently picked item in the middle

v1.1.3

  • Fixed Equipments with sorted command window.

v1.1.2

  • Added Sorting to Scrapper and Command Menu

v1.1.1

  • Fixed $killcount not working

v1.1.0

  • Added StatsDisplay

v1.0.1

  • Fixed up the README
  • Internal Changes

v1.0.0

  • Inital Release

About

Risk of Rain 2 mod BetterUI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 100.0%