Modding Stardew Valley with Vortex
Stardew Valley is a farming simulation role-playing video game developed by Eric "ConcernedApe" Barone and originally published by Chucklefish.
Engine: Microsoft XNA framework
This guide is designed to help you set up Vortex to install and manage mods for Stardew Valley.
At the time of writing, this guide only applies to Stardew Valley on Windows.
If you haven’t already, please run Stardew Valley at least once before modding it.
Getting Set Up
To begin, open up Vortex and navigate to the games section. If you don’t already see Stardew Valley under the “Managed” tab, check the “Discovered” section. Use the “Manage” button on the game tile to add it to your managed games.
If you can’t see Stardew Valley, you can scan for it or define it manually.
When you first manage Stardew Valley, you will be prompted to install the Stardew Modding API (SMAPI). This is required for Vortex to manage mods and highly recommended even if the mods you are using do not require it. Click “Go to SMAPI page” which should open the following link in your browser: https://smapi.io/
On the SMAPI website, click the green downloads button and select “Download from Nexus”. This will direct you to the Nexus Mods file page. Head to the “Files” tab where you will be presented with the files you can download:
Pay special attention to which version you download, as with the example above, some version will only work with the beta branch of the game.
Once you have downloaded SMAPI, extract the files somewhere on your PC. Then, inside the extracted folder, double click on the file called
install on windows.bat. This will open a Command Prompt window.
Type “1” to install and press enter. Press enter again to dismiss this window. If you have the Steam version of the game, follow the instructions in the window to configure Steam to work with SMAPI. SMAPI is now successfully installed.
Now, head back to the “Games” section in Vortex. Under the managed tab, click “Activate” on Stardew Valley. You may need to allow Vortex to run as admin, depending on your deployment defaults. You may want to update your deployment method to use hardlinks in order to avoid having to accept the prompt when mods are deployed.
Pressing the “Play” button in the corner of Vortex (or on the Dashboard) should now run StardewValley through SMAPI. If it is working correctly, a SMAPI command prompt window should open a few seconds before the game.
For Stardew Valley, there are several different types of mods.
|SMAPI Mods||These mods directly require the Stardew Modding API. SMAPI allows mods to directly interact with the games code.|
|Content Patcher Mods||These mods are dependant on the Content Patcher by Pathoschild which changes the games images and data without directly overwriting the original XNB files.|
|XNB Mods||This type of mod is an outdated mod format that is almost completely unused and can lead to some game breaking bugs if use incorrectly. XNB mods directly replace the XNB files found in the game directory. Where possible it is recommended you use a Content Patcher alternative.|
For the purposes of this article, we will install the following mods:
|UI Info Suite||https://www.nexusmods.com/stardewvalley/mods/1150|
|Canon-Friendly Dialogue Expansion for All Friend-able Characters||https://www.nexusmods.com/stardewvalley/mods/2544|
To begin, download all these mods by clicking either the "Vortex" button in the top right of the mod page or the "Mod Manager Download" button on the files tab.
Once all the files are in Vortex, install them and ensure the mods are deployed. You can then start the game using the play button in the top-left of Vortex where the names of your installed mods should appear in the SMAPI window as the game loads, along with any errors or warnings.
Can I run Stardew Valley without SMAPI?
You can do this by launching the game through
Stardew Valley.exe. You can add the executable to the dashboard of Vortex for convenience: Setting up tools
How do I update or uninstall SMAPI?
If you have updated the game, or there is a new version of SMAPI, you can find update instructions here.
You can remove SMAPI from your Stardew Valley installation by running
install on windows.bat again and entering "2" to remove it.
Note: This will prevent you from managing mods with Vortex until you install SMAPI again.
Can I stop the admin prompts when deploying mods?
The admin prompts are caused by Vortex's Symlink deployment. This is often selected as the default, however, you can switch to Hardlink deployment under "Settings", then "Mods". You can learn more about the different deployment options here.
Can I use Steam overlay and achievements with mods?
Yes, this requires some additional setup. There's a useful guide for this here.