Модификации:Моддер гайд/Приступая к работе

Материал из Stardew Valley Wiki
Перейти к навигации Перейти к поиску

Создание SMAPI модов SMAPI mascot.png


Модификации:Индекс

Robin building.png
“Предстоит ещё много работы...”
— Робин

Неполный перевод

Эта статья или её часть до сих пор не переведены на русский язык. Вы можете оказать помощь в переводе путем ее редактирования.
Последний раз редактировалось Romeo4ka на 2022-01-09 23:22:48.

Желаете начать создавать моды для игры Stardew Valley с помощью SMAPI? Тогда этот гайд для вас! Для использования модов, перейди в Modding:Player Guide. for creating content patcher packs, see Модификации:Content Patcher.

Вступление

Что за SMAPI?

SMAPI — это специальное API для создания модификаций с целью расширения логик игры. Мод поможет реализовать изменения в игре (например, добавить новый предмет в мир), периодично запускать строчки кода (например, добавить автоматическую проверку обновлений), изменять игровые механики, логики и другое. Модификации SMAPI написаны на языке программирования C#, используют технологию .NET Framework. Stardew Valley использует движок XNA/MonoGame для реализации игровых механик (отрисовка объектов, отслеживание пользовательского ввода и прочее).

Почему модификации используют SMAPI?

SMAPI предоставляет возможность для реализации многих функций. Например:

  1. Загрузка мода в игру. Без SMAPI модификации не запустятся.
  2. Упрощённые API, которые позволяют создать взаимодействия, которые раньше были недоступны. Они делают более простое внесение изменений в механики игры, настройку игрового персонажа, перевода и прочего. Но об этом чуть позже.
  3. Кроссплатформенность. Это значит, что не нужно думать, как интегрировать модификацию на разные ОС.
  4. Изменение и обновление модификации. SMAPI обнаруживает и чинит дыры в коде, приводящие к поломке игры.
  5. Вывод ошибок. Если мод ломает игру или работает неправильно, SMAPI обнаружит ошибку, выведет её детали в окне консоли, и во многих случаях автоматически перезагрузит игру. Это значит, что поиск и устранение неполадки займёт гораздо меньше времени.
  6. Система обновлений. SMAPI автоматически уведомляет игроков о выходе новой версии мода.
  7. Проверка совместимости. SMAPI автоматически проверяет и определяет несовместимость или неработоспособность модификации на текущей системе и отключает его до появления проблем у игроков. Так пользователи не останутся со сломанными версиями игр.

Can I make a mod?

Yes! This guide will help you create a simple mod step-by-step. If you follow along, you'll have created a mod! Then you'll just need to make it do what you want.

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. The modding community is very welcoming, so don't be afraid to ask questions!

If you already 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.

Can I make a mod without SMAPI?

Yep. Many SMAPI mods support 'content packs', which let you provide JSON text files, images, etc which they use. For example, you can use Content Patcher to edit the game's images and data with zero programming needed. The rest of this guide is about creating a new SMAPI mod; for content packs, see Modding:Content Patcher (or the mod documentation if creating a content pack for a different mod).

Where can I get help?

The Stardew Valley modding community is very welcoming. Feel free to ask for help in #making-mods on the Stardew Valley Discord.

Get started

Learn C#

Since mods are written in C#, it's a good idea to get acquainted with it first. You don't need to memorise everything, but a grasp of the basics (like fields, methods, variables, and classes) will make everything else much easier.

Some useful resources:

Requirements

Before you start:

  1. Read the Player Guide. The rest of this guide assumes you're already familiar with using mods.
  2. Install Stardew Valley.
  3. Install SMAPI.
  4. Install the IDE (integrated development environment).

If you're not familiar with Visual Studio (on Windows/Mac) or MonoDevelop (on Linux), Modding:IDE reference explains how to do the important stuff you need for this guide.

Create a basic mod

Quick start

If you're experienced enough to skip the tutorial, here's a quick summary of this section:

expand for quick start 
  1. Create an empty C# class library project.
  2. Target .NET Framework 4.5, 4.5.1, or 4.5.2 for best compatibility.
  3. Reference the Pathoschild.Stardew.ModBuildConfig NuGet package to automatically add the right references depending on the platform the mod is being compiled on.
  4. Create a ModEntry class which subclasses StardewModdingAPI.Mod.
  5. Override the Entry method, and write your code using the SMAPI events and APIs.
  6. Create a manifest.json file which describes your mod for SMAPI.
  7. Create a zip file containing the mod files for release.

Create the project

A SMAPI mod is a compiled library (DLL) with an entry method that gets called by SMAPI, so let's set that up.

  1. Open Visual Studio or MonoDevelop.
  2. Create a solution with a .NET Framework class library project (see how to create a project). Make sure you choose .NET Framework (not .NET Core, .NET Standard, or .NET 5+).
  3. Change the target framework to .NET Framework 4.5, 4.5.1, or 4.5.2 for best compatibility (see how to change target framework).
    That's the version installed and used by the game. Newer versions may not be installed for players, and SMAPI may not be able to load them.
  4. Reference the Pathoschild.Stardew.ModBuildConfig NuGet package (see how to add the package).
  5. Restart Visual Studio/MonoDevelop after installing the package.

Add the code

Next let's add some code SMAPI will run.

  1. Delete the Class1.cs or MyClass.cs file (see how to delete a file).
  2. Add a C# class file called ModEntry.cs to your project (see how to add a file).
  3. Put this code in the file (replace YourProjectName with the name of your project):
    using System;
    using Microsoft.Xna.Framework;
    using StardewModdingAPI;
    using StardewModdingAPI.Events;
    using StardewModdingAPI.Utilities;
    using StardewValley;
    
    namespace YourProjectName
    {
        /// <summary>The mod entry point.</summary>
        public class ModEntry : Mod
        {
            /*********
            ** Public methods
            *********/
            /// <summary>The mod entry point, called after the mod is first loaded.</summary>
            /// <param name="helper">Provides simplified APIs for writing mods.</param>
            public override void Entry(IModHelper helper)
            {
                helper.Events.Input.ButtonPressed += this.OnButtonPressed;
            }
    
    
            /*********
            ** Private methods
            *********/
            /// <summary>Raised after the player presses a button on the keyboard, controller, or mouse.</summary>
            /// <param name="sender">The event sender.</param>
            /// <param name="e">The event data.</param>
            private void OnButtonPressed(object sender, ButtonPressedEventArgs e)
            {
                // ignore if player hasn't loaded a save yet
                if (!Context.IsWorldReady)
                    return;
    
                // print button presses to the console window
                this.Monitor.Log($"{Game1.player.Name} pressed {e.Button}.", LogLevel.Debug);
            }
        }
    }
    

Here's a breakdown of what that code is doing:

  1. using X; (see using directive) makes classes in that namespace available in your code.
  2. namespace YourProjectName (see namespace keyword) defines the scope for your mod code. Don't worry about this when you're starting out, Visual Studio or MonoDevelop will add it automatically when you add a file.
  3. public class ModEntry : Mod (see class keyword) creates your mod's main class, and subclasses SMAPI's Mod class. SMAPI will detect your Mod subclass automatically, and Mod gives you access to SMAPI's APIs.
  4. public override void Entry(IModHelper helper) is the method SMAPI will call when your mod is loaded into the game. The helper provides convenient access to many of SMAPI's APIs.
  5. helper.Events.Input.ButtonPressed += this.OnButtonPressed; adds an 'event handler' (i.e., a method to call) when the button-pressed event happens. In other words, when a button is pressed (the helper.Events.Input.ButtonPressed event), SMAPI will call your this.OnButtonPressed method. See events in the SMAPI reference for more info.

Add your manifest

The mod manifest tells SMAPI about your mod.

  1. Add a file named manifest.json to your project.
  2. Paste this code into the file:
    {
      "Name": "<your project name>",
      "Author": "<your name>",
      "Version": "1.0.0",
      "Description": "<One or two sentences about the mod>",
      "UniqueID": "<your name>.<your project name>",
      "EntryDll": "<your project name>.dll",
      "MinimumApiVersion": "3.0.0",
      "UpdateKeys": []
    }
    
  3. Replace the <...> placeholders with the correct info. Don't leave any <> symbols!

This will be listed in the console output when the game is launching. For more info, see the manifest docs.

Try your mod

  1. Build the project.
    If you did the create the project steps correctly, this will automatically add your mod to the game's Mods folder.
  2. Run the game through SMAPI.

The mod so far will just send a message to the console window whenever you press a key in the game.

Troubleshoot

If the tutorial mod doesn't work...

  1. Review the above steps to make sure you didn't skip something.
  2. Check for error messages which may explain why it's not working:
    • In Visual Studio, click Build > Rebuild Solution and check the Output pane or Error list.
    • In MonoDevelop, click Build > Rebuild All and wait until it's done. Then click the "Build: XX errors, XX warnings" bar at the top, and check the XX Errors and Build Output tabs.
  3. If one of the errors (not necessarily the first one) says the package can't find your game folder, see Visual Studio can't find the game/SMAPI/XNA DLLs.
  4. See the troubleshooting guide.
  5. If all else fails, come ask for help in the #making-mods in the Stardew Valley Discord. :)

FAQs

Where's the SMAPI documentation?

This is just the 'getting started' tutorial. For more documentation, see the SMAPI reference and the topics listed on the index page.

How do I make my mod work crossplatform?

SMAPI will automatically adjust your mod so it works on Linux, MacOS, and Windows. However, there are a few things you should do to avoid problems:

  1. Use the crossplatform build config package to automatically set up your project references. This makes crossplatform compatibility easier and lets your code compile on any platform. (If you followed the above guide, you already have this.)
  2. Use System.IO.Path.Combine to build file paths, don't hardcode path separators since they won't work on all platforms.
    // ✘ Don't do this! It won't work on Linux/Mac.
    string path = this.Helper.DirectoryPath + "\assets\image.png";
    
    // ✓ This is OK
    string path = Path.Combine(this.Helper.DirectoryPath, "assets", "image.png");
    
  3. Use this.Helper.DirectoryPath, don't try to determine the mod path yourself.
    // ✘ Don't do this! It will crash if SMAPI rewrites the assembly (''e.g.,'' to update or crossplatform it).
    string modFolder = Assembly.GetCallingAssembly().Location;
    
    // ✓ This is OK
    string modFolder = this.Helper.DirectoryPath;
    
  4. The following describes the upcoming SMAPI 3.13.0, and may change before release.
    An asset name identifies an asset you can load through a content API like Game1.content.Load<T>("asset name"), like Characters/Abigail. This is not a file path, and the asset name format on Windows does not match the path format. When comparing asset names, make sure you use PathUtilities.NormalizePath("some/path") instead of path helpers.

How do I decompile the game code?

It's often useful to see how the game code works. The game code is compiled into StardewValley.exe (i.e., converted to a machine-readable format), but you can decompile it get a mostly-readable approximation of the original code. (This might not be fully functional due to decompiler limitations, but you'll be able to see what it's doing.)

To decompile the game code...

  1. First-time setup:
    1. Install the latest ILSpy release for Windows release (get the "ILSpy_binaries" file under assets). You can use Avalonia ILSpy for Linux and macOS.
    2. Open ILSpy.
    3. Click View > Options, scroll to the "Other" section at the bottom, and enable "Always qualify member references".
  2. Open StardewValley.exe in ILSpy.
  3. Right-click on Stardew Valley and choose Save Code to create a decompiled project you can open in Visual Studio.

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