Modding:Player Guide - Revision history

imported>Pathoschild: merge into Modding:Player Guide/Getting Started

2018-08-25T23:17:03Z

merge into Modding:Player Guide/Getting Started

← Older revision		Revision as of 23:17, 25 August 2018
Line 1:		Line 1:
	~~{{/header}}~~		#REDIRECT [[Modding:Player Guide/Getting Started]]

	~~Do you want to play Stardew Valley with mods? This guide is for you!~~
	~~{{/footer~~
	~~\|prev =~~
	~~\|next = [[/Getting Started#Getting started\|Skip to quick start]]~~
	}}

	~~==Intro==~~
	A "mod" is just a package of files which changes Stardew Valley in some way. Mods can add features (like showing NPCs on the map), change game mechanics (like making fences decay more slowly), make cosmetic changes (like making your house look like a hobbit home), and more.

	~~Using mods is easy! You just need to...~~
	# Install SMAPI. This is the mod loader for Stardew Valley — it launches the game with mod support and lets mods interact directly with the game code. It's safely installed alongside your normal game, and you can uninstall it anytime.
	~~# Unzip mods into your <tt>Mods</tt> folder.~~

	~~That's about it! If you're ready to start, see [[/Getting Started\|Getting Started]].~~

	~~==Frequent questions==~~
	~~===Can I use mods on Linux, Mac, Windows, or consoles?===~~
	~~Mod support for each platform:~~
	~~{\| class="wikitable"~~
	\|-
	~~! Platform~~
	~~! Mod support~~
	\|-
	~~\| Linux~~
	~~\| ✓ fully supported~~
	\|-
	~~\| Mac~~
	~~\| ✓ fully supported~~
	\|-
	~~\| Windows~~
	~~\| ✓ fully supported~~
	\|-
	~~\| Nintendo Switch~~
	~~\| ✖ no mod support~~
	\|-
	~~\| PS4~~
	~~\| ✖ no mod support~~
	\|-
	~~\| XBox One~~
	~~\| ✖ no mod support~~
	\|}

	~~Almost all mods will work on any supported platform, since SMAPI rewrites them for compatibility.~~

	~~===Can mods corrupt my save?===~~
	Yes, but it's extremely rare. Only a few mods affect your save file at all. If you avoid those, mods are very unlikely to corrupt your save file. In most cases, you can fix save corruption by [[Saves#Undo the last save\|undoing the last save]].

	~~If you're worried, just back up [[~~#Save files\|your save files]] occasionally. That's strongly recommended even if you don't use mods, since save corruption is almost always caused by the game itself. SMAPI also creates a daily backup of your saves automatically; you can retrieve those from the <tt>Mods/SaveBackup</tt> folder.

	~~===Can I stop using mods later?===~~
	~~Yep. With a few exceptions (see previous question), mods don't directly affect your save file so you can stop using them anytime.~~

	~~===Do mods disable Steam achievements?===~~
	Steam achievements work fine, as long as you launch SMAPI through Steam. Make sure you follow the [[Modding:Installing SMAPI on Windows\|install instructions]] to configure Steam on Windows (no Steam changes needed on Linux or Mac). If the Steam overlay works, the achievements should work too.

	~~===Do mods work in multiplayer?===~~
	~~Yep. Stardew Valley 1.3 is still new, so check the [[Modding:SMAPI compatibility\|SMAPI compatibility list]] to see if the mod is compatible.~~

	How they work depends on the mod. Usually each player can have their own mods, and you can mix modded and vanilla players. Some mods don't work (or work poorly) in multiplayer, or affect other players too. Try checking the mod description for details about multiplayer (often under a 'compatibility' header).

	~~Here are some ''approximate'' rules for mods that don't specify:~~

	~~{\| class="wikitable"~~
	\|-
	~~!style="text-align: left;"\| type of mod~~
	~~!style="text-align: left;"\| effects~~
	~~!style="text-align: left;"\| summary~~
	\|-
	~~\| Content Patcher~~
	~~\| ''depends''~~
	~~\| See [https://github.com/Pathoschild/StardewMods/tree/develop/ContentPatcher#multiplayer ''Multiplayer'' in the Content Patcher readme] (applies for XNB mods too).~~
	\|-
	~~\| Map replacements~~
	~~\| local~~
	\| That includes mods which replace an existing map (without adding special logic with SMAPI). These are only visible to players who install them. Players without the custom map will see the normal map and will be subject to the normal bounds (e.g. they may see other players walk through walls, but they won't be able to follow).
	\|-
	~~\| Visual changes~~
	~~\| local~~
	\| That includes custom portraits and sprites, custom farmer appearance (except GetDressed or Kisekae), recolors, etc. These mods only affect the players who installed them. Other players won't be affected. If both players have the same mods, they'll see the same visual changes though.
	\|-
	~~\| Time changes~~
	~~\| global~~
	\| That includes any mod which pauses time, changes the current time, or changes the rate of time. These mods only work when installed by the main player, but will affect all players. They will have no effect when used by farmhands.
	\|-
	~~\| Custom UI~~
	~~\| local~~
	~~\| That includes mods that add new icons, tooltips, and menus. These mods only affect the players who installed them. Other players won't be affected.~~
	\|-
	~~\| World changes~~
	~~\| global~~
	~~\| That includes any mods which edit things in the world — durable fences, monster stat changes, etc. These mods affect all players, no matter who installs them.~~
	\|-
	~~\| Other mods~~
	~~\| ''depends''~~
	~~\| See the mod's description for details, or ask the author.~~
	\|}

	~~===What is SMAPI?===~~
	SMAPI is the mod loader for Stardew Valley. It works fine with GOG and Steam achievements, it's compatible with Linux/Mac/Windows, you can uninstall it anytime, and there's a friendly community if you need help. SMAPI is required for most types of Stardew Valley mod.

	~~SMAPI does a lot for you. For example, it will...~~

	~~# Load mods into the game and provide APIs they can use. Many types of mod aren't possible without SMAPI.~~
	~~# Rewrite mods for crossplatform compatibility, so you can use almost any mod on Linux/Mac/Windows.~~
	~~# Intercept errors. If a mod crashes or causes an error, SMAPI will intercept the error, show the error details in the console window, and in most cases automatically recover the game.~~
	~~# Provide update checks. SMAPI automatically alerts you when a new version of a mod is available.~~
	~~# Provide compatibility checks. SMAPI automatically detects when a mod is incompatible and disables it before it causes problems.~~

	~~===Where are my...===~~
	* Game folder: see ''[[Modding:Player Guide/Getting Started~~#Find your game folder\|Getting Started#Find your game folder]]''.~~
	* SMAPI log: see ''[[Modding:Player Guide/Troubleshooting#Find your SMAPI log\|Troubleshooting#Find your SMAPI log]]''.
	* Save files: see ''[[Saves]]''.

	~~{{/footer~~
	~~\|prev =~~
	~~\|next = [[/Getting Started\|Getting Started]]~~
	}}

	~~[[zh:使用模组：玩家常见问题~~]]

imported>Margotbean: /* Do mods disable Steam achievements? */ follow the links

2018-08-23T15:59:33Z

Do mods disable Steam achievements?: follow the links

← Older revision		Revision as of 15:59, 23 August 2018
Line 54:		Line 54:

	===Do mods disable Steam achievements?===		===Do mods disable Steam achievements?===
	Steam achievements work fine, as long as you launch SMAPI through Steam. Make sure you follow the [[Modding:~~Player Guide/Getting Started#Install~~ SMAPI\|install instructions]] to configure Steam on Windows (no Steam changes needed on Linux or Mac). If the Steam overlay works, the achievements should work too.		Steam achievements work fine, as long as you launch SMAPI through Steam. Make sure you follow the [[Modding:Installing SMAPI on Windows\|install instructions]] to configure Steam on Windows (no Steam changes needed on Linux or Mac). If the Steam overlay works, the achievements should work too.

	===Do mods work in multiplayer?===		===Do mods work in multiplayer?===

imported>Margotbean: /* Do mods disable Steam achievements? */ direct link

2018-08-23T15:55:32Z

Do mods disable Steam achievements?: direct link

← Older revision		Revision as of 15:55, 23 August 2018
Line 54:		Line 54:

	===Do mods disable Steam achievements?===		===Do mods disable Steam achievements?===
	Steam achievements work fine, as long as you launch SMAPI through Steam. Make sure you follow the [[Modding:~~Installing~~ SMAPI\|install instructions]] to configure Steam on Windows (no Steam changes needed on Linux or Mac). If the Steam overlay works, the achievements should work too.		Steam achievements work fine, as long as you launch SMAPI through Steam. Make sure you follow the [[Modding:Player Guide/Getting Started#Install SMAPI\|install instructions]] to configure Steam on Windows (no Steam changes needed on Linux or Mac). If the Steam overlay works, the achievements should work too.

	===Do mods work in multiplayer?===		===Do mods work in multiplayer?===

imported>Pathoschild: /* Do mods work in multiplayer? */ rm 'beta'

2018-08-10T02:08:24Z

Do mods work in multiplayer?: rm 'beta'

← Older revision		Revision as of 02:08, 10 August 2018
Line 57:		Line 57:

	===Do mods work in multiplayer?===		===Do mods work in multiplayer?===
	Yep. Stardew Valley 1.3 ~~beta~~ is still new, so check the [[Modding:SMAPI compatibility\|SMAPI compatibility list]] to see if the mod is compatible.		Yep. Stardew Valley 1.3 is still new, so check the [[Modding:SMAPI compatibility\|SMAPI compatibility list]] to see if the mod is compatible.

	How they work depends on the mod. Usually each player can have their own mods, and you can mix modded and vanilla players. Some mods don't work (or work poorly) in multiplayer, or affect other players too. Try checking the mod description for details about multiplayer (often under a 'compatibility' header).		How they work depends on the mod. Usually each player can have their own mods, and you can mix modded and vanilla players. Some mods don't work (or work poorly) in multiplayer, or affect other players too. Try checking the mod description for details about multiplayer (often under a 'compatibility' header).

imported>Pathoschild: /* Can mods corrupt my save? */ update for SMAPI 2.6 release

2018-08-03T16:24:14Z

Can mods corrupt my save?: update for SMAPI 2.6 release

← Older revision		Revision as of 16:24, 3 August 2018
Line 46:		Line 46:

	===Can mods corrupt my save?===		===Can mods corrupt my save?===
	Yes, but it's extremely rare. Only a few mods affect your save file at all. If you avoid those, mods are very unlikely to corrupt your save file. If you~~'re worried, just back up~~ [[#~~Save files~~\|~~your~~ save ~~files~~]] ~~occasionally. That's strongly recommended even if you don't use mods, since save corruption is almost always caused by the game itself~~.		Yes, but it's extremely rare. Only a few mods affect your save file at all. If you avoid those, mods are very unlikely to corrupt your save file. In most cases, you can fix save corruption by [[Saves#Undo the last save\|undoing the last save]].

	~~In most cases~~, ~~you can fix save corruption by~~ [[~~Saves~~#~~Undo the last save~~\|~~undoing the last~~ save]].		If you're worried, just back up [[#Save files\|your save files]] occasionally. That's strongly recommended even if you don't use mods, since save corruption is almost always caused by the game itself. SMAPI also creates a daily backup of your saves automatically; you can retrieve those from the <tt>Mods/SaveBackup</tt> folder.

	~~{{SMAPI upcoming\|2~~.~~6 beta\|content=~~SMAPI ~~comes with~~ a ~~Save Backup mod by default. This creates~~ daily ~~backups~~ of your ~~save files in~~ the <tt>Mods/SaveBackup</tt> folder.}}

	===Can I stop using mods later?===		===Can I stop using mods later?===

imported>Pathoschild: /* Do mods work in multiplayer? */ expand, rm superfluous {{upcoming|1.3}}

2018-06-27T02:20:29Z

Do mods work in multiplayer?: expand, rm superfluous {{upcoming|1.3}}

@@ Line 59: / Line 59: @@
 ===Do mods work in multiplayer?===
-{{upcoming|1.3}}
+Yep. Stardew Valley 1.3 beta is still new, so check the [[Modding:SMAPI compatibility|SMAPI compatibility list]] to see if the mod is compatible.
-Yep. Stardew Valley 1.3 beta is still new, so check [[Modding:SMAPI compatibility]] to see if the mod is compatible. Usually each player can have their own mods (or not use mods at all), but it depends on the mod. Not all mods work well in multiplayer, and some mods may affect other players even if they don't have it installed. Try checking the mod description to see if it says anything about multiplayer (often under a 'compatibility' header). If it's a Content Patcher or XNB mod, see [https://github.com/Pathoschild/StardewMods/tree/develop/ContentPatcher#compatibility how those work in multiplayer] (even if not done through Content Patcher).
+How they work depends on the mod. Usually each player can have their own mods, and you can mix modded and vanilla players. Some mods don't work (or work poorly) in multiplayer, or affect other players too. Try checking the mod description for details about multiplayer (often under a 'compatibility' header).
 ===What is SMAPI?===

imported>Pathoschild: /* Frequent questions */ + What is SMAPI?

2018-06-16T18:17:58Z

Frequent questions: + What is SMAPI?

← Older revision		Revision as of 18:17, 16 June 2018
Line 62:		Line 62:

	Yep. Stardew Valley 1.3 beta is still new, so check [[Modding:SMAPI compatibility]] to see if the mod is compatible. Usually each player can have their own mods (or not use mods at all), but it depends on the mod. Not all mods work well in multiplayer, and some mods may affect other players even if they don't have it installed. Try checking the mod description to see if it says anything about multiplayer (often under a 'compatibility' header). If it's a Content Patcher or XNB mod, see [https://github.com/Pathoschild/StardewMods/tree/develop/ContentPatcher#compatibility how those work in multiplayer] (even if not done through Content Patcher).		Yep. Stardew Valley 1.3 beta is still new, so check [[Modding:SMAPI compatibility]] to see if the mod is compatible. Usually each player can have their own mods (or not use mods at all), but it depends on the mod. Not all mods work well in multiplayer, and some mods may affect other players even if they don't have it installed. Try checking the mod description to see if it says anything about multiplayer (often under a 'compatibility' header). If it's a Content Patcher or XNB mod, see [https://github.com/Pathoschild/StardewMods/tree/develop/ContentPatcher#compatibility how those work in multiplayer] (even if not done through Content Patcher).

			===What is SMAPI?===
			SMAPI is the mod loader for Stardew Valley. It works fine with GOG and Steam achievements, it's compatible with Linux/Mac/Windows, you can uninstall it anytime, and there's a friendly community if you need help. SMAPI is required for most types of Stardew Valley mod.

			SMAPI does a lot for you. For example, it will...

			# Load mods into the game and provide APIs they can use. Many types of mod aren't possible without SMAPI.
			# Rewrite mods for crossplatform compatibility, so you can use almost any mod on Linux/Mac/Windows.
			# Intercept errors. If a mod crashes or causes an error, SMAPI will intercept the error, show the error details in the console window, and in most cases automatically recover the game.
			# Provide update checks. SMAPI automatically alerts you when a new version of a mod is available.
			# Provide compatibility checks. SMAPI automatically detects when a mod is incompatible and disables it before it causes problems.

	===Where are my...===		===Where are my...===

imported>Pathoschild: /* Can mods corrupt my save? */ rm old examples, mention Save Backup

2018-06-16T18:13:13Z

Can mods corrupt my save?: rm old examples, mention Save Backup

← Older revision		Revision as of 18:13, 16 June 2018
Line 46:		Line 46:

	===Can mods corrupt my save?===		===Can mods corrupt my save?===
	Yes, but it's extremely rare. Only a few mods affect your save file at all ~~(including GetDressed, Makeshift Multiplayer, and Save Anywhere)~~. If you avoid those, mods are very unlikely to corrupt your save file. If you're worried, just back up [[#Save files\|your save files]] occasionally. That's strongly recommended even if you don't use mods, since save corruption is almost always caused by the game itself.		Yes, but it's extremely rare. Only a few mods affect your save file at all. If you avoid those, mods are very unlikely to corrupt your save file. If you're worried, just back up [[#Save files\|your save files]] occasionally. That's strongly recommended even if you don't use mods, since save corruption is almost always caused by the game itself.

	In most cases, you can fix save corruption by [[Saves#Undo the last save\|undoing the last save]].		In most cases, you can fix save corruption by [[Saves#Undo the last save\|undoing the last save]].

			{{SMAPI upcoming\|2.6 beta\|content=SMAPI comes with a Save Backup mod by default. This creates daily backups of your save files in the <tt>Mods/SaveBackup</tt> folder.}}

	===Can I stop using mods later?===		===Can I stop using mods later?===

imported>Pathoschild: /* Do mods work in multiplayer? */ + CP or XNB mods

2018-05-02T22:56:24Z

Do mods work in multiplayer?: + CP or XNB mods

← Older revision		Revision as of 22:56, 2 May 2018
Line 59:		Line 59:
	{{upcoming\|1.3}}		{{upcoming\|1.3}}

	Yep. Stardew Valley 1.3 beta is still new, so check [[Modding:SMAPI compatibility]] to see if the mod is compatible. Usually each player can have their own mods (or not use mods at all), but it depends on the mod. Not all mods work well in multiplayer, and some mods may affect other players even if they don't have it installed. Try checking the mod description to see if it says anything about multiplayer (often under a 'compatibility' header).		Yep. Stardew Valley 1.3 beta is still new, so check [[Modding:SMAPI compatibility]] to see if the mod is compatible. Usually each player can have their own mods (or not use mods at all), but it depends on the mod. Not all mods work well in multiplayer, and some mods may affect other players even if they don't have it installed. Try checking the mod description to see if it says anything about multiplayer (often under a 'compatibility' header). If it's a Content Patcher or XNB mod, see [https://github.com/Pathoschild/StardewMods/tree/develop/ContentPatcher#compatibility how those work in multiplayer] (even if not done through Content Patcher).

	===Where are my...===		===Where are my...===

imported>Pathoschild: /* Frequent questions */ + do mods work in multiplayer

2018-05-02T22:03:51Z

Frequent questions: + do mods work in multiplayer

← Older revision		Revision as of 22:03, 2 May 2018
Line 55:		Line 55:
	===Do mods disable Steam achievements?===		===Do mods disable Steam achievements?===
	Steam achievements work fine, as long as you launch SMAPI through Steam. Make sure you follow the [[Modding:Installing SMAPI\|install instructions]] to configure Steam on Windows (no Steam changes needed on Linux or Mac). If the Steam overlay works, the achievements should work too.		Steam achievements work fine, as long as you launch SMAPI through Steam. Make sure you follow the [[Modding:Installing SMAPI\|install instructions]] to configure Steam on Windows (no Steam changes needed on Linux or Mac). If the Steam overlay works, the achievements should work too.

			===Do mods work in multiplayer?===
			{{upcoming\|1.3}}

			Yep. Stardew Valley 1.3 beta is still new, so check [[Modding:SMAPI compatibility]] to see if the mod is compatible. Usually each player can have their own mods (or not use mods at all), but it depends on the mod. Not all mods work well in multiplayer, and some mods may affect other players even if they don't have it installed. Try checking the mod description to see if it says anything about multiplayer (often under a 'compatibility' header).

	===Where are my...===		===Where are my...===