This page explains how install SMAPI (the tool which lets you use mods) on Windows.
See instructions for: Android • Linux • macOS • Steam Deck.
Install SMAPI
- Run the game without SMAPI at least once (so it can do first-time setup).
- Download latest version SMAPI .
- Extract the .zip file somewhere.(Your downloads folder is fine.)
- Double – click
install on Windows.bat
¹, follow the on-screen instructions.
- Configure game client: see the instructions for Steam, GOG Galaxy, or Xbox app.
¹ To install manually instead, see instructions in the installer’s readme.
Configure game client
Steam
You need launch SMAPI through Steam if you want the Steam overlay, achievements, playtime tracking work.(If you don’t care about achievements or tracking game time, you can just launch StardewModdingAPI.exe
in your game folder play with mods.)
configure :
- Keep SMAPI’s installer window open.
( closed , run .need uninstall .)
- Copy the text in the installer window that looks like this (see how copy text):
Make sure you copy the entire line, including both quotation marks "
the %command%
part.
Your final path should look something like this: " path " % command%
- In the Steam client, right-click on Stardew Valley choose Properties:
- Click textboxLaunch Options:
- Replace anything in the textbox with the text you copied from the installer.
To paste text, click in the box press CTRL V.
- This text should consist of “Your SMAPI API Filepath” %command%
Default is is users" C:\Program Files ( x86)\Steam\steamapps\common\Stardew Valley\StardewModdingAPI.exe" %command%
The quotes – %command% – are both necessary, so include them!
- From now on, just launch the game through Steam run SMAPI with the Steam overlay achievements.
Alternatively, you can add SMAPI as a non-Steam game if you would like separate Steam play buttons for an unmodded modded version of the game.
To configure it this alternate way:
- Keep SMAPI’s installer window open, as in the previous method.
( closed , run .need uninstall .)
- Copy the text in the installer window as above, without the
%command%
portion.
- In the Steam Client, select “Games” at the top-left of the client window, then select “Add a Non-Steam game my library…”
- In the menu that comes up afterwards, select “Browse…”
- Navigate the game’s local files by pasting the text copied from the SMAPI installer in the file area above.Alternately, if you would prefer, you can navigate your game files directly – you can find your game folder by browsing local files of Stardew Valley, but as above for most users the game’s files on Steam are located at
" C:\Program Files ( x86)\Steam\steamapps\common\Stardew Valley
.
- Select StardewModdingAPI click “open”.SMAPI will be added the list of programs add the Games Library.Select “Add Selected Programs” in the Steam Window you selected “Browse…” from previously, an entry for StardewModdingAPI will be made in your Steam Library.
- (Optional) In the Steam client, right-click on StardewModdingAPI choose Properties.You can now change the title of StardewModdingAPI whatever you would like in the top field – it is suggested title it “SMAPI” or “Stardew Valley Modded” (without quotations) if you do not wish keep the original name.(This will not alter your installation in any way, it will simply change the title of the mod client in your Steam Library.)
You can now select play on StardewModdingAPI (or its alternate title) SMAPI will launch, preserving the original “Stardew Valley” entry in your Steam Library for use in playing the unmodded game.The Steam overlay will still be available, Steam recognizes that Stardew Valley is being run as well, adding your playtime.Achievements will also work as usual, as Stardew Valley is recognized by Steam as being active when SMAPI is being run.
GOG Galaxy
You is need need launch SMAPI GOG Galaxy want playtime tracking work .( care tracking game time , you is launch launch StardewModdingAPI.exe
in your game folder play with mods.)
configure :
- Open Notepad paste in the following:
start "" "C:\Program Files (x86)\GOG Galaxy\Games\Stardew Valley\StardewModdingAPI.exe"
(If your game is installed a different folder, replace the path in the command above.)
- Click on File then Save.
- In the Save window is change appears : navigate Stardew Valley game folder , changeSave as type All Files, change the file name
start.bat
, click Save.
- In the GOG Galaxy client, click on Stardew Valley > settings icon > Manage installation > Configure.
- In the menu that appears, enable the “Custom executables / arguments” checkbox .
- Click Add another executable / arguments.
- Choosestart.bat in the window that appears click Open.
- EnableDefault Executable radio button under the File 2 section you just added, click OK.
From now on, you can launch Stardew Valley through GOG Galaxy both the SMAPI console game will load as expected!
Xbox app
Mods is work work Xbox app , extra steps .
- you is install install SMAPI :
-
- Open Stardew Valley section Xbox app .
- Click the …> Manage button:
- Click the Files tab then Browse open your game folder:
- Open the Stardew Valley > Content folder.You should see a lot of files with names like api-ms-win-core-*:
- Copy path address bar .
- Run the SMAPI installer:
-
- Run the SMAPI installer like usual, but:
- Download the installer somewhere that’s not the game directory (like your downloads folder).
- When it asks where install, enter the path you copied from the previous step.
- After you install SMAPI:
-
- In your game folder:
- rename
Stardew Valley.exe
another name such as Stardew Valley original.exe
;
- make a copy of
StardewModdingAPI.exe
name the copy Stardew Valley.exe
.
That’s it! Now just launch the game through the Xbox app play with mods.Note that when the game updates, you’ll need redo the last two sections.
Update SMAPI
Just install the new version; the installer will automatically clean up previous versions.(You don’t need configure Steam or GOG Galaxy again.)
Uninstall
- Run run installer , chooseuninstall remove SMAPI.(Not applicable for Xbox app.)
- If you configured Steam or GOG Galaxy launch SMAPI, undo your changes:
- Steam: in the Steam client: right-click on Stardew Valley, choose Properties > General > Set Launch Options, blank the launch options textbox.
- GOG Galaxy: in the GOG Galaxy client: click on Stardew Valley, click the settings icon next the ‘Play’ button, click Manage installation > Configure, clear the Custom executables / arguments checkbox .
- Xbox app:
- follow the installation steps for Xbox app open your game folder;
- rename
Stardew Valley.exe
StardewModdingAPI.exe
;
- rename
StardewModding Valley original.exe
(or the name you chose when installing SMAPI) back Stardew Valley.exe
.
(If you want play without mods temporarily, you can just launch Stardew Valley.exe
directly or rename your Mods folder instead.Not applicable for Xbox app.)
Troubleshooting
“Oops, couldn’t find the game automatically”
If you are using Game Pass, folder permissions will probably cause problems if you try this. Otherwise, if the installer shows that message, you can help it find the game folder.To do that:
- Exit the installer.
- Find your game folder.
- Move the installer folder into the game folder.(Make sure you move the whole folder, not just the files inside it!)
- Run the installer again it should auto-detect the game folder now.
You can safely delete the installer folder when it’s done.
I can’t find a specific file mentioned in the guide!
Windows hides file extensions by default.To reveal them, simply tick the option in file explorer.
If using Windows 11, refer this screenshot instead:
Issues with SMAPI or mods
See the troubleshooting page for help with issues after installation.