About this mod
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!
- Requirements
- Permissions and credits
- Mirrors
- Changelogs
- Donations
Tobey's BepInEx x MelonLoader Pack for Supermarket Simulator
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 modding 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's contents
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.FileTree, a configurable BepInEx plugin which logs the game's file tree to aid in troubleshooting issues.
Compatibility with MelonLoader
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 below section titled "Installing mods" 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!
Installation
To install manually, follow these instructions:
- Download Tobey's BepInEx x MelonLoader Pack for Supermarket Simulator from the Files tab.
- 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 into the game folder! - Linux (Steam Deck etc.) ONLY: In your Steam library, right-click the game, select Properties... and set the launch options:
WINEDLLOVERRIDES=winhttp=n,b %command%
⚠️ Do not set the launch options on Windows!
ℹ️ If the launch option doesn't work on Linux, you can instead set the Wine configuration (winecfg) for the game to add winhttp as a DLL override via the Libraries tab, setting it to native, builtin. Remove the 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.
Installing mods
Installing BepInEx or MelonLoader mods is generally as simple as opening up their .zip file and dragging their contents into the right folder.
For most BepInEx mods, that folder is BepInEx/plugins, unless the mod's instructions say otherwise.
For most MelonLoader mods, that folder is MLLoader/Mods, unless the mod's instructions say otherwise.
There are exceptions to these basic rules, so please do make sure to read the instructions of each mod you download. For mods that don't have instructions, check the requirements and make an educated guess:
- if it requires BepInEx, it's probably meant to be installed to BepInEx/plugins
- if it requires MelonLoader, it's probably meant to be installed to MLLoader/Mods
And if you still can't work it out, see the Installing mods section of the README for a simple guide.
Useful links for mod authors
- BepInEx: writing basic plugin walkthrough
- BepInEx: useful plugins for modding
- BepInEx: patching game methods at runtime
- Modded Supermarket Simulator Discord
Issues, questions, etc.
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.
Licensing
The BepInEx pack available for download via this page contains binaries from the following projects, redistributed without modification and in accordance with their licenses:
- BepInEx -- Licensed under LGPL-2.1
- BepInEx.MelonLoader.Loader -- Licensed under AGPL-3.0 and Apache-2.0 (for its use of MelonLoader)
- Tobey.BepInExMelonLoaderWizard -- Licensed under LGPL-3.0
- Tobey.FileTree -- Licensed under LGPL-3.0