Changes

4,091 bytes added , 28 April

m

Added a note saying that this page is outdated, and that .NET 6.0 is the correct framework for the latest version.

Line 15: Line 15:

| IDE || The program used to edit, run, and compile your code (short for ''Integrated Development Environment''). The main IDEs are Visual Studio on Windows, and MonoDevelop/Visual Studio for Mac on Linux/Mac.

|-

−

| DLL || The file with a <tt>.dll</tt> extension which contains your compiled code (short for ''Dynamic Link Library''). This is the file that SMAPI reads when loading your mod.

+

| DLL || The file with a <samp>.dll</samp> extension which contains your compiled code (short for ''Dynamic Link Library''). This is the file that SMAPI reads when loading your mod.

|-

| project || A collection of source code + configuration + resources (like images) you edit in the IDE. Each project is compiled into its own DLL.

Line 27: Line 27:

Before you can write your mod code, you need to create a solution and project to contain it.

−

===Windows (Visual Studio 2019)===

+

===Windows (Visual Studio 2019/2022)===

−

# Open Visual Studio 2019.

+

# Open Visual Studio 2019/2022.

# Click ''Create a new project'' from the start screen. [[File:Modding - IDE reference - create project (Visual Studio 1).png]]

−

# Filter by "C#" and "Library", then choose ''Class Library ~~(.NET Framework)~~'' and click ''Next''. Make sure you '''don't''' choose ''Class Library (.NET ~~Core~~)'' ~~or ''Class Library (.NET Standard)'',~~ which won't work. [[File:Modding - IDE reference - create project (Visual Studio 2).png]]

+

# 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. [[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>Make sure .NET Framework 4.5.2 is selected~~.</li><li>Click "Create" to to create the project.</li></ol>[[File:Modding - IDE reference - create project (Visual Studio 3).png]]

+

# 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. [[File:Screenshot 2021-12-16 140835.png]]

===Linux (MonoDevelop)===

Line 39: Line 40:

# Enter a descriptive mod name. By convention, the name should be one word with mixed caps (like "PineapplesEverywhere"): [[File:Modding - IDE reference - create project (MonoDevelop 3).png]]

# Make sure "create a project directory within the solution directory" is checked, and click ''Create'': [[File:Modding - IDE reference - create project (MonoDevelop 4).png]]

+

===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]). [[File:1a NET website.png|600px]]

+

# Open Visual Studio for Mac.

+

# Click ''File » New Solution'' from the menu bar: [[File:VS Mac 1 newsolution.png|600px]]

+

# Select the correct type of class library: [[File:VS Mac 2 createlibrary.png|600px]]

+

# Set it to target '''.NET 5.0.''': [[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"): [[File:VS Mac 4 nameproject.png|600px]]

===MacOS (Visual Studio for Mac)===

Line 49: Line 59:

==Set the target framework==

−

The 'target framework' is the version of .NET ~~Framework~~ your code uses, which affects the version needed to run your mod. The recommended target framework is .NET ~~Framework 4~~.5, which is the version SMAPI itself targets.

+

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'''.

+

(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===

+

'''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.

+

−

~~===In Visual Studio 2017===~~

# Open the Solution Explorer pane. If it's not visible, click ''View » Solution Explorer'' from the menu: [[File:Modding - IDE reference - show solution pane (Visual Studio).png]]

# From the Solution Explorer, right-click on the project and choose ''Properties'': [[File:Modding - IDE reference - change target framework (Visual Studio 1).png]]

−

# On the ''Application'' tab, change the ''Target Framework'' dropdown to ''.NET ~~Framework 4~~.5'': [[File:Modding - IDE reference - change target framework (Visual Studio 2).png]]

+

# On the ''Application'' tab, change the ''Target Framework'' dropdown to ''.NET 5.0'': [[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: [[File:Modding - IDE reference - change target framework (Visual Studio 3).png]]

+

===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.)

+

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:

+

# Open the .csproj file for editing: [[File:VS Mac 7 editcsproj.png|600px]]

+

# Replace your mod's <samp>.csproj</samp> file with this (where <code>EXAMLE_MOD_NAME</code> is your solution's name):

+

+

+

+

<AssemblyName>EXAMPLE_MOD_NAME</AssemblyName>

+

<RootNamespace>EXAMPLE_MOD_NAME</RootNamespace>

+

+

+

</PropertyGroup>

+

+

+

</ItemGroup>

+

</Project>

+

</syntaxhighlight>

+

# If the mod uses [[Modding:Modder Guide/APIs/Harmony|Harmony]], add <code><nowiki><EnableHarmony>true</EnableHarmony></nowiki></code> to the property group.

===In MonoDevelop/Visual Studio for Mac===

+

'''This section is out of date for Stardew Valley 1.5.5. It appears you cannot change the .NET framework in this way with Visual Studio 2019 and Stardew Valley 1.5.5.'''

+

# Open the Solution pad. If it's not visible, click ''View » Pads » Solution'' from the menu: [[File:Modding - IDE reference - show solution pane (MonoDevelop).png]]

# From the Solution pad, right-click on the project and choose ''Options'': [[File:Modding - IDE reference - change target framework (MonoDevelop 1).png]]

Line 91: Line 134:

−

===In Visual Studio ~~2017~~===

+

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

# Click ''Tools » NuGet Package Manager » Manage NuGet Packages for Solution'' from the menu: [[File:Modding - IDE reference - add NuGet package (Visual Studio 1).png]]

+

# Note: if the nuget package manager is missing, you can add it as a package source with the following steps: https://stackoverflow.com/questions/37293242/nuget-package-manager-no-packages-found-even-though-the-package-exists

# On the ''Browse'' tab, search for the package and click on the result to display some options: [[File:Modding - IDE reference - add NuGet package (Visual Studio 2).png]]

# In the options, check the box next to your project and click ''Install'': [[File:Modding - IDE reference - add NuGet package (Visual Studio 3).png]]

# If a 'Review Changes' dialogue appears, click ''OK'': [[File:Modding - IDE reference - add NuGet package (Visual Studio 4).png]]

+

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

+

# Click ''Project » Manage NuGet Packages...'' from the menu: [[File:VS Mac 5 managenuget.png|600px]]

+

# Search for the package, click on the result, and click ''Add Package'': [[File:VS Mac 6 addnuget.png|600px]]

+

# Quit and relaunch Visual Studio.

===In MonoDevelop/Visual Studio for Mac===

Line 101: Line 150:

# Search for the package, click on the result, and click ''Add Package'': [[File:Modding - IDE reference - add NuGet package (MonoDevelop 2).png]]

−

==Edit project file (<tt>.csproj</tt>)==

+

==Edit project file (<samp>.csproj</samp>)==

−

Sometimes you may want to edit the project file directly (mainly to configure build steps). The project is a <tt>.csproj</tt> file, and can be edited from within the IDE.

+

Sometimes you may want to edit the project file directly (mainly to configure build steps). The project is a <samp>.csproj</samp> file, and can be edited from within the IDE.

===In Visual Studio 2017===

Line 124: Line 173:

# Open the Solution Explorer pane. If it's not visible, click ''View » Solution Explorer'' from the menu: [[File:Modding - IDE reference - show solution pane (Visual Studio).png]]

# From the Solution Explorer pane, right-click on the project and choose ''Open Folder in File Explorer'': [[File:Modding - IDE reference - view build output (Visual Studio).png]]

−

# Navigate to <tt>bin\Debug</tt> (or <tt>bin\Release</tt> if you switched to release build configuration).

+

# Navigate to <samp>bin\Debug</samp> (or <samp>bin\Release</samp> if you switched to release build configuration).

===In MonoDevelop/Visual Studio for Mac===

# Open the Solution pad. If it's not visible, click ''View » Pads » Solution'' from the menu: [[File:Modding - IDE reference - show solution pane (MonoDevelop).png]]

# From the Solution pad, right-click on the project and choose ''Open Containing Folder'': [[File:Modding - IDE reference - view build output (MonoDevelop).png]]

−

# Navigate to <tt>bin/Debug</tt> (or <tt>bin/Release</tt> if you switched to release build configuration).

+

# Navigate to <samp>bin/Debug</samp> (or <samp>bin/Release</samp> if you switched to release build configuration).

==Add a reference to another DLL==

Line 140: Line 189:

# Find the DLL you want to reference, select it, and click ''Add'': [[File:Modding - IDE reference - add reference (Visual Studio 3).png]]

# From the 'Reference Manager' window, click ''OK'': [[File:Modding - IDE reference - add reference (Visual Studio 4).png]]

+

===In Rider===

+

When opening a project for the first time, you must add a reference to StardewModdingAPI.dll for code completion to work.

+

# In the Explorer panel, select the ''Solution'' view

+

# Under the project, right-click on ''Dependencies'' and choose ''Reference...''

+

# In the Add Reference window, click ''Add From...'' at the bottom

+

# Find the DLL you want to reference, select it, and click ''OK''

+

[[Category:Modding]]

+

[[es:Modding:Referencia IDE]]

+

[[ru:Модификации:Настройка среды разработки]]

+

[[zh:模组:IDE 参考]]

HollowStreak

2

edits

Changes

Modding:IDE reference (view source)

Revision as of 16:38, 28 April 2024