StardewValleyDev.StardewModTemplates 1.0.0

dotnet new install StardewValleyDev.StardewModTemplates@1.0.0
                    
This package contains a .NET Template Package you can call from the shell/command line.

Stardew Valley SMAPI Mod Templates

A dotnet new project template that scaffolds a Stardew Valley SMAPI mod in seconds.

The generated project targets .NET 6 and references the official Pathoschild.Stardew.ModBuildConfig package, which automatically:

  • finds your Stardew Valley install folder,
  • references the game and SMAPI assemblies,
  • deploys the built mod into the game's Mods folder,
  • and produces a release-ready .zip.

Requirements

Installation

Command line

dotnet new install StardewValleyDev.StardewModTemplates

JetBrains Rider

  1. Open File | New Solution.
  2. Click More Templates on the left, then Install Template.
  3. Choose the downloaded .nupkg, or install from the online search.
  4. Click Reload — the template appears in the list.

Visual Studio

Visual Studio picks up dotnet new templates automatically after dotnet new install. Find it in the Create a new project dialog.

Usage

dotnet new stardew-mod -n MyMod

This creates a MyMod project containing:

File Purpose
MyMod.csproj The mod project (.NET 6 + ModBuildConfig).
ModEntry.cs The entry point, subclassing StardewModdingAPI.Mod.
manifest.json Describes the mod to SMAPI.
README.md Project notes.
.gitignore Standard .NET ignores.

Template options

Option Default Description
-n, --name folder name The mod name (used for assembly, namespace, folder).
--Author YourName The mod author's name.
--Description A Stardew Valley SMAPI mod. A short description of the mod.
--MinimumApiVersion 4.0.0 Minimum SMAPI version required.

Example:

dotnet new stardew-mod -n AutomateEverything \
  --Author "Yalois" \
  --Description "Automates everything on the farm."

Build

cd MyMod
dotnet build

The built mod is copied into your game's Mods folder, and a release .zip is written to bin/. If the game folder isn't detected, set GamePath in the .csproj:

<PropertyGroup>
  <GamePath>/path/to/Stardew Valley</GamePath>
</PropertyGroup>

Release

  1. Update <Version> in the .csproj (this drives manifest.json).
  2. dotnet build -c Release
  3. Upload the generated .zip from bin/.

Uninstall

dotnet new uninstall StardewValleyDev.StardewModTemplates

License

MIT — see LICENSE.

  • net6.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 142 9/11/2026

Initial release: Stardew Valley SMAPI mod project template.