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

Example Breakdown

Default Lines:

Ship: $%ShipLootValue%(%ShipLootCount%)/$%MoonLootValue%(%MoonLootCount%) [%MoonShortName%:%Weather%]
Quota: $%FulfilledValue%/$%QuotaValue% - Prof: $%ExpectedProfit%(%CompanyRate%%)
Deadline: %Deadline% - %DayNumberHuman% day

Translated Lines:

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

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)

• Style text with rich text tags
• Supported rich text tags

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.

The %DeadlineWithColors% DataPoint uses this internally to change the color of the deadline day number from Green (2+ days) => Orange (1 day) => Red (0 days)

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%)
  Format = Ship: $%ShipLootValue%(%ShipLootCount%)/$%MoonLootValue%(%MoonLootCount%) - $%InventoryLootValue%(%InventoryLootCount%)

  [Line #2]
  ## Line #2 text format.
  ## [Lists each DataPoint but omitted here for space reasons]
  # Setting type: String
  # Default value: Ship: Quota: $%FulfilledValue%/$%QuotaValue% - $%ExpectedProfit%(%CompanyRate%%)
  Format = Quota: $%FulfilledValue%/$%QuotaValue% - $%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: %DeadlineWithColors% - %DayNumberHuman% day (%Weather%)

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

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

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

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

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

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

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

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.

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

[All Caps]

Force all text to be capitalized.

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

[Short Character Count]

This is the amount of characters to return for the various "Short" data point variants

  ## How many characters to show for the following data points:
  ## 
  ## %WeatherShort%
  ## Current moons weather (short name)
  ## 
  ## %MoonShortName%
  ## Current moons short name
  ## 
  ## 
  # Setting type: Int32
  # Default value: 3
  Short Character Count = 3

NOTE: "Experimentation" becomes "Exp"

[Text Line #1]

This is the first (top) text line element

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

[Text Line #2]

This is the second (middle) text line element

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

[Text Line #3]

This is the last (bottom) text line element

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

Custom Colors Example

All Caps Example

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.

• 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)
• [ ] 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)
• [ ] Option to change the HUD elements size/scaling (so it can be resized as well)
• [ ] Option to customize the color coded deadline colors and thresholds
• [ ] Option to change font
• [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

• 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