SweepersHeaven

v1.3.1·Updated 2024-11-04

A plugin for mass item collection with configurable settings and a debug mode.

About this mod Author’s original text

SweepersHeaven Plugin

SweepersHeaven is a quality-of-life plugin for Supermarket Together designed to make product collection easier and faster! When thieves leave the store, get beaten and drop a large number of items, chasing after every single one can be exhausting. With SweepersHeaven, players can use their broom to collect multiple products at once, saving time and hassle.

Features

  • Bulk Collection: Pick up several dropped items with a single sweep.
  • Customizable Collection Radius: Adjust how wide the sweep is for collected items.
  • Dynamic Visuals: Collected items are swept aside with added visual impact.
  • Debug Mode: Special debug options to test product spawning and sweeping functionality.
  • Mini Transporter Pickup: Collect items using the Mini Transporter.
  • Pickup all trash at once: Picks up all trash in the store at once, disabled by default.

Installation

  • Download the latest.zip package or from the releases page.
  • Extract the contents to the BepInEx/plugins folder in your Supermarket Together installation directory.
  • Launch the game and start sweeping!

Configuration

After installation, you can configure SweepersHeaven using the BepInEx configuration file:

  • PickupRadius: Controls how wide an area items are collected from.
  • MaxItemsToPick: Set a limit on the number of items picked up in one go.
  • ThrowItemsOnPickup: Enable or disable throwing items when picked up.
  • PickupKey: Assign a custom key to activate the broom for sweeping.
  • IsDebugMode: Toggle debug mode for spawning extra items and testing.
  • SpawnKey: Assign a custom key to spawn items for testing.
  • MiniTransporterAutoPickup: Enable or disable the ability to pick up items with the Mini Transporter.
  • PickUpAllTrashAtOnce: Enable or disable the ability to pick up all trash in the store at once.

Development

To contribute:

  • Clone the repository and build the project with dotnet build.
  • Place the compiled.dll file from bin/Debug/netstandard2.1 in your BepInEx/plugins folder to test.

License

Licensed under the MIT License. See the LICENSE file for details.

Questions & Feedback

For questions, suggestions, or feedback, please open an issue on GitHub.

Install & use Install: follow the bundled instructions

  1. Unzip the archive from playbuff and read the bundled readme / instructions first.
  2. Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
  3. For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
  4. Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.

Install locations vary a lot between mods — the bundled readme is the most reliable guide.

Dependencies

Install these first, or the mod will not work:

BepInEx-BepInExPack

File & checksum

Filename
SweepersHeaven-1.3.1.zip
File size
136.3 KiB