ShipLootPlus

Rewrite of the OG ShipLoot and enhanced with more customization

By PXC

Last updated	7 months ago
Total downloads	344962
Total rating	13
Categories	Mods BepInEx Client-side
Dependency string	PXC-ShipLootPlus-1.1.0
Dependants	257 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100

AinaVT-LethalConfig

Provides an in-game config menu for players to edit their configs, and an API for other mods to use and customize their entries.

Preferred version: 1.4.0

README

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

DataPoint patterns and information

Below are the full list of what I call "DataPoints", essentially these DataPoints are basically replaced in the format string with the corresponding information from the game

  %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

Example Breakdown

Default Lines:

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

Translated Lines:

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

DataPoint Shortening

Each data point can be shortened so that it shows a truncated version of the data. All you have to do is add a ':' and a number and it will truncate that value to the number provided

%MoonName:3% becomes Off
%MoonName:5% becomes Offen

Rich Text Support

You can introduce further customizations inline with your formats.

Here are some resources to understand Rich Text and what tags are available (not every tag will work as the font that the game uses lacks some support)

Inline Rich Text formatting will override the text color for the specific word or DataPoint in the line, they are applied after the text line color configuration.

Specific DataPoint settings

Some data points have specific settings tied to them

Deadline

Customizing how the %Deadline% data point is displayed

Zero Replacement

By default when the deadline reaches zero, it is replaced with "NOW!", this can be disabled or the word can be changed in the config

Color Coding

You can enable/disable color coding directly for this data point in the config, it is disabled by default.

The color is set using the following thresholds:

2+ Days left
1 Day left
0 Days left

Each color can be customized in the config

Configuration

  [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

Weather

Customizing how the %Weather% data point is displayed

None/Clear Weather Text

By default when there is no weather, instead of showing "None" its changed to "Clear". This can be changed in the config or set to nothing/blank to show "None"

Color Coding

You can enable/disable color coding directly for this data point in the config, it is disabled by default.

It will change the color of the weather based on what weather it is, the colors can be customized in the config

NOTE: The "Hell" weather type is added by the HellWeather mod

Configuration

  [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

MoonName

You can customize some of the ways the moon name is displayed

Show the full moon name

By default the leading numbers are removed from the moon name 21 Offense becomes Offense, you can disable this to show the full moon name in the config

Replace Company Moon Name

By default when you navigate/land at the company building, the moon name (Gordion) is replaced with "Company Building", you can disable this or customize what it replaces it with in the config

Configuration

  [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

Configuration

Text Line Format Configuration

  [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

NOTE: The available data points show in the right panel in LethalConfig

Display Conditions and Settings

There are several conditions which change when or how the GUI is shown.

[Always Show]

This setting basically makes it so that the GUI will always be shown to the user and will updated data in real time

Configuration

  ## 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

[Allow Outside]

Enables or Disables the GUI from being seen when Outside (not in the ship and not in the dungeon)

Configuration

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

[Allow Inside]

Enables or Disables the GUI from being seen when inside the dungeon

Configuration

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

On Scan Settings

[Display Duration]

Sets the timeout for the GUI when a scan is initiated

Configuration

  ## 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

[Reset Duration Timer On Scan]

This will keep the UI timeout on scan active if the scanner is activated again.

Configuration

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

[Refresh Data On Scan]

Forces the scanner to do a data refresh when its active. This is not really needed as every data point is updated by event triggers but can allow you to on demand updated data.

WARNING: This can cause lag and potentially crashes if you are using macros to spam the scanner and/or are using mods which do it (like Hold Scan Button)

Configuration

  ## 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

GUI Breakdown and Configuration

The GUI consists of 4 elements, a Line Graphic and three Text fields. Each one has some common configurations

[Line Graphic]

This element is used to frame the data on the screen.

Enable/Disable: Line Graphic

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

Color: Line Graphic

NOTE: Uses standard HTML Hexadecimal color codes (Can be with or with out the # sign)

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

[Text Line #1]

This is the first (top) text line element

Enable/Disable: Text Line

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

Color: Text Line

NOTE: Uses standard HTML Hexadecimal color codes (Can be with or with out the # sign)

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

[Text Line #2]

This is the second (middle) text line element

Enable/Disable: Text Line

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

Color: Text Line

NOTE: Uses standard HTML Hexadecimal color codes (Can be with or with out the # sign)

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

[Text Line #3]

This is the last (bottom) text line element

Enable/Disable: Text Line

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

Color: Text Line

NOTE: Uses standard HTML Hexadecimal color codes (Can be with or with out the # sign)

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

Custom Colors Example

GUI Layout

The layout of the HUD elements can be customized in a few ways.

Font Settings

You can customize how the font is displayed with the below configurations

[Font Selection]

You can change which font is being used by ShipLootPlus, the default is the vanilla in-game font, but if you wanted to have dollar signs or other special characters display correctly you can.

Font List:

Vanilla (Default)
Fixed (Regular version of the 3270Font which fixes the dollar sign)
FixedSemiCondensed (Same as Fixed but slightly more condensed)
FixedCondense (Same as Fixed but more condensed )

Fixed

FixedSemiCondensed

FixedCondense

Configuration

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

[All Caps]

Enable/Disable all text being capitalized.

Configuration

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

[Size]

Change the size of the font

Configuration

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

[Character Spacing]

Change the Character Spacing of the font

Configuration

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

[Word Spacing]

Change the Word Spacing of the font

Configuration

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

[Text Alignment]

Change the Text Alignment of the text fields

IMPORTANT: This may produce unwanted results, everything is designed to be TopLeft and changing it may cause things to not display correctly

Configuration

  ## 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

[Transparency]

Change the Transparency/Alpha of the text

Configuration

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

Layout Settings

The whole layout of the GUI can be customized

[Position]

You can move the location of the GUI to any place on the screen

Configuration

  ## 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

[Scale]

You can change the scaling of the GUI to make it larger or smaller

Configuration

  ## 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

[Rotation]

You can change the Z rotation of the GUI to tilt it any degree you want

Configuration

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

[Text Field Width Offset]

You can change how many characters are displayed before it truncates, this can be helpful if you are changing the scaling.

This isn't measured in character count, only the width of the text field which is dynamically chosen based on how many lines are enabled.

The offset is just added to the width, so if you want to show more you would make it a positive value, less would be a negative value

Configuration

  ## 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

Dynamic text line scaling

The default layout is three lines of custom data, but sometimes that may be too much information, so you can disable any or all text lines if you want.

Since disabling them would normally mean a gap with whitespace, I built in dynamic scaling so that it will scale up the text lines based on how many are enabled. The only down side to this is it gives you less characters per line.

NOTE: If the line is too long it will be truncated with ellipses

NOTE: This is the closest to the original ShipLoot

Alternatively you could just disable the Line Graphic and set the Format for the line you don't want to see to an empty string (blank) to keep the original scale.

Debug Settings

This section explains the debug settings that can be enabled to assist with troubleshooting issues (generally you wont need to enable these)

[Debug Mode]

Enables/Disables debug mode IMPORTANT this will cause performance degradation unless you are using AsyncLoggers!

Configuration

  ## 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 RPC Hooks]

Disables all RPC hooks, this will have an impact on how often the data points are updated as it will have a couple less events its hooking. This really is only for times when you might be encountering error spam when an object ended up not being ready, often because of state desync.

Configuration

  ## 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

Planned Features

Expand what data is able to be set in each line
- [x] Ship scrap count
- [x] Moon scrap value and count
- [x] All scrap (ship + moon) value and count
- [x] Color coded deadline (change text color based on value, 0 = red, 1 = orange, 2+ = green)
- [x] Number of days in the ship(save)
- [x] Same as above but human friendly format (1st, 3rd, 10th, etc.)
- [x] Expected profit (scrap value - quota * buy rate)
- [ ] Total Value of scrap in player inventory
- [ ] Total Value of scrap in crew inventories
- [ ] scrap value to meet quota
- [x] Company buying percentage
- [x] Weather
- [ ] "InsideLoot" value/count (Loot only inside the dungeon)
- [ ] "OutsideLoot" value/count (Loot only not inside the dungeon and not in the ship)
- [ ] Current time
- [ ] Countdown until midnight
- [ ] Available money
- [ ] Probably more...
[x] Refactor the code to be more dynamic and reliable
[x] Optimize scrap calculation methods for performance
[x] Option to disable the bounding line entirely
[x] Option to make the HUD elements not tied to scanning so they are always shown
- [x] Make this honor the allow outside setting, if not allowed outside then only always show while on the ship
[x] Enable Rich Text support for each text field (override text formatting and color for specific elements instead of just the whole line)
[x] Option to change the HUD elements position (so it could be moved anywhere on screen)
- ~~[ ] Once this is working, remove the original ShipLoot incompatibility (so both could be ran together if desired)~~
[x] Option to change the HUD elements size/scaling (so it can be resized as well)
[x] Option to customize the color coded deadline colors and thresholds
[x] Option to customize the color coded weather colors
[x] Option to change font
[x] Option to change text settings
[x] Configurable timeout so you can customize how long it shows
[x] Expand the width of the text elements so more data can be shown before it truncates
[ ] Expand the amount of lines that can be enabled (from a default of 3, up to 5) with auto scaling
[x] Remove the "Position" drop down as its not needed since any data can be set on any line
[x] Rename the different line names from [Ship, Quota, Days left] => [Line1, Line2, Line3, etc]
[x] Make LethalConfig a soft dependency in the plugin so it can be uninstalled and ShipLootPlus still be functional

Potential Future Features (Suggestions that I may or may not do)

Add an additional hud element that allows you to see the exact scrap list and which items you need to make quota (would be disabled by default)
- Make this new HUD element position configurable
- Make this new HUD element scale configurable
~~Add the ability to send data updates to a configurable websocket endpoint via serialized json (would be disabled by default)~~
- This is now handled by another mod LethalLEDSign by ShakePrint

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

Get the Thunderstore App

ShipLootPlus

By PXC

This mod requires the following mods to function

BepInEx-BepInExPack

AinaVT-LethalConfig

README

ShipLoot Plus (+)

Key Features

Feature Breakdown

Example Breakdown

DataPoint Shortening

Rich Text Support

Specific DataPoint settings

Zero Replacement

Color Coding

Configuration

None/Clear Weather Text

Color Coding

Configuration

Show the full moon name

Replace Company Moon Name

Configuration

Configuration

[Always Show]

[Allow Outside]

[Allow Inside]

On Scan Settings

[Display Duration]

[Reset Duration Timer On Scan]

[Refresh Data On Scan]

[Line Graphic]

[Text Line #1]

[Text Line #2]

[Text Line #3]

Custom Colors Example

[Font Selection]

Fixed

FixedSemiCondensed

FixedCondense

[All Caps]

[Size]

[Character Spacing]

[Word Spacing]

[Text Alignment]

[Transparency]

[Position]

[Scale]

[Rotation]

[Text Field Width Offset]

[Debug Mode]

[Disable RPC Hooks]

Planned and Potential Future Features

Dependencies

Compatibility

Incompatible

Compatible (Tested by me or the community)

Font Asset Bundle Information

Other Mods

About

Developers