Modding:Modder Guide/Get Started - Revision history

imported>Margotbean: add link blocked by spam filter (credit to User:Mushymato)

2025-05-12T13:29:29Z

add link blocked by spam filter (credit to User:Mushymato)

← Older revision		Revision as of 13:29, 12 May 2025
Line 263:		Line 263:
	:## If you're using Avalonia ILSpy, make sure to add the <samp>.csproj</samp> file extension to the filename in the save dialog, like so: <samp>Stardew-Valley.csproj</samp> (Otherwise, the project won't decompile properly.)		:## If you're using Avalonia ILSpy, make sure to add the <samp>.csproj</samp> file extension to the filename in the save dialog, like so: <samp>Stardew-Valley.csproj</samp> (Otherwise, the project won't decompile properly.)

	You can also use ilspycmd to decompile from the command line:		You can also use [https://www.nuget.org/packages/ilspycmd ilspycmd] to decompile from the command line:
	:# Install ilspycmd		:# Install ilspycmd
	:## <code>dotnet tool install --global ilspycmd</code>		:## <code>dotnet tool install --global ilspycmd</code>

imported>Mushymato: Add ilspycmd instructions

2025-05-11T21:00:49Z

Add ilspycmd instructions

← Older revision		Revision as of 21:00, 11 May 2025
Line 262:		Line 262:
	:# Right-click on ''Stardew Valley'' and choose ''Save Code'' to create a decompiled project you can open in Visual Studio.		:# Right-click on ''Stardew Valley'' and choose ''Save Code'' to create a decompiled project you can open in Visual Studio.
	:## If you're using Avalonia ILSpy, make sure to add the <samp>.csproj</samp> file extension to the filename in the save dialog, like so: <samp>Stardew-Valley.csproj</samp> (Otherwise, the project won't decompile properly.)		:## If you're using Avalonia ILSpy, make sure to add the <samp>.csproj</samp> file extension to the filename in the save dialog, like so: <samp>Stardew-Valley.csproj</samp> (Otherwise, the project won't decompile properly.)

			You can also use ilspycmd to decompile from the command line:
			:# Install ilspycmd
			:## <code>dotnet tool install --global ilspycmd</code>
			:# Run ilspycmd (using your local game paths). This will decompile both the main dll and the game data dll to one project.
			:## <code>ilspycmd -p --nested-directories -r <game path> -o <output folder> "<game path>/Stardew Valley.dll" "<game path>/StardewValley.GameData.dll"</code>.

	To unpack the XNB data/image/map files, see [[Modding:Editing XNB files]].		To unpack the XNB data/image/map files, see [[Modding:Editing XNB files]].

imported>398utubzyt: Fix incorrect usage of backslash escape sequences in C# strings

2025-04-15T15:58:42Z

Fix incorrect usage of backslash escape sequences in C# strings

← Older revision		Revision as of 15:58, 15 April 2025
Line 214:		Line 214:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	// ✘ Don't do this! It won't work on SteamDeck/Linux/Mac.		// ✘ Don't do this! It won't work on SteamDeck/Linux/Mac.
	string path = this.Helper.DirectoryPath + "\assets\image.png";		string path = this.Helper.DirectoryPath + "\\assets\\image.png";

	// ✓ This is OK		// ✓ This is OK
Line 244:		Line 244:
	// ✓ This is OK		// ✓ This is OK
	helper.Content.Load<Texture2D>("Characters/Abigail");		helper.Content.Load<Texture2D>("Characters/Abigail");
	helper.Content.Load<Texture2D>(@"Characters\Abigail");		helper.Content.Load<Texture2D>(@"Characters\\Abigail");
	</syntaxhighlight>		</syntaxhighlight>
	</li>		</li>

imported>Atravita: /* Requirements */ Rider is free now, monodevelop is dead, and mac vs is dead

2025-02-11T03:16:56Z

Requirements: Rider is free now, monodevelop is dead, and mac vs is dead

← Older revision		Revision as of 03:16, 11 February 2025
Line 54:		Line 54:
	# Install the [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 .NET 6 SDK].<br />'' You need .NET 6 because it's the version used by the game. On Windows, you probably have x64. on macOS, "x64" is for Intel chips and "Arm64" is for Apple Silicon chips.''		# Install the [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 .NET 6 SDK].<br />'' You need .NET 6 because it's the version used by the game. On Windows, you probably have x64. on macOS, "x64" is for Intel chips and "Arm64" is for Apple Silicon chips.''
	# Install the IDE (''integrated development environment''), which you'll use to edit and compile your mod code:		# Install the IDE (''integrated development environment''), which you'll use to edit and compile your mod code:
	#* Windows: [https://visualstudio.microsoft.com/vs/community/ Visual Studio Community] (free) or [https://www.jetbrains.com/rider/ JetBrains Rider] (~~paid~~).		#* Windows: [https://visualstudio.microsoft.com/vs/community/ Visual Studio Community] (free) or [https://www.jetbrains.com/rider/ JetBrains Rider] (free).
	#* Linux~~: [https:~~/~~/code.visualstudio.com/ Visual Studio Code] (free), [http~~:~~//www.monodevelop.com/ MonoDevelop] (free), or~~ [https://www.jetbrains.com/rider/ JetBrains Rider] (~~paid~~).		#* Linux/macOS: [https://www.jetbrains.com/rider/ JetBrains Rider] (free) or [https://code.visualstudio.com/ Visual Studio Code] (free).
	~~#* macOS:~~ [https://code.visualstudio.com/ Visual Studio Code] (free~~), or [https://visualstudio.microsoft.com/vs/mac/ Visual Studio for Mac] (retiring 31 Aug 2024), or [https://www.jetbrains.com/rider/ JetBrains Rider] (paid~~).

	If you're not familiar with Visual Studio (on Windows~~/Mac) or MonoDevelop (on Linux~~), [[Modding:IDE reference]] explains how to do the important stuff you need for this guide.		If you're not familiar with Visual Studio (on Windows), [[Modding:IDE reference]] explains how to do the important stuff you need for this guide.

	==Create a basic mod==		==Create a basic mod==

imported>Quicksilver at 23:38, 3 December 2024

2024-12-03T23:38:36Z

← Older revision		Revision as of 23:38, 3 December 2024
Line 277:		Line 277:
	[[fr:Modding:Guide du Moddeur/Commencer]]		[[fr:Modding:Guide du Moddeur/Commencer]]
	[[pt:Modificações:Guia do Modder/Começando]]		[[pt:Modificações:Guia do Modder/Começando]]
	[[ru:Модификации:~~Моддер гайд~~/Приступая к работе]]		[[ru:Модификации:Руководство мододела/Приступая к работе]]
	[[tr:Modlama:Mod Rehberi/Başlangıç Kılavuzu]]		[[tr:Modlama:Mod Rehberi/Başlangıç Kılavuzu]]
	[[zh:模组:创建 SMAPI 模组]]		[[zh:模组:创建 SMAPI 模组]]

imported>Pathoschild: clarify intro (you do need C# for some mods)

2024-08-18T14:56:09Z

clarify intro (you do need C# for some mods)

← Older revision		Revision as of 14:56, 18 August 2024
Line 1:		Line 1:
	{{../header}}		{{../header}}

	'''If you're making a mod for the first time,''' see [[Modding:Index#Creating mods]] for a short description of the differences between C# mods and content packs. '''You ~~don't need to use~~ C# ~~to make mods~~.'''		'''If you're making a mod for the first time,''' see [[Modding:Index#Creating mods]] for a short description of the differences between C# mods and content packs. '''You can create many mods without C#.'''

	Do you want to create '''SMAPI mods for Stardew Valley with C#?''' This guide is for you!		Do you want to create '''SMAPI mods for Stardew Valley with C#?''' This guide is for you!

imported>Hackswell: /* How do I make my mod work crossplatform? */

2024-07-30T14:23:30Z

How do I make my mod work crossplatform?

← Older revision		Revision as of 14:23, 30 July 2024
Line 214:		Line 214:

	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	// ✘ Don't do this! It won't work on Linux/Mac.		// ✘ Don't do this! It won't work on SteamDeck/Linux/Mac.
	string path = this.Helper.DirectoryPath + "\assets\image.png";		string path = this.Helper.DirectoryPath + "\assets\image.png";

imported>Peaw at 06:05, 17 July 2024

2024-07-17T06:05:03Z

← Older revision		Revision as of 06:05, 17 July 2024
Line 278:		Line 278:
	[[pt:Modificações:Guia do Modder/Começando]]		[[pt:Modificações:Guia do Modder/Começando]]
	[[ru:Модификации:Моддер гайд/Приступая к работе]]		[[ru:Модификации:Моддер гайд/Приступая к работе]]
			[[tr:Modlama:Mod Rehberi/Başlangıç Kılavuzu]]
	[[zh:模组:创建 SMAPI 模组]]		[[zh:模组:创建 SMAPI 模组]]

imported>Margotbean: Text replacement - "colour" to "color"

2024-07-09T20:57:45Z

Text replacement - "colour" to "color"

← Older revision		Revision as of 20:57, 9 July 2024
Line 177:		Line 177:
	The default text-colors in the console may be set in a way that makes them unreadable. To change text color:		The default text-colors in the console may be set in a way that makes them unreadable. To change text color:

	*'''Steam''': Open Steam and right-click the game in your library. Click "Browse local files" under "Manage" and then open the <samp>config.json</samp> file in your "/Stardew Valley/smapi-internal/" folder, search for "ConsoleColors" and then edit the "Trace" and "Debug" ~~colours~~ so that they become visible within your console.		*'''Steam''': Open Steam and right-click the game in your library. Click "Browse local files" under "Manage" and then open the <samp>config.json</samp> file in your "/Stardew Valley/smapi-internal/" folder, search for "ConsoleColors" and then edit the "Trace" and "Debug" colors so that they become visible within your console.

	*'''Linux''': The default path on linux is <samp>~/.local/share/Steam/steamapps/common/Stardew Valley/smapi-internal/config.json</samp>, unless you have installed your game on a different drive/outside the standard steam library folder.		*'''Linux''': The default path on linux is <samp>~/.local/share/Steam/steamapps/common/Stardew Valley/smapi-internal/config.json</samp>, unless you have installed your game on a different drive/outside the standard steam library folder.

imported>Pathoschild: /* Requirements */ rework flow for clarity, add info for common questions re .NET 6 SDK

2024-06-23T19:12:22Z

Requirements: rework flow for clarity, add info for common questions re .NET 6 SDK

← Older revision		Revision as of 19:12, 23 June 2024
Line 49:		Line 49:
	===Requirements===		===Requirements===
	Before you start:		Before you start:
	# Read the [[Modding:Player Guide/Getting Started\|~~Player Guide~~]]. The rest of this guide assumes you're already familiar with using mods.		# Read the [[Modding:Player Guide/Getting Started\|player guide]]. The rest of this guide assumes you're already familiar with using mods.
	# Install Stardew Valley.		# Install Stardew Valley.
	# Install [[Modding:Player Guide/Getting Started#Install SMAPI\|SMAPI]].		# Install [[Modding:Player Guide/Getting Started#Install SMAPI\|SMAPI]].
	# Install the ~~IDE (''integrated development environment'').~~		# Install the [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 .NET 6 SDK].<br />'' You need .NET 6 because it's the version used by the game. On Windows, you probably have x64. on macOS, "x64" is for Intel chips and "Arm64" is for Apple Silicon chips.''
			# Install the IDE (''integrated development environment''), which you'll use to edit and compile your mod code:
	~~{\| class="wikitable"~~		#* Windows: [https://visualstudio.microsoft.com/vs/community/ Visual Studio Community] (free) or [https://www.jetbrains.com/rider/ JetBrains Rider] (paid).
	\|-		#* Linux: [https://code.visualstudio.com/ Visual Studio Code] (free), [http://www.monodevelop.com/ MonoDevelop] (free), or [https://www.jetbrains.com/rider/ JetBrains Rider] (paid).
	~~! Operating system (OS)~~		#* macOS: [https://code.visualstudio.com/ Visual Studio Code] (free), or [https://visualstudio.microsoft.com/vs/mac/ Visual Studio for Mac] (retiring 31 Aug 2024), or [https://www.jetbrains.com/rider/ JetBrains Rider] (paid).
	~~! IDE (integrated development environment)~~
	~~! .NET SDK~~
	\|-
	~~\| Windows x64 \|\| [https://visualstudio.microsoft.com/vs/community/ Visual Studio Community (Free)]. [https://www.jetbrains.com/rider/ JetBrains Rider (Paid)] \|\|~~ [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 .NET 6.0 Windows x64]
	\|-
	\| Windows ~~Arm64 \|\|~~ [https://visualstudio.microsoft.com/vs/community/ Visual Studio Community (~~Free~~)]. [https://www.jetbrains.com/rider/ JetBrains Rider (~~Paid~~)~~] \|\| [https://dotnet.microsoft~~.~~com/en-us/download/dotnet/6.0 .NET 6.0 Windows Arm64]~~
	\|-
	~~\| macOS (Intel) \|\|~~ [https://code.visualstudio.com/ Visual Studio Code (~~Free~~)]. [~~https~~://~~visualstudio~~.~~microsoft~~.com/~~vs/mac/ Visual Studio for Mac~~ (~~Retiring on Aug 31~~, ~~2024)].~~ [https://www.jetbrains.com/rider/ JetBrains Rider (~~Paid~~)~~] \|\| [https://dotnet~~.~~microsoft.com/en-us/download/dotnet/6.0 .NET 6.0 macOS x64]~~
	\|-
	\| macOS ~~(Apple Silicon) \|\|~~ [https://code.visualstudio.com/ Visual Studio Code (~~Free~~)]. [https://visualstudio.microsoft.com/vs/mac/ Visual Studio for Mac (~~Retiring on~~ Aug ~~31,~~ 2024)]. [https://www.jetbrains.com/rider/ JetBrains Rider ~~(Paid)~~] ~~\|\| [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 .NET 6.0 macOS Arm64]~~
	\|-
	~~\| Linux \|\| [https://code.visualstudio.com/ Visual Studio Code (Free)]. [http://www.monodevelop.com/ MonoDevelop~~ (~~Free~~)]. ~~[https://www.jetbrains.com/rider/ JetBrains Rider (Paid)] \|\| [https://dotnet.microsoft.com/en-us/download/dotnet/6.0 .NET 6.0 Linux]~~
	\|}

	If you're not familiar with Visual Studio (on Windows/Mac) or MonoDevelop (on Linux), [[Modding:IDE reference]] explains how to do the important stuff you need for this guide.		If you're not familiar with Visual Studio (on Windows/Mac) or MonoDevelop (on Linux), [[Modding:IDE reference]] explains how to do the important stuff you need for this guide.