Modding:Modder Guide/Tutorial Mod - Revision history

imported>Pathoschild: update redirect

2018-09-03T15:34:54Z

update redirect

← Older revision		Revision as of 15:34, 3 September 2018
Line 1:		Line 1:
	#REDIRECT [[Modding:Modder Guide]]		#REDIRECT [[Modding:Modder Guide/Get Started]]

imported>Pathoschild: merged into Modding:Modder Guide

2018-09-03T14:57:37Z

merged into Modding:Modder Guide

Show changes

imported>Nobbele: Fixed typo, it should be "Helper" not "helper

2018-08-10T17:32:04Z

Fixed typo, it should be "Helper" not "helper

← Older revision		Revision as of 17:32, 10 August 2018
Line 136:		Line 136:
	<source lang="c#">		<source lang="c#">
	// ✘ Don't do this! It will crash on Linux/Mac.		// ✘ Don't do this! It will crash on Linux/Mac.
	string path = ~~helper~~.DirectoryPath + "\assets\asset.xnb";		string path = Helper.DirectoryPath + "\assets\asset.xnb";

	// ✓ This is OK		// ✓ This is OK
	string path = Path.Combine(~~helper~~.DirectoryPath, "assets", "asset.xnb");		string path = Path.Combine(Helper.DirectoryPath, "assets", "asset.xnb");
	</source></li>		</source></li>

	<li>Use <tt>~~helper~~.DirectoryPath</tt>, don't try to determine the mod path yourself.		<li>Use <tt>Helper.DirectoryPath</tt>, don't try to determine the mod path yourself.

	<source lang="c#">		<source lang="c#">
Line 149:		Line 149:

	// ✓ This is OK		// ✓ This is OK
	string modFolder = ~~helper~~.DirectoryPath;		string modFolder = Helper.DirectoryPath;
	</source></li>		</source></li>
	</ol>		</ol>

imported>Pathoschild: /* Create the project */ no longer need beta package

2018-08-01T02:21:07Z

Create the project: no longer need beta package

← Older revision		Revision as of 02:21, 1 August 2018
Line 24:		Line 24:
	# Change the target framework to .NET Framework 4.5, 4.5.1, or 4.5.2 for best compatibility (see [[Modding:IDE reference#set-target-framework\|how to change target framework]]).		# Change the target framework to .NET Framework 4.5, 4.5.1, or 4.5.2 for best compatibility (see [[Modding:IDE reference#set-target-framework\|how to change target framework]]).
	# Reference the [https://www.nuget.org/packages/Pathoschild.Stardew.ModBuildConfig <tt>Pathoschild.Stardew.ModBuildConfig</tt> NuGet package] (see [[Modding:IDE reference#add-nuget\|how to add the package]]).		# Reference the [https://www.nuget.org/packages/Pathoschild.Stardew.ModBuildConfig <tt>Pathoschild.Stardew.ModBuildConfig</tt> NuGet package] (see [[Modding:IDE reference#add-nuget\|how to add the package]]).
	~~#* '''Stardew Valley 1.3 only:''' make sure you install the latest 2.1-beta version of the package. (You may need to enable the 'include prerelease' checkbox above the search results to see it.)~~
	# Restart Visual Studio/MonoDevelop after installing the package.		# Restart Visual Studio/MonoDevelop after installing the package.

imported>Pathoschild: /* Create the project */ update .NET Framework requirement, clarify Framework vs Core/Standard

2018-07-01T15:31:49Z

Create the project: update .NET Framework requirement, clarify Framework vs Core/Standard

← Older revision		Revision as of 15:31, 1 July 2018
Line 21:		Line 21:

	# Open Visual Studio 2017 or MonoDevelop.		# Open Visual Studio 2017 or MonoDevelop.
	# Create a solution with a .NET Framework class library project (see [[Modding:IDE reference#create-project\|how to create a project]]).		# Create a solution with a .NET Framework class library project (see [[Modding:IDE reference#create-project\|how to create a project]]). '''Make sure you choose .NET Framework, not .NET Core or .NET Standard.'''
	# Change the target framework to .NET Framework 4.5 for compatibility ~~with Linux~~ (see [[Modding:IDE reference#set-target-framework\|how to change target framework]]).		# Change the target framework to .NET Framework 4.5, 4.5.1, or 4.5.2 for best compatibility (see [[Modding:IDE reference#set-target-framework\|how to change target framework]]).
	# Reference the [https://www.nuget.org/packages/Pathoschild.Stardew.ModBuildConfig <tt>Pathoschild.Stardew.ModBuildConfig</tt> NuGet package] (see [[Modding:IDE reference#add-nuget\|how to add the package]]).		# Reference the [https://www.nuget.org/packages/Pathoschild.Stardew.ModBuildConfig <tt>Pathoschild.Stardew.ModBuildConfig</tt> NuGet package] (see [[Modding:IDE reference#add-nuget\|how to add the package]]).
	#* '''Stardew Valley 1.3 only:''' make sure you install the latest 2.1-beta version of the package. (You may need to enable the 'include prerelease' checkbox above the search results to see it.)		#* '''Stardew Valley 1.3 only:''' make sure you install the latest 2.1-beta version of the package. (You may need to enable the 'include prerelease' checkbox above the search results to see it.)

imported>Pathoschild: /* Quick start */ update .NET Framework requirement

2018-07-01T15:28:22Z

Quick start: update .NET Framework requirement

← Older revision		Revision as of 15:28, 1 July 2018
Line 9:		Line 9:

	# Create an empty C# class library project.		# Create an empty C# class library project.
	# Target .NET Framework 4.5 (for ~~Linux~~ compatibility).		# Target .NET Framework 4.5, 4.5.1, or 4.5.2 for best compatibility.
	# Reference the [https://github.com/Pathoschild/Stardew.ModBuildConfig <tt>Pathoschild.Stardew.ModBuildConfig</tt> NuGet package] to automatically add the right references depending on the platform the mod is being compiled on.		# Reference the [https://github.com/Pathoschild/Stardew.ModBuildConfig <tt>Pathoschild.Stardew.ModBuildConfig</tt> NuGet package] to automatically add the right references depending on the platform the mod is being compiled on.
	# Create a <tt>ModEntry</tt> class which subclasses <tt>StardewModdingAPI.Mod</tt>.		# Create a <tt>ModEntry</tt> class which subclasses <tt>StardewModdingAPI.Mod</tt>.

imported>Pathoschild: + footer nav links

2018-06-07T18:19:04Z

+ footer nav links

← Older revision		Revision as of 18:19, 7 June 2018
Line 166:		Line 166:

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

			{{modding guide footer
			\|prev = [[Modding:Modder Guide\|Getting Started]]
			\|next = [[Modding:Modder Guide/Testing and Releasing\|Testing and Releasing]]
			}}

imported>Pathoschild: + going further

2018-05-27T17:52:28Z

+ going further

← Older revision		Revision as of 17:52, 27 May 2018
Line 123:		Line 123:
	# If all else fails, come ask for help in the [[Modding:Community#Discord\|#modding in the Stardew Valley Discord]]. :)		# If all else fails, come ask for help in the [[Modding:Community#Discord\|#modding in the Stardew Valley Discord]]. :)

	==~~Things to consider~~==		==Going further==
			===SMAPI APIs===
			SMAPI provides a set of APIs you can use to do more. See [[Modding:SMAPI APIs]] for more info.

	===Crossplatform support===		===Crossplatform support===
	SMAPI will automatically adjust your mod so it works on Linux, Mac, and Windows. However, there are a few things you should do to avoid problems:		SMAPI will automatically adjust your mod so it works on Linux, Mac, and Windows. However, there are a few things you should do to avoid problems:
Line 151:		Line 154:
	</ol>		</ol>

	==Decompile the game code==		===Decompile the game code===
	When you start working on more complex mods, you may need to look at how the game code works.		When you start working on more complex mods, you may need to look at how the game code works.

imported>Pathoschild: /* Things to consider */ move some content to testing & releasing page

2018-05-27T17:50:42Z

Things to consider: move some content to testing & releasing page

@@ Line 150: / Line 150: @@
 </source></li>
 </ol>
 ==Decompile the game code==

imported>Pathoschild: integrate into modder's guide, move some content to intro page, rewrite and expand a bit

2018-05-27T17:46:17Z

integrate into modder's guide, move some content to intro page, rewrite and expand a bit

Show changes