Modding:IDE reference - Revision history

imported>AnotherPillow: add code formatting for bits that were intended to have it but used the wrong characters

2026-05-03T08:37:34Z

add code formatting for bits that were intended to have it but used the wrong characters

← Older revision		Revision as of 08:37, 3 May 2026
Line 141:		Line 141:
	# As of August 31, 2024, Visual Studio is now retired for Mac. You may be using Visual Studio Code to edit your game files now. As of right now, the built-in Nuget Package Manager with the C# Dev Kit does not work with SDK 6.0. You can download another extension called "Nuget Package Manager GUI" by aliasadidev and the flow will be similar to the process below for Visual Studio 2019. If you do not want to download this, you can use the Terminal below.		# As of August 31, 2024, Visual Studio is now retired for Mac. You may be using Visual Studio Code to edit your game files now. As of right now, the built-in Nuget Package Manager with the C# Dev Kit does not work with SDK 6.0. You can download another extension called "Nuget Package Manager GUI" by aliasadidev and the flow will be similar to the process below for Visual Studio 2019. If you do not want to download this, you can use the Terminal below.
	# With your Project open, open a new Terminal in Visual Studio Code.		# With your Project open, open a new Terminal in Visual Studio Code.
	# Type in ~~```~~dotnet add <YOUR_MOD_NAME_HERE> package Pathoschild.Stardew.ModBuildConfig~~```~~ to the terminal and press enter. Change '<YOUR_MOD_NAME_HERE>' to the name of your Mod.		# Type in <code>dotnet add <YOUR_MOD_NAME_HERE> package Pathoschild.Stardew.ModBuildConfig</code> to the terminal and press enter. Change <code><YOUR_MOD_NAME_HERE></code> to the name of your Mod.
	# You should get a bunch of log messages like in the picture below.		# You should get a bunch of log messages like in the picture below.
	::[[File:Nuget package cli.png\|thumb\|left\|600px\|adding StardewModdingApi nuget package to your project]]{{Clear}}		::[[File:Nuget package cli.png\|thumb\|left\|600px\|adding StardewModdingApi nuget package to your project]]{{Clear}}

imported>StoneFruitSnatcher: /* In Visual Studio Code */

2025-05-09T12:59:43Z

In Visual Studio Code

← Older revision		Revision as of 12:59, 9 May 2025
Line 141:		Line 141:
	# As of August 31, 2024, Visual Studio is now retired for Mac. You may be using Visual Studio Code to edit your game files now. As of right now, the built-in Nuget Package Manager with the C# Dev Kit does not work with SDK 6.0. You can download another extension called "Nuget Package Manager GUI" by aliasadidev and the flow will be similar to the process below for Visual Studio 2019. If you do not want to download this, you can use the Terminal below.		# As of August 31, 2024, Visual Studio is now retired for Mac. You may be using Visual Studio Code to edit your game files now. As of right now, the built-in Nuget Package Manager with the C# Dev Kit does not work with SDK 6.0. You can download another extension called "Nuget Package Manager GUI" by aliasadidev and the flow will be similar to the process below for Visual Studio 2019. If you do not want to download this, you can use the Terminal below.
	# With your Project open, open a new Terminal in Visual Studio Code.		# With your Project open, open a new Terminal in Visual Studio Code.
	# Type in ```dotnet add ~~StardewValleyMod25~~ package Pathoschild.Stardew.ModBuildConfig``` to the terminal and press enter.		# Type in ```dotnet add <YOUR_MOD_NAME_HERE> package Pathoschild.Stardew.ModBuildConfig``` to the terminal and press enter. Change '<YOUR_MOD_NAME_HERE>' to the name of your Mod.
	# You should get a bunch of log messages like in the picture below.		# You should get a bunch of log messages like in the picture below.
	::[[File:Nuget package cli.png\|thumb\|left\|600px\|adding StardewModdingApi nuget package to your project]]{{Clear}}		::[[File:Nuget package cli.png\|thumb\|left\|600px\|adding StardewModdingApi nuget package to your project]]{{Clear}}

imported>VulpesLucida: /* In Windows Visual Studio 2019/2022 */ + <code> tags

2025-03-13T09:38:36Z

In Windows Visual Studio 2019/2022: + <code> tags

← Older revision		Revision as of 09:38, 13 March 2025
Line 71:		Line 71:

	===In Windows Visual Studio 2019/2022===		===In Windows Visual Studio 2019/2022===
	'''NOTE: Visual Studio 2017 MAY no longer be compatible with creating mods!''' If you followed [[Modding:Modder_Guide/Get_Started]] and receive errors, from the code that page instructed be copy and pasted, with regards to helper. Events in the Entry(IModhelper helper) method and ButtonPressedEventArgs from the Entry(IModHelper helper) method, try the project-creation and code-copy/paste process again with Visual Studio 2019/2022 instead.		'''NOTE: Visual Studio 2017 MAY no longer be compatible with creating mods!''' If you followed [[Modding:Modder_Guide/Get_Started]] and receive errors, from the code that page instructed be copy and pasted, with regards to <code>helper.Events</code> in the <code>Entry(IModhelper helper)</code> method and <code>ButtonPressedEventArgs</code> from the <code>Entry(IModHelper helper)</code> method, try the project-creation and code-copy/paste process again with Visual Studio 2019/2022 instead.

imported>VulpesLucida: /* Windows/Mac/Linux (Rider 2024.x.x) */

2025-03-10T02:55:26Z

Windows/Mac/Linux (Rider 2024.x.x)

← Older revision		Revision as of 02:55, 10 March 2025
Line 41:		Line 41:
	# Select ''SDK 6.0'' so you can create a ''.NET 6.0'' project.<br />[[File:Rider IDE Guide - 4.png\|800px\|Select "SDK 6.0".]]		# Select ''SDK 6.0'' so you can create a ''.NET 6.0'' project.<br />[[File:Rider IDE Guide - 4.png\|800px\|Select "SDK 6.0".]]
	# Select ''net6.0'' in the dropdown to the right of ''Target framework''.<br />[[File:Rider IDE Guide - 6.png\|800px\|Select "net6.0" in the dropdown.]]		# Select ''net6.0'' in the dropdown to the right of ''Target framework''.<br />[[File:Rider IDE Guide - 6.png\|800px\|Select "net6.0" in the dropdown.]]
	# Click the ''Create'' button.<br />[[File:Rider IDE Guide - 7.png\|800px]Click the "Create" button.]]		# Click the ''Create'' button.<br />[[File:Rider IDE Guide - 7.png\|800px\|Click the "Create" button.]]


	===Linux (MonoDevelop)===		===Linux (MonoDevelop)===

imported>DecidedlyHuman: Add instructions for creating a .NET 6 class library project in Rider.

2025-02-11T18:10:54Z

Add instructions for creating a .NET 6 class library project in Rider.

@@ Line 33: / Line 33: @@
 # In the ''configure your new project'' window: <ol><li>Enter a descriptive mod name. By convention, the name should be one word with mixed caps (like "PineapplesEverywhere").</li><li>Make sure "Place solution and project in the same directory" is ''not'' checked.</li><li>Click "Create" to to create the project.</li></ol>[[File:Modding - IDE reference - create project (Visual Studio 3).png|800px]]
 # Next, select NET 6.0 and click "Create" to create the project. For VS 2022, this will be on the next page. <br />[[File:Screenshot 2021-12-16 140835.png]]
 ===Linux (MonoDevelop)===

imported>Margotbean: /* Add a NuGet package */ fix bad formatting

2025-01-04T17:05:03Z

Add a NuGet package: fix bad formatting

← Older revision		Revision as of 17:05, 4 January 2025
Line 130:		Line 130:
	<span id="add-nuget"></span>		<span id="add-nuget"></span>
	===In Visual Studio Code===		===In Visual Studio Code===
	# As of August 31, 2024, Visual Studio is now retired for Mac. You may be using Visual Studio Code to edit your game files now. As of right now, the built-in Nuget Package Manager with the C# Dev Kit does not work with SDK 6.0. You can download another extension called "Nuget Package Manager GUI" by aliasadidev and the flow will be similar to the process below for Visual Studio 2019. If you do not want to download this, you can use the Terminal ~~(like a boss)~~ below.		# As of August 31, 2024, Visual Studio is now retired for Mac. You may be using Visual Studio Code to edit your game files now. As of right now, the built-in Nuget Package Manager with the C# Dev Kit does not work with SDK 6.0. You can download another extension called "Nuget Package Manager GUI" by aliasadidev and the flow will be similar to the process below for Visual Studio 2019. If you do not want to download this, you can use the Terminal below.
	# With your Project open, open a new Terminal in Visual Studio Code.		# With your Project open, open a new Terminal in Visual Studio Code.
	# Type in ```dotnet add StardewValleyMod25 package Pathoschild.Stardew.ModBuildConfig``` to the terminal and press enter. [[File:Nuget package cli.png\|600px\|adding StardewModdingApi nuget package to your project]]		# Type in ```dotnet add StardewValleyMod25 package Pathoschild.Stardew.ModBuildConfig``` to the terminal and press enter.
	~~# You should get a bunch of log messages like in the picture above.~~		# You should get a bunch of log messages like in the picture below.
			::[[File:Nuget package cli.png\|thumb\|left\|600px\|adding StardewModdingApi nuget package to your project]]{{Clear}}

	===In Visual Studio 2019/2022===		===In Visual Studio 2019/2022===

imported>Margotbean: remove odd text

2025-01-04T17:00:58Z

remove odd text

← Older revision		Revision as of 17:00, 4 January 2025
Line 1:		Line 1:
	~~<nowiki>Insert non-formatted text here</nowiki>~~←[[Modding:Index\|Index]]		←[[Modding:Index\|Index]]

	This page is a quick reference for how to use Visual Studio 2017 or MonoDevelop/Visual Studio for Mac when creating or editing a SMAPI mod. See [[Modding:Modder Guide/Get Started\|Modding:Modder Guide]] for the main guide.		This page is a quick reference for how to use Visual Studio 2017 or MonoDevelop/Visual Studio for Mac when creating or editing a SMAPI mod. See [[Modding:Modder Guide/Get Started\|Modding:Modder Guide]] for the main guide.

imported>StoneFruitSnatcher: adding option to add a nuget package through the command line for visual studio code users.

2025-01-04T15:45:26Z

adding option to add a nuget package through the command line for visual studio code users.

← Older revision		Revision as of 15:45, 4 January 2025
Line 1:		Line 1:
	←[[Modding:Index\|Index]]		<nowiki>Insert non-formatted text here</nowiki>←[[Modding:Index\|Index]]

	This page is a quick reference for how to use Visual Studio 2017 or MonoDevelop/Visual Studio for Mac when creating or editing a SMAPI mod. See [[Modding:Modder Guide/Get Started\|Modding:Modder Guide]] for the main guide.		This page is a quick reference for how to use Visual Studio 2017 or MonoDevelop/Visual Studio for Mac when creating or editing a SMAPI mod. See [[Modding:Modder Guide/Get Started\|Modding:Modder Guide]] for the main guide.
Line 129:		Line 129:
	==Add a NuGet package==		==Add a NuGet package==
	<span id="add-nuget"></span>		<span id="add-nuget"></span>
			===In Visual Studio Code===
			# As of August 31, 2024, Visual Studio is now retired for Mac. You may be using Visual Studio Code to edit your game files now. As of right now, the built-in Nuget Package Manager with the C# Dev Kit does not work with SDK 6.0. You can download another extension called "Nuget Package Manager GUI" by aliasadidev and the flow will be similar to the process below for Visual Studio 2019. If you do not want to download this, you can use the Terminal (like a boss) below.
			# With your Project open, open a new Terminal in Visual Studio Code.
			# Type in ```dotnet add StardewValleyMod25 package Pathoschild.Stardew.ModBuildConfig``` to the terminal and press enter. [[File:Nuget package cli.png\|600px\|adding StardewModdingApi nuget package to your project]]
			# You should get a bunch of log messages like in the picture above.

	===In Visual Studio 2019/2022===		===In Visual Studio 2019/2022===

imported>Margotbean: Images can take hours to update, please read Help:Editing

2024-06-15T09:52:04Z

Images can take hours to update, please read Help:Editing

← Older revision		Revision as of 09:52, 15 June 2024
Line 32:		Line 32:
	# Filter by "C#" and "Library", then choose ''Class Library'' and click ''Next''. Make sure you '''don't''' choose ''Class Library (.NET Framework)'' which won't work.<br />[[File:Modding - IDE reference - create project (Visual Studio 2).png\| 589px]]		# Filter by "C#" and "Library", then choose ''Class Library'' and click ''Next''. Make sure you '''don't''' choose ''Class Library (.NET Framework)'' which won't work.<br />[[File:Modding - IDE reference - create project (Visual Studio 2).png\| 589px]]
	# In the ''configure your new project'' window: <ol><li>Enter a descriptive mod name. By convention, the name should be one word with mixed caps (like "PineapplesEverywhere").</li><li>Make sure "Place solution and project in the same directory" is ''not'' checked.</li><li>Click "Create" to to create the project.</li></ol>[[File:Modding - IDE reference - create project (Visual Studio 3).png\|800px]]		# In the ''configure your new project'' window: <ol><li>Enter a descriptive mod name. By convention, the name should be one word with mixed caps (like "PineapplesEverywhere").</li><li>Make sure "Place solution and project in the same directory" is ''not'' checked.</li><li>Click "Create" to to create the project.</li></ol>[[File:Modding - IDE reference - create project (Visual Studio 3).png\|800px]]
	# Next, select NET 6.0 and click "Create" to create the project. For VS 2022, this will be on the next page. <br />[[File:~~SMAPI_New_Project_Framework_Target~~.png]]		# Next, select NET 6.0 and click "Create" to create the project. For VS 2022, this will be on the next page. <br />[[File:Screenshot 2021-12-16 140835.png]]

	===Linux (MonoDevelop)===		===Linux (MonoDevelop)===

imported>Falseroku: Change references from NET 5 to NET 6, primarily for Windows. Remove external link to NET 6 download preventing changes

2024-06-15T03:05:24Z

Change references from NET 5 to NET 6, primarily for Windows. Remove external link to NET 6 download preventing changes

← Older revision		Revision as of 03:05, 15 June 2024
Line 32:		Line 32:
	# Filter by "C#" and "Library", then choose ''Class Library'' and click ''Next''. Make sure you '''don't''' choose ''Class Library (.NET Framework)'' which won't work.<br />[[File:Modding - IDE reference - create project (Visual Studio 2).png\| 589px]]		# Filter by "C#" and "Library", then choose ''Class Library'' and click ''Next''. Make sure you '''don't''' choose ''Class Library (.NET Framework)'' which won't work.<br />[[File:Modding - IDE reference - create project (Visual Studio 2).png\| 589px]]
	# In the ''configure your new project'' window: <ol><li>Enter a descriptive mod name. By convention, the name should be one word with mixed caps (like "PineapplesEverywhere").</li><li>Make sure "Place solution and project in the same directory" is ''not'' checked.</li><li>Click "Create" to to create the project.</li></ol>[[File:Modding - IDE reference - create project (Visual Studio 3).png\|800px]]		# In the ''configure your new project'' window: <ol><li>Enter a descriptive mod name. By convention, the name should be one word with mixed caps (like "PineapplesEverywhere").</li><li>Make sure "Place solution and project in the same directory" is ''not'' checked.</li><li>Click "Create" to to create the project.</li></ol>[[File:Modding - IDE reference - create project (Visual Studio 3).png\|800px]]
	# Next, select NET 6.0 and click "Create" to create the project. For VS 2022, this will be on the next page. <br />[[File:~~Screenshot 2021-12-16 140835~~.png]]		# Next, select NET 6.0 and click "Create" to create the project. For VS 2022, this will be on the next page. <br />[[File:SMAPI_New_Project_Framework_Target.png]]

	===Linux (MonoDevelop)===		===Linux (MonoDevelop)===
Line 43:		Line 43:
	===MacOS (Visual Studio 2019 for Mac)===		===MacOS (Visual Studio 2019 for Mac)===

	# Install the .NET 5.0 SDK if you haven't already (~~link:~~ [~~https~~:/~~/dotnet.microsoft.com/en-us/download/dotnet/5.0~~]).<br />[[File:1a NET website.png\|600px]]		# Install the .NET 6.0 SDK if you haven't already (check [[Modding:Modder_Guide/Get_Started#Requirements\|here]] for your system).<br />[[File:1a NET website.png\|600px]]
	# Open Visual Studio for Mac.		# Open Visual Studio for Mac.
	# Click ''File » New Solution'' from the menu bar:<br />[[File:VS Mac 1 newsolution.png\|600px]]		# Click ''File » New Solution'' from the menu bar:<br />[[File:VS Mac 1 newsolution.png\|600px]]
	# Select the correct type of class library:<br />[[File:VS Mac 2 createlibrary.png\|600px]]		# Select the correct type of class library:<br />[[File:VS Mac 2 createlibrary.png\|600px]]
	# Set it to target '''.NET 5.0.''':<br />[[File:VS Mac 3 setframework.png\|600px]]		# Set it to target '''.NET 6.0.''':<br />[[File:VS Mac 3 setframework.png\|600px]]
	# Enter a descriptive mod name for the project. By convention, the name should be one word with mixed caps (like "PineapplesEverywhere"):<br />[[File:VS Mac 4 nameproject.png\|600px]]		# Enter a descriptive mod name for the project. By convention, the name should be one word with mixed caps (like "PineapplesEverywhere"):<br />[[File:VS Mac 4 nameproject.png\|600px]]

Line 59:		Line 59:
	==Set the target framework==		==Set the target framework==
	<span id="set-target-framework"></span>		<span id="set-target-framework"></span>
	The 'target framework' is the version of .NET your code uses, which affects the version needed to run your mod. The recommended target framework is .NET 5.0, which is the version SMAPI itself targets. '''Please find the subsection below for your OS''' (Windows/Mac). ~~'''You cannot use .NET 6.0'''.~~		The 'target framework' is the version of .NET your code uses, which affects the version needed to run your mod. The recommended target framework is .NET 6.0, which is the version SMAPI itself targets. '''Please find the subsection below for your OS''' (Windows/Mac).

	~~(yes, we know .NET 5.0 is past EOL.)~~

	* '''''.NET 6.0 is actually the correct framework here, this page is just outdated.'''''

	===In Windows Visual Studio 2019/2022===		===In Windows Visual Studio 2019/2022===
Line 71:		Line 67:
	# Open the Solution Explorer pane. If it's not visible, click ''View » Solution Explorer'' from the menu:<br />[[File:Modding - IDE reference - show solution pane (Visual Studio).png]]		# Open the Solution Explorer pane. If it's not visible, click ''View » Solution Explorer'' from the menu:<br />[[File:Modding - IDE reference - show solution pane (Visual Studio).png]]
	# From the Solution Explorer, right-click on the project and choose ''Properties'':<br />[[File:Modding - IDE reference - change target framework (Visual Studio 1).png]]		# From the Solution Explorer, right-click on the project and choose ''Properties'':<br />[[File:Modding - IDE reference - change target framework (Visual Studio 1).png]]
	# On the ''Application'' tab, change the ''Target Framework'' dropdown to ''.NET 5.0'':<br />[[File:Modding - IDE reference - change target framework (Visual Studio 2).png\|800px]]		# On the ''Application'' tab, change the ''Target Framework'' dropdown to ''.NET 6.0'':<br />[[File:Modding - IDE reference - change target framework (Visual Studio 2).png\|800px]]
	# A dialogue may appear asking you to confirm the change. Click 'Yes' to confirm:<br />[[File:Modding - IDE reference - change target framework (Visual Studio 3).png]]		# A dialogue may appear asking you to confirm the change. Click 'Yes' to confirm:<br />[[File:Modding - IDE reference - change target framework (Visual Studio 3).png]]

	===In Visual Studio 2019 for Mac===		===In Visual Studio 2019 for Mac===

	If you followed the instructions above to set up your project, your framework should already be set to .NET 5.0. However, if you picked the wrong class library or you just want to check, you can follow these steps to look at the .csproj file, which is basically equivalent to setting it manually. (If you're checking that it worked, don't replace the .csproj, just check it refers to .NET 5.0.)		If you followed the instructions above to set up your project, your framework should already be set to .NET 6.0. However, if you picked the wrong class library or you just want to check, you can follow these steps to look at the .csproj file, which is basically equivalent to setting it manually. (If you're checking that it worked, don't replace the .csproj, just check it refers to .NET 6.0.)

	Unfortunately there doesn't appear to be a way to change the target framework using the GUI. However, it is very easy to follow the 1.5.5 migration guide steps:		Unfortunately there doesn't appear to be a way to change the target framework using the GUI. However, it is very easy to follow the 1.5.5 migration guide steps:
Line 87:		Line 83:
	<RootNamespace>EXAMPLE_MOD_NAME</RootNamespace>		<RootNamespace>EXAMPLE_MOD_NAME</RootNamespace>
	<Version>1.0.0</Version>		<Version>1.0.0</Version>
	<TargetFramework>~~net5~~.0</TargetFramework>		<TargetFramework>net6.0</TargetFramework>
	</PropertyGroup>		</PropertyGroup>

Line 103:		Line 99:
	# Open the Solution pad. If it's not visible, click ''View » Pads » Solution'' from the menu:<br />[[File:Modding - IDE reference - show solution pane (MonoDevelop).png]]		# Open the Solution pad. If it's not visible, click ''View » Pads » Solution'' from the menu:<br />[[File:Modding - IDE reference - show solution pane (MonoDevelop).png]]
	# From the Solution pad, right-click on the project and choose ''Options'':<br />[[File:Modding - IDE reference - change target framework (MonoDevelop 1).png]]		# From the Solution pad, right-click on the project and choose ''Options'':<br />[[File:Modding - IDE reference - change target framework (MonoDevelop 1).png]]
	# On the ''Build » General'' tab, change the ''Target Framework'' dropdown to ''Mono / .NET 4.5'':<br />[[File:Modding - IDE reference - change target framework (MonoDevelop 2).png]]		# On the ''Build » General'' tab, change the ''Target Framework'' dropdown to ''Mono / .NET 6.0'':<br />[[File:Modding - IDE reference - change target framework (MonoDevelop 2).png]]

	==Add a file==		==Add a file==