This is a BepInEx pack for Supermarket Simulator, preconfigured and ready to use on Windows, macOS and Linux (including Steam Deck, SteamOS, etc.), with compatibility for MelonLoader mods and plugins!
BepInEx is a general purpose framework for Unity modding. BepInEx includes tools and libraries to
- load custom code (hereafter plugins) into the game on launch;
- patch in-game methods, classes and even entire assemblies without touching original game files;
- configure plugins and log game to desired outputs like console or file;
- manage plugin dependencies.
BepInEx is currently one of the most popular modding tools for Unity on GitHub.
This pack is preconfigured and ready to use for Supermarket Simulator modding.
In particular, this pack comes with
- BepInEx.MelonLoader.Loader, a configurable BepInEx loader for MelonLoader mods and plugins,
- Tobey's BepInEx MelonLoader Wizard, a utility focusing on helping users easily migrate from vanilla MelonLoader, and
- Tobey's File Tree Logger for BepInEx, a configurable BepInEx plugin which logs the game's file tree to aid in troubleshooting issues.
This pack comes with BepInEx.MelonLoader.Loader, enabling you to use mods made for both BepInEx and MelonLoader at the same time!
With this pack installed, mods for MelonLoader need to be installed into the MLLoader subfolders to work. See the Installing mods section below for details.
When you run the game with this pack installed, Tobey's BepInEx MelonLoader Wizard will handle migrating any MelonLoader mods you already have installed to the MLLoader folder for you, and clean up any MelonLoader files and folders that you won't be needing anymore!
Tip
The game folder is the folder containing the game's executable (e.g. Supermarket Simulator.exe).
Steam users can find the game folder by right-clicking the game in their Steam library and selecting Manage -> Browse local files.
To install manually, follow these instructions:
-
Download Tobey's BepInEx x MelonLoader Pack for Supermarket Simulator.
-
Extract the contents of the downloaded archive into the game folder. Replace any files if prompted.
ℹ️ That just means open the .zip file and drag the files and folders out into the game folder! -
macOS & Linux (Steam Deck etc.) ONLY: In your Steam library, right-click the game, select
Properties...and set the launch options:export WINEDLLOVERRIDES="winhttp=n,b" && %command%⚠️ Do not set the launch options on Windows!ℹ️ On macOS and Linux you can alternatively set the Wine Configuration (
winecfg) for the game to addwinhttpas a DLL override via theLibrariestab, setting it tonative, builtin. Remove the Steam launch options if applicable. -
Run the game as normal (e.g. launch it from Steam).
-
If you are prompted to migrate mods from MelonLoader, confirm the prompts as desired.
Important
With just this pack installed, you will not see any changes in-game!
Check the LogOutput.log file in the BepInEx folder to determine whether BepInEx has loaded.
Note
The paths in this section are relative to the game folder, e.g. BepInEx/plugins = [game folder]/BepInEx/plugins, where [game folder] is the path to the folder containing the game's executable (e.g. Supermarket Simulator.exe).
Steam users can find the game folder by right-clicking the game in their Steam library and selecting Manage -> Browse local files.
Tip
"Extract the .zip" simply means take the contents of the .zip file and put them in the specified location.
For example, if you are told to "extract the .zip" or "extract the contents of the archive" into BepInEx/plugins, then you can simply open the .zip archive by double-clicking on it, then just select everything inside and drag the contents into your BepInEx/plugins folder. Easy!
It is strongly recommended to read and follow the instructions provided in the description of each mod you download.
However, sometimes mod authors don't give good (or any) instructions, or you just can't be bothered to read them (we've all been there). For those occasions, here's a simple reference:
| Mod type | Where to extract the .zip |
|---|---|
| BepInEx plugin | BepInEx/plugins |
| BepInEx patcher | BepInEx/patchers |
| MelonLoader mod | MLLoader/Mods |
| MelonLoader plugin | MLLoader/Plugins |
| Folder located in root of .zip | Where to extract the .zip |
|---|---|
BepInEx |
Directly in the game folder |
MLLoader |
Directly in the game folder |
plugins |
Try BepInEx first, otherwise MLLoader |
patchers |
BepInEx |
Mods |
MLLoader |
Plugins |
Try MLLoader first, otherwise BepInEx |
Tip
On Nexus mod pages, you can usually see a mod's requirements by expanding the Requirements near the top of the description tab. Otherwise, read the mod's description.
| Listed in requirements | Mentioned somewhere on the page | Where to extract the .zip |
|---|---|---|
| BepInEx (especially this BepInEx pack) | MelonLoader | Probably MLLoader/Mods, maybe MLLoader/Plugins. Use common sense and refer to the .zip structure as needed. |
| BepInEx / this BepInEx pack | Probably BepInEx/plugins, maybe BepInEx/patchers. Use common sense and refer to the .zip structure as needed. |
|
| BepInEx | Probably BepInEx/plugins, maybe BepInEx/patchers. Use common sense and refer to the .zip structure as needed. |
|
| MelonLoader | Probably MLLoader/Mods, maybe MLLoader/Plugins. Use common sense and refer to the .zip structure as needed. |
|
| MelonLoader | Probably MLLoader/Mods, maybe MLLoader/Plugins. Use common sense and refer to the .zip structure as needed. |
First, double check and follow the instructions on the mod page. If you still can't figure it out or there aren't any instructions on the mod page, you'll have to get in touch with the author of the mod somehow. Your best bet is usually going to be the Nexus Mods posts tab of that mod. Make sure to check that the question hasn't already been asked and answered.
- BepInEx: writing basic plugin walkthrough
- BepInEx: useful plugins for modding
- BepInEx: patching game methods at runtime
- Modded Supermarket Simulator Discord
First, please make sure to check that the answer you're looking for isn't already somewhere on this page. Use Ctrl+F to search for keywords.
Second, check the FAQ to see if there is an answer there.
If not, at this moment, you can use the following channels to ask for help:
- Modded Supermarket Simulator Discord
- Nexus Mods posts tab
- GitHub issues
- BepInEx Discord -- Intended for developers, only technical support for BepInEx itself will be provided. No support for mods.
This GitHub repository contains no code or binaries from external sources, only code used to automatically put together a preconfigured .zip of the BepInEx pack.
However, the .zip created by this repository's code contains binaries from the following projects, redistributed without modification and in accordance with their licenses:
| Project | License(s) |
|---|---|
| BepInEx | LGPL-2.1 |
| BepInEx.MelonLoader.Loader | AGPL-3.0 and Apache-2.0 (for its use of MelonLoader) |
| Tobey.BepInExMelonLoaderWizard | LGPL-3.0 |
| Tobey.FileTree | LGPL-3.0 |
The code in this repository is licensed under the LGPL-3.0 license.
