SaleStarReminder

A client-side Risk of Rain 2 mod for the Seekers of the Storm DLC. It reminds you, in large red text across the top of the screen, when you're holding a Sale Star you haven't used yet.

While you hold an unused Sale Star and the stage still has an unopened chest it works on:

• UNUSED SALE STAR appears in red at the top of the screen, just below the box your items are shown in. It goes away once you spend the star, or once no chest the star works on is left on the stage, for example in the Bazaar.
• About to waste it: when the game draws its Sale Star circle around a chest you're looking at, and a better chest that's Large or higher is still unopened on the stage, the alert grows and fades in and out (twice per second, never a hard flash). Both can be turned off.
• Most valuable chest (optional, off by default): a line under the reminder names the best unopened chest on the stage to spend the star on, for example "There is a Legendary Chest on this stage". From best to worst:
  1. Legendary Chest
  2. Large Chest, Large Damage/Healing/Utility Chest, Rusty Lockbox (only while you hold a Rusted Key)
  3. Adaptive Chest
  4. Small Chest, Cloaked Chest, Damage/Healing/Utility Chest
  5. Equipment Barrel, Concept Reliquary

The mod never changes gameplay and never sends anything over the network. It works when you join a host who doesn't have it installed.

Configuration

Edit BepInEx/config/sevenstack.SaleStarReminder.cfg, or use the in-game settings menu if Risk Of Options is installed.

Notes

• The Sale Star comes back at the start of every stage, so the reminder comes back too until you spend it.
• The most-valuable-chest line counts chests you haven't found yet, which is why it's off by default.
• The Rusty Lockbox only counts while you hold a Rusted Key yourself, even if a teammate's key made it spawn.
• Chests from other mods still count as places to spend the star, but they rank below every chest listed above.

Building

Requires the .NET 8 SDK and a local Risk of Rain 2 install.

dotnet build -c Release   # also copies the DLL into the r2modman Default profile
./build.sh                # builds and writes dist/SaleStarReminder-<version>.zip for Thunderstore

Paths default to the Steam and r2modman locations on Linux. Override RoR2Dir and ProfileDir in a Directory.Build.props.user file (see Directory.Build.props).

tools/make_icon.py draws thunderstore/icon.png.

A feature that makes fun of you for spending the star on a small chest is built but hidden until its lines are written. To work on it, fill in src/MockLines.cs and set PluginConfig.MockingAvailable to true.

The version lives in thunderstore/manifest.json. To release, bump it, run ./build.sh, and publish a GitHub release tagged v<version> with the zip attached. The publish workflow then uploads that zip to Thunderstore.

Changelog

1.0.1

• Fixed being mocked for a chest you only looked at. A star spent some other way, such as by the Captain's Hacking Beacon opening a different chest, no longer counts against the chest you last aimed at.
• Fixed an error when a chest added by another mod has no name.
• The settings now say that ShowReminder can be turned off to get only the mocking message.

1.0.0

• New optional message that makes fun of you for spending the star on a small chest, an Equipment Barrel or a Concept Reliquary while a Large Chest, Rusty Lockbox or Legendary Chest was still on the stage. With the most-valuable-chest line on, it also names the chest you could have used. Off by default.
• The mocking lines come from MockLines.json next to the mod's DLL, so you can write your own. Vulgar lines are a separate option, also off by default.
• The reminder no longer shows while you remote-operate a drone, since drones can't open the chests a Sale Star works on.

0.9.0

• First release.
• Large red "UNUSED SALE STAR" text just below the item box at the top of the screen while you hold an unused Sale Star and the stage still has a chest it works on.
• The text grows and slowly pulses while the game circles a chest that's worse than a Large Chest or better still on the stage. Both can be turned off.
• Optional line naming the most valuable unopened Sale Star chest on the stage, for example "There is a Legendary Chest on this stage".