Modder's Guide

gistfile1.txt

#  Modding: Modder's Guide
 
 Do you want to create mods for Stardew Valley? This guide is for you!

# Introduction to mods

A "mod" is a package of files which changes Stardew Valley in some way. Mods can add features (like showing NPCs on the map), change game mechanics (like making fences decay more slowly), make cosmetic changes (like making your house look like a hobbit home), and more.

Using mods in Stardew Valley is easy! You need to...

1.     Install SMAPI. That's the mod loader for Stardew Valley — it launches the game with mod support and lets mods interact directly with the game code. It's safely installed alongside your normal game, and you can uninstall it anytime.
2.     Unzip mods into your Mods folder.

# Mod Examples

Here are some of the top mods over all time:

- Content Patcher: a framework used to add content into the game without modifying the original game files.
- CJB Cheats Menu: Enables cheats in-game for testing.
- NPC Map Locations: Shows the locations of NPCs on the map
- CJB Item Spawner: Enables 'creative mode' where you can spawn any item in the game
- Lookup Anything: Shows information about anything in the game like favourite gifs, when a crop will be ready to harvest, etc.
- Tractor mod: Allows you to buy a tractor for late game farming.
- Automate: Automate your farm to put items into and out of machines and chests.
- JSON Assets: Add new content to the game such as new machines, crops, trees, hats, weapons, clothing, fences, etc.
- Skull Cavern Elevator: Adds an elevator to the Skull Cavern.
- Winter Grass: This mod makes grass survive through Winter!

You can check out all the mods mentioned and scroll endlessly on [Nexus Mods](https://www.nexusmods.com/stardewvalley?tab=popular+%28all+time%29).

# Types of mods

There are two ways to get your changes in the game:

1. Content Packs for Frameworks (no programming)

Content pack frameworks are SMAPI mods which let you write content packs with little or no programming experience, and implement the functionality for you.
A content pack is a collection of files loaded by a specific content pack framework (essentially a sub-mod). Content packs can contain any files, but generally consist of JSON files and images.

[Create a content pack](https://stardewvalleywiki.com/Modding:Content_packs).

Choose a suitable framework for your content pack

There are several frameworks out there for different purposes. Each framework defines their own content pack format; see their mod pages for usage.

[Choose a mod framework](https://www.stardewvalleywiki.com/ Modding:Content_pack_frameworks#Other_frameworks).

2. C# mods for SMAPI (programming required)

If you're new to programming: many mod developers start with little or no programming experience. You can certainly learn along the way if you're determined, but you should be prepared for a steep learning curve. Don't be too ambitious at first; it's better to start with a small mod when you're figuring it out. It's easy to become overwhelmed at first and give up.
If you have programming experience, you should be fine. Programming experience in C# or Java will make things easier, but it isn't critical. If you're unfamiliar with C#, you can skim through the Learning C# references below to fill in any gaps.

[Create a C# SMAPI mod](https://stardewvalleywiki.com/Modding:Modder_Guide/Get_Started).

# What tools do I need to get started?

The best way to test and develop a mod is to develop it in a place where it can be easily tested (The mods folder in the Stardew Valley Mods folder).

[Software for pixel art and text editing](https://gist.github.com/paradigmnomad/675687bdfa1fb1e1c9c001f23475e00f).

[Software for C# SMAPI moods](https://stardewvalleywiki.com/Modding:Modder_Guide/Get_Started#Get_started).

# Where can I get help or ask questions?

https://stardewvalleywiki.com/Modding:Help