summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI.Installer/readme.txt
blob: 5f54839849de4720842b27f6e1fc96546e554068 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
      ___           ___           ___           ___               
     /  /\         /__/\         /  /\         /  /\      ___     
    /  /:/_       |  |::\       /  /::\       /  /::\    /  /\    
   /  /:/ /\      |  |:|:\     /  /:/\:\     /  /:/\:\  /  /:/    
  /  /:/ /::\   __|__|:|\:\   /  /:/~/::\   /  /:/~/:/ /__/::\    
 /__/:/ /:/\:\ /__/::::| \:\ /__/:/ /:/\:\ /__/:/ /:/  \__\/\:\__ 
 \  \:\/:/~/:/ \  \:\~~\__\/ \  \:\/:/__\/ \  \:\/:/      \  \:\/\
  \  \::/ /:/   \  \:\        \  \::/       \  \::/        \__\::/
   \__\/ /:/     \  \:\        \  \:\        \  \:\        /__/:/ 
     /__/:/       \  \:\        \  \:\        \  \:\       \__\/  
     \__\/         \__\/         \__\/         \__\/              


SMAPI lets you run Stardew Valley with mods. Don't forget to download mods separately.


Install guide
--------------------------------
See http://stardewvalleywiki.com/Modding:Installing_SMAPI.


Need help?
--------------------------------
- FAQs: http://stardewvalleywiki.com/Modding:Player_FAQs
- Ask for help: https://discord.gg/kH55QXP


Manual install
--------------------------------
THIS IS NOT RECOMMENDED FOR MOST PLAYERS. See instructions above instead.
If you really want to install SMAPI manually, here's how.

1. Download the latest version of SMAPI: https://github.com/Pathoschild/SMAPI/releases.
2. Unzip the .zip file somewhere (not in your game folder).
3. Copy the files from the "internal/Windows" folder (on Windows) or "internal/Mono" folder (on
   Linux/Mac) into your game folder. The `StardewModdingAPI.exe` file should be right next to the
   game's executable.
4. If you use Steam, see the install guide above to enable achievements and overlay. Otherwise,
   just run StardewModdingAPI.exe in your game folder to play with mods.