About this mod
A BepInEx pack for Supermarket Simulator, preconfigured and ready to use on Windows, macOS and Linux (including Steam Deck handhelds), 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 handhelds), with compatibility for MelonLoader mods and plugins!
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
Quick Start for Windows
Extract the archive into the game folder replacing any files if prompted, run the game once to generate all needed files and folders, if any prompts about MelonLoader appear just click Yes, then quit the game at the main menu and you're good to go.
If something doesn't go according to plan or you need further guidance, please refer to the full instructions below. Don't worry, it looks harder than it is. Please don't skimread!
Quick Start for Linux and Steam Deck handhelds
Same as for Windows but follow step 4 from the full instructions below first.
For Steam Deck handhelds, switch to Desktop mode to follow the instructions. Once you've got it all working, you'll be able to play with mods in either Desktop or Gaming mode as preferred.
Quick Start for macOS
It varies depending on how you run the game and your level of technical know-how. The easiest for novices is to use parallels (Apple Silicon) or bootcamp (Intel) and follow the Windows instructions. Sorry.
If you're a techie then you can probably figure out how to get it running on macOS by following the Linux instructions, but note that you'll have to refer to your emulator's instructions for how to set the required environment variable (WINEDLLOVERIDES="winhttp=n,b") or how to run winecfg so that you can set winhttp as a DLL override - setting the environment variable in the Steam launch options as Linux users do won't work.
Otherwise, make sure the game actually works already without mods, then join the Modded Supermarket Simulator discord server and @toebean in the #general-support channel with info about which emulator you use to run the game (e.g. Whisky? HyperPlay? Something else?). Be aware I will not help you if it's pirated.
Full instructions for Windows, Linux and Steam Deck handhelds
1. Download Tobey's BepInEx x MelonLoader Pack for Supermarket Simulator from the Files tab.
2. Make sure the game is not running.
3. Extract the contents of the downloaded archive into the game folder. Replace any files if prompted.
ℹ️ That just means open the .zip file (e.g. double click it) and drag-and-drop the files and folders into the game folder!
If done correctly, inside your steamapps > common > Supermarket Simulator folder it should look something like this:
⚠️ This list is used as a reference and is non-exhaustive, there will be other stuff, please don't delete anything!
- BepInEx
- MLLoader
- Plugins
- Supermarket Simulator_Data
- doorstop_config.ini
- Supermarket Simulator.exe
- version.dll
- winhttp.dll
4. Skip this step if you play on Windows!
Linux and Steam Deck handheld users: go to 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 if you play the game on Windows!
ℹ️ If preferred, Linux users can instead set the Wine configuration (winecfg) for the game to add winhttp as a DLL override via the Libraries tab. Remove the launch options if applicable. Full instructions here.
5. Run the game from Steam as normal.
If you previously had MelonLoader installed, you may be prompted to migrate your mods and clean up redundant files from MelonLoader. It is recommended to click Yes to each of these prompts unless you know what you're doing. This will allow any MelonLoader mods you previously installed to continue to work with this pack.
6. Exit the game at the main menu.
Assuming you have followed these instructions correctly, inside the Supermarket Simulator > BepInEx folder there will now be a file LogOutput.log (or simply LogOutput - it's the same thing). This is your log file, and it will be regenerated every time the game runs with technical and diagnostic information about your installed mods, and any errors that might happen while playing. It's very useful for troubleshooting, and it is recommended to share it whenever asking for help with your mods. It is equivalent to the MelonLoader or BepInEx console window you might be familiar with, containing all of the same information.
If this file is missing, it usually means that you have not installed the pack correctly and you should probably try again from scratch. Make sure to pay careful attention to the instructions and don't skimread any of the steps.
Otherwise, you can now install mods according to the section below.
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 Supermarket Simulator > BepInEx > plugins, unless the mod's instructions say otherwise.
For most MelonLoader mods, that folder is Supermarket Simulator > 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 - but remember that you should skip any instructions to install MelonLoader as you already have it included with this pack.
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 Supermarket Simulator > BepInEx > plugins
- if it requires MelonLoader, it's probably meant to be installed to Supermarket Simulator > MLLoader > Mods
And if you still can't work it out, see the Installing mods section of the README for a simple guide.
Full pack 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,
- Tobey's File Tree Logger for BepInEx, a configurable BepInEx plugin which logs the game's file tree to aid in troubleshooting issues,
- Tobey's Timestamp Logger for BepInEx, a configurable BepInEx patcher which logs the current timestamp, and
- Tobey's Game Info Fix for BepInEx.MelonLoader.Loader, a simple patch to correct the game info logs of BepInEx.MelonLoader.Loader.
Useful links for mod authors
- Doorstop: debugging Unity Mono games
- 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, 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
- Tobey.MLLoader.GameInfo -- Licensed under LGPL-3.0
- Tobey.BepInEx.Timestamp -- Licensed under LGPL-3.0