ShipLoot Plus (+)

Rewrite and enhancement to the original ShipLoot with a ton customization.

This started as a fork but I ended up rewriting 99% of it to allow for more dynamic customization.

IMPORTANT: With v1.0.1 there has been some changes which will reset any custom line formats and colors. You do not need to regenerate your configs and these settings will still be in your config file, its just that the line names and categories have changed (though now you would have extra data in the files). Please review the Change Log for more information on what has changed as you may want to have new customizations anyway.

Key Features

This mod adds three customizable HUD elements which allow you to display many different data points. This is expanded from the original ShipLoot which only showed the value of scrap in the ship.

• Show more game information easily
• Highly customizable
  • Font and Display Layout
  • Colors (including Rich Text support)
  • Information format
• Conditional display
  • Default (on scan only)
  • Always Shown
  • Allow it to be shown when outside the ship and/or inside the dungeon

This is what the HUD looks like with its default data points.

NOTE: You can see what the different parts mean in the breakdown below

Feature Breakdown

  %ShipLootValue%      = Value of all scrap on the ship
  %MoonLootValue%      = Value of all scrap on the moon (excluding the ship)
  %AllLootValue%       = Value of all scrap (ship and moon)
  %ShipLootCount%      = Count of scrap items in the ship (excluding the moon)
  %MoonLootCount%      = Count of scrap items on the moon (excluding the ship)
  %AllLootCount%       = Count of scrap items (ship and moon)
  %FulfilledValue%     = Value of turned in scrap for quota
  %QuotaValue%         = Value of current quota
  %CompanyRate%        = Current company buy rate
  %ExpectedProfit%     = Expected profit from scap on ship at current company buy rate
  %Deadline%           = Days until quota is due
  %DayNumber%          = Integer of days in the ship/save (E.g. 1, 3 ,10)
  %DayNumberHuman%     = Human friendly days in the ship/save (E.g. 1st, 3rd, 10th)
  %Weather%            = Current moons weather full name
  %MoonLongName%       = Current moons full name

Ship: $%ShipLootValue%(%ShipLootCount%) / $%MoonLootValue%(%MoonLootCount%) <i>[%MoonName%:%Weather%]</i>
Quota: $%FulfilledValue% / $%QuotaValue% - Profit: $%ExpectedProfit%(%CompanyRate%%)
Deadline: %Deadline% - %DayNumberHuman% day

Ship: $209(2) / $0(0) [Offense:Clear]
Quota: $0 / $229 - Profit: $63(30%)
Deadline: 3 - 5th day

  [DataPoint: Deadline]

  ## Enables color for the deadline number
  # Setting type: Boolean
  # Default value: false
  Use Colors = false

  ## Replace the number 0 with the custom text below, otherwise leave it as a number
  # Setting type: Boolean
  # Default value: true
  Replace Zero = true

  ## Text to replace the number Zero if 'Replace Zero' is enabled
  # Setting type: String
  # Default value: <b>NOW!</b>
  Zero Replacement = <b>NOW!</b>

  ## Color for when the deadline has two or more days remaining
  # Setting type: String
  # Default value: 00FF00
  Color: 2+ days = 00FF00

  ## Color for when the deadline has one day remaining
  # Setting type: String
  # Default value: FFA500
  Color: 1 day = FFA500

  ## Color for when the deadline is due
  # Setting type: String
  # Default value: FF0000
  Color: Zero days = FF0000

  [DataPoint: Weather]

  ## Text to use instead of 'None' for when the weather is clear (set to blank if you want it to show None)
  # Setting type: String
  # Default value: Clear
  Clear Weather Text = Clear

  ## Enables color for each weather type
  # Setting type: Boolean
  # Default value: false
  Use Colors = false

  ## Color for Clear/None weather
  # Setting type: String
  # Default value: 69FF6B
  Color: Clear/None = 69FF6B

  ## Color for DustClouds weather
  # Setting type: String
  # Default value: B56C4C
  Color: DustClouds = B56C4C

  ## Color for Rainy weather
  # Setting type: String
  # Default value: FFFF00
  Color: Rainy = FFFF00

  ## Color for Stormy weather
  # Setting type: String
  # Default value: FF7700
  Color: Stormy = FF7700

  ## Color for Foggy weather
  # Setting type: String
  # Default value: 666666
  Color: Foggy = 666666

  ## Color for Flooded weather
  # Setting type: String
  # Default value: FF0000
  Color: Flooded = FF0000

  ## Color for Eclipsed weather
  # Setting type: String
  # Default value: BA0B0B
  Color: Eclipsed = BA0B0B

  ## Color for Hell weather (from the mod 'HellWeather')
  # Setting type: String
  # Default value: AA0000
  Color: Hell = AA0000

  [DataPoint: MoonName]

  ## Show the full moon name (do not remove any leading numbers)
  # Setting type: Boolean
  # Default value: false
  Show Full Name = false

  ## Replace the name used for the company moon
  # Setting type: Boolean
  # Default value: true
  Replace Company Name = true

  ## Text to replace 'Gordion' if 'Replace Company Name' is enabled
  # Setting type: String
  # Default value: Company Building
  Company Name Replacement = Company Building

  [Line #1]
  ## Line #1 text format.
  ## [Lists each DataPoint but omitted here for space reasons]
  # Setting type: String
  # Default value: Ship: $%ShipLootValue%(%ShipLootCount%) / $%MoonLootValue%(%MoonLootCount%) <i>[%MoonName%:%Weather%]</i>
  Format = Ship: $%ShipLootValue%(%ShipLootCount%) / $%MoonLootValue%(%MoonLootCount%) <i>[%MoonName%:%Weather%]</i>

  [Line #2]
  ## Line #2 text format.
  ## [Lists each DataPoint but omitted here for space reasons]
  # Setting type: String
  # Default value: Quota: $%FulfilledValue% / $%QuotaValue% - Profit: $%ExpectedProfit%(%CompanyRate%%)
  Format = Quota: $%FulfilledValue% / $%QuotaValue% - Profit: $%ExpectedProfit%(%CompanyRate%%)

  [Line #3]
  ## Line #3 text format.
  ## [Lists each DataPoint but omitted here for space reasons]
  # Setting type: String
  # Default value: Deadline: %Deadline% - %DayNumberHuman% day
  Format = Deadline: %Deadline% - %DayNumberHuman% day

  ## Should the hud elements be decoupled from the scanner? (Meaning it will always be shown on screen)
  # Setting type: Boolean
  # Default value: false
  Always Show = false

  ## Should the scanner hud be shown when scanning outside the ship?
  # Setting type: Boolean
  # Default value: false
  Allow Outside = false

  ## Should the scanner hud be shown when scanning inside the dungeon?
  # Setting type: Boolean
  # Default value: false
  Allow Inside Dungeon = false

  ## How long in seconds should the items stay on screen. (This is ignored if Always Show is true)
  # Setting type: Single
  # Default value: 5
  Display Duration = 5

  ## Should the duration timer get reset if you scan?
  # Setting type: Boolean
  # Default value: false
  Reset Duration Timer On Scan = true

  ## Should a data refresh be forced when scanning?
  ## 
  ## All data is kept updated when events are triggered (player grabs an item, items get moved into the ship, etc.) so this isn't required.
  ## 
  ## <b>IMPORTANT</B>: This could cause issues with any mod that makes the scanner always on
  # Setting type: Boolean
  # Default value: false
  Refresh Data On Scan = false

  ## Shows the line element
  # Setting type: Boolean
  # Default value: true
  Show Line = true

  ## Line color (hex code)
  # Setting type: String
  # Default value: 2D5122
  Line Color = 2D5122

  ## Shows Line #1 on the hud.
  # Setting type: Boolean
  # Default value: true
  Show = true

  ## Line #1 text color. (hex code)
  # Setting type: String
  # Default value: 19D56C
  Color = 19D56C

  ## Shows Line #2 on the hud.
  # Setting type: Boolean
  # Default value: true
  Show = true

  ## Line #2 text color. (hex code)
  # Setting type: String
  # Default value: 19D56C
  Color = 19D56C

  ## Shows Line #3 on the hud.
  # Setting type: Boolean
  # Default value: true
  Show = true

  ## Line #3 text color. (hex code)
  # Setting type: String
  # Default value: 19D56C
  Color = 19D56C

  ## Font to use for the UI elements
  # Setting type: FontList
  # Default value: Vanilla
  # Acceptable values: Vanilla, Fixed, FixedSemiCondensed, FixedCondensed
  Font = Fixed

  ## Should text be in all caps?
  # Setting type: Boolean
  # Default value: false
  All Caps = false

  ## Adjust the font size
  # Setting type: Single
  # Default value: 19
  Size = 19

  ## Adjust the spacing between characters
  # Setting type: Single
  # Default value: -6
  Character Spacing = -6

  ## Adjust the spacing between words
  # Setting type: Single
  # Default value: -20
  Word Spacing = -20

  ## Change the default text alignment for all elements
  ## 
  ## <b>**IMPORTANT**</b> The elements are built to stay Top Left aligned, changing this may produce unwanted outcomes
  # Setting type: TextAlignmentOptions
  # Default value: TopLeft
  # Acceptable values: TopLeft, Top, TopRight, TopJustified, TopFlush, TopGeoAligned, Left, Center, Right, Justified, Flush, CenterGeoAligned, BottomLeft, Bottom, BottomRight, BottomJustified, BottomFlush, BottomGeoAligned, BaselineLeft, Baseline, BaselineRight, BaselineJustified, BaselineFlush, BaselineGeoAligned, MidlineLeft, Midline, MidlineRight, MidlineJustified, MidlineFlush, MidlineGeoAligned, CaplineLeft, Capline, CaplineRight, CaplineJustified, CaplineFlush, CaplineGeoAligned, Converted
  Text Alignment = TopLeft

  ## Make the text elements more or less transparent
  # Setting type: Single
  # Default value: 0.95
  Transparency = 0.95

  ## The X position of the UI element group
  # Setting type: Single
  # Default value: 115
  Position: X (Left/Right) = 115

  ## The Y position of the UI element group
  # Setting type: Single
  # Default value: -169
  Position: Y (Up/Down) = -169

  ## The X scale of the UI element group
  # Setting type: Single
  # Default value: 0.6
  Scale: X (Left/Right) = 0.6

  ## The Y scale of the UI element group
  # Setting type: Single
  # Default value: 0.6
  Scale: Y (Up/Down) = 0.6

  ## This changes how much the UI element group is rotated on the screen
  # Setting type: Single
  # Default value: 356
  Rotation: Z (Tilt) = 356

  ## This value allows you to offset the text field width if you want to show more or less characters on screen
  # Setting type: Single
  # Default value: 0
  Text Field Width Offset = 0

  ## Enables debug logging **IMPORTANT** This will DEFINITELY cause lag and stutters as it writes a lot of debug lines, only use this if asked to help troubleshoot a problem!
  # Setting type: Boolean
  # Default value: false
  Debug Mode = false

  ## Disable all data point refresh RPC hooks. This will impact how often the data points are updated. You can always enable 'Refresh Data On Scan' below to make it refresh faster.
  # Setting type: Boolean
  # Default value: false
  Disable RPC Hooks = false

Planned and Potential Future Features

Dependencies

NOTE: With v1.0.1+ LethalConfig is a soft dependency but to get the best experience it is still required by the Thunderstore package. It allows you to change any setting for ShipLootPlus at any time, even landed on a moon, and it will update everything in real time. If do not want LethalConfig in your pack, you can safely remove it and this mod will still work just fine.

• LethalConfig: Used to configure the mod while in-game with a friendly user interface
  • Soft Dependency => I have made it a soft dependency so it can be removed if desired with out breaking ShipLootPlus

Compatibility

The following are mods either tested to be compatible or not

Incompatible

• ShipLoot: Since this is basically a full rewrite of ShipLoot, it is not compatible with it. This mod will disable the original ShipLoot if it is found.
• Likely other mods that add similar HUD elements (at least until I add the custom position and scaling features)

Compatible (Tested by me or the community)

• EnhancedSpectator
• GeneralImprovements
• LCBetterClock
• EladsHUD
• Likely most mods (ill do a more comprehensive test with the most popular mods later)

Font Asset Bundle Information

The font asset bundle I created for this mod can be used by any other mod developer if they want to. I've complied with the license by embedding it into the asset bundle as well as delivering it with the bundle itself.

Since I do not own the fonts and as per their license the fonts can be distributed with their license, I am making the asset bundle available to anyone who wants to use the updated versions of the three 3270Fonts in their mod.

The fonts included are:

• 3270 Regular
• 3270 SemiCondensed
• 3270 Condensed

Download the font asset bundle here: https://github.com/ProfX66/ShipLootPlus/tree/main/Assets/Fonts

NOTE: Please also include the "3270Fonts-LICENSE.txt" file with your mod to ensure there is zero confusion about license compliance

Other Mods

v1.1.0

• Refactored the data refresh method to handle when the scrap list is null and/or a scrap item is missing required properties (should fix Issue #9)
• Moved all Unity GameObject manipulation (changing/updating) to the main thread during data refresh
• Added a slight delay when new scrap is brought onto the ship to avoid a race condition where the moons scrap list became desynced
• Now correctly unloads the font asset bundle after the assets have been loaded
• Some minor code cleanup
• Compiled with the latest version of LethalConfig and updated the dependency version in the mod manifest
• Compiled with the latest version of Lethal Company (v50 public release)

v1.0.9

• Cleaned up some of the code and fixed a couple misspellings
• Added additional null checks in every patch method to ensure nothing is used when objects are unexpectedly null
• Added configuration option to disable all RPC hooks
  • This will impact how often the data points are updated, but it should stop any errors happening when RPC messages are received and objects aren't ready for it.
• Added Debug Mode configuration to enable verbose logging
  • IMPORTANT this will cause performance degradation unless you are using AsyncLoggers!
• Updated readme

v1.0.8

• Changed most of the UI element code to be better aligned and scaled
  • Also modified the character and word spacing to be nicer
  • I also changed which HUD element my UI elements are parented to - It is now higher in the object hierarchy and directly under the "IngamePlayerHUD" object.
• Added layout config options - You can now set the following:
  • Change the X (Left/Right) position and Scaling
  • Change the Y (Up/Down) position and Scaling
  • Change the Z (Tilt) rotation
  • Change the text field width offset (allows it to show more or less text before truncating)
• Added font config options - You can now set the following:
  • Moved All Caps from the General section into this section
  • Change the font - I have added a font bundle for the 3 current versions of the "3270Fonts" font that the game uses (bundle includes embedded license and I added the license to my mod package)
    • Vanilla = Normal game font
    • Fixed = Currently available version of the font (fixes the dollar sign and other special characters)
    • Fixed-Semi-Condensed = Same as Fixed but slightly more condensed
    • Fixed-Condensed = Same as Fixed but more condensed

    Note: If you are a mod developer and want to use this font asset bundle, please read the "Font Asset Bundle Information" section in the readme

  • Change the font size - IMPORTANT: I must stress that changing the font size could cause the layout spacing to have unwanted outcomes
  • Change the character spacing
  • Change the word spacing
  • Change the text element alignments - IMPORTANT: I must stress that changing this will DEFINITELY have unwanted outcomes to the layout
  • Change the text transparency (alpha)
• Changed how short data points are handled
  • You can now make any data point short by adding a ":#" inside the percent signs (e.g. %Weather:4%)
  • Renamed %MoonLongName% to %MoonName%
  • Removed the Short Character Count config setting
  • Removed the %MoonShortName% and the %WeatherShort% data points
• Changed how the Deadline color coding works
  • There is now a whole section for the Deadline data point
  • You can enable/disable the color coding
  • You can enable/disable replacing zero with a custom string (Default: <b>NOW!</b>)
  • Set the color for each threshold (2+ days left, 1 day left, 0 days left)
  • Removed the %DeadlineWithColors% data point
• Added a config section for the MoonName data point
  • You can enable/disable showing the full moon name (e.g. 21 Offense vs Offense)
  • You can enable/disable replacing the company moons name with a custom string (Default: Company Building)
• Added a clear/none weather custom text string configuration - Make it blank to keep it as None (Default: Clear)
• Added color coding with customization for the Weather data point
  • You can enable/disable color coding for the %Weather% data point
    • Support was added for the HellWeather mod so its 'Hell' weather variant can have its own color
  • You can set a custom color for each type of weather
• Added a configuration converter so that old settings get migrated to new settings
  • This includes automatically converting any short data point that was used before to the new format using the old short character count value
  • This should also clean up the config file so there are no orphaned config entries
• Since the layout changes made the scaling better and more concise I have changed the following default Line formats:
  • Line #1: Ship: $%ShipLootValue%(%ShipLootCount%) / $%MoonLootValue%(%MoonLootCount%) <i>[%MoonName%:%Weather%]</i>
  • Line #2: Quota: $%FulfilledValue% / $%QuotaValue% - Profit: $%ExpectedProfit%(%CompanyRate%%)

v1.0.7

• Fixed an issue where a players dead body counted in the scrap calculation, they are now ignored.
• Fixed a rare error when leaving a lobby after having just scanned causing the mod to stop working until a game restart

v1.0.6

• Fixed a compatibility issue with MelonLoader where it would throw an error causing ShipLootPlus to not load correctly
• Changed how the original ShipLoot is handled if its found, ShipLootPlus will now disable the original if its found

v1.0.5

• Actually fixed joining a server as a client mid-round with scrap already on the ship not calculating correctly for the joined player
• Fixed scrap values not updating correctly when placing scrap items on the counter at the company
• Balanced the rate limiting to make it feel better when interacting with scrap

v1.0.4

• Fixed an issue where joining a server as a client mid-round with scrap already on the ship was not calculating correctly for the joined player.
• Fixed an issue where spamming the grab button many times a second causing the same issues as the perpetual scan which caused a game crash (buffer overrun).
• Fixed an issue where selling items at the company would'nt refresh the data on occasion
• Fixed an issue where moon scrap value/count wasn't updating for all players on level load until the ship had fully landed
• Fixed patching methods that were some how not actually patching correctly
  • I also deep dived the hooked events and realized that I could remove some after I got these patches to actually apply
• Changed the refresh method to be rate limited so if an event wants to update the values but the values are already being refreshed it will skip triggering another refresh (this should add performance in the situations where multiple hooked events trigger a data refresh concurrently)
• Removed a left over ForceMeshUpdate() call which was not needed

v1.0.3

• Hopefully fixed a compatibility issue with mods that modify the scanner to be able to perpetually scan (like Hold Scan Button)
• Added a new configuration section for "On Scan"
  • Moved "Display Duration" into this new section
  • Added "Reset Duration Timer On Scan" option which will reset the timer of the UI when a scan is initialized, which keeps the UI always on screen if scanning is active (defaults to disabled).
  • Added "Refresh Data On Scan" option which will force a data update on scan, this is not really needed as all data is updated via event triggers, but it was left in the last two releases as a way to force refresh on demand. This is what is incompatible with mods like Hold Scan Button (defaults to disabled).
• Fixed an issue where moon scrap count was showing as 1 item while in space.

v1.0.2

• Fixed an issue where "Always On" mode did not function correctly when "Allow Outside" and/or "Allow Inside" was disabled.
• Fixed an issue where the "On Scan" timeout didn't get reset when scanning again
• Updated readme with better Rich Text resource links (thanks persondatlovesgames)

v1.0.1

IMPORTANT: With v1.0.1 there has been some changes which will reset any custom line formats and colors. You do not need to regenerate your configs and these settings will still be in your config file, its just that the line names and categories have changed (though now you would have extra data in the files).

• Refactored and abstracted most of the code to be more dynamic, performant, and reliable
• Optimized the calculation methods for getting scrap items and values

• Changed how the data is refreshed, it is now event driven so that the data is always updated even when not being shown
  • I only hooked events that affect the data point values but it will also trigger a refresh on scan. The end result is the data will always be current.
• Changed LethalConfig to a soft dependency so it can safely be removed (if desired) and not break ShipLootPlus
  • The Thunderstore package will still have it as a dependency as using it is the intended way to configure ShipLootPlus
• Changed the %LootValue% replacement pattern to %ShipLootValue%
• Changed the %DaysLeft% replacement pattern to %Deadline%
• Changed the different line names from [Ship, Quota, Days left] to [Line #1, Line #2, Line #3] since all data points are available to all lines.

• Added a slight angle to the UI elements so they better match other HUD elements
• Added width to the text field so it can be longer with out truncating
  • This is dynamic based on which lines are enabled due to scaling (when I make the custom scaling system it will be configurable)
• Added "Allow Inside" setting which works like "Allow Outside" but for inside the dungeon
• Added "Always On" mode - Decouples it from the scanner so you can always have it on screen
  • This mode will honor the "Allow Outside" setting => False means the UI will not show outside the ship or dungeon
  • This mode will honor the "Allow Inside" setting => False means the UI will not show inside the dungeon
• Added a configuration for duration timing (how long the UI shows after right clicking to scan. Range: 1 - 60 seconds. Default: 5 seconds)
• Added the ability to hide the line graphic
• Added a config for how many characters the "Short" data point variants return (Default: 3)
• Added support for Rich Text formatting. The line color in the config is applied to the line element first, meaning rich text formatting is applied after
  • Refer to This Guide on how to use rich text formatting
• Added the following data points:

   %MoonLootValue%      = Value of all scrap on the moon (excluding the ship)
   %AllLootValue%       = Value of all scrap (ship and moon)
   %ShipLootCount%      = Count of scrap items in the ship (excluding the moon)
   %MoonLootCount%      = Count of scrap items on the moon (excluding the ship)
   %AllLootCount%       = Count of scrap items (ship and moon)
   %CompanyRate%        = Current company buy rate
   %ExpectedProfit%     = Expected profit from scap on ship at current company buy rate
   %DeadlineWithColors% = Quota deadline in days but changes colors based on value (color thresholds will be customizable in the future)
   %DayNumber%          = Integer of days in the ship/save (E.g. 1, 3 ,10)
   %DayNumberHuman%     = Human friendly days in the ship/save (E.g. 1st, 3rd, 10th)
   %Weather%            = Current moons weather full name
   %WeatherShort%       = Current moons weather short name (Default is first 3 characters)
   %MoonLongName%       = Current moons full name
   %MoonShortName%      = Current moons short name (Default is first 3 characters)
  

• Removed the Position drop down configuration item as it is no longer needed
  • This will be replaced with a coordinate based position system in a later update

v1.0.0

• Release