星露谷模组开发教程#2 创建模组项目

首发于Enaium的个人博客

---

创建模组项目

经过之前的配置，现在可以创建模组项目了，我们可以创建一个空白的文件夹，然后用Visual Studio Code打开它，之后使用dotnet new classlib来创建一个项目。

我们可以看到，项目中有一个Class1.cs文件，这个就是C#的源文件，还有一个awesome.csproj文件，这个是C#项目的配置文件，我们需要将里面的net8.0改为net6.0。

我们可以将Class1.cs名称改为我们想要的名称，比如这里我就叫ModEntry.cs，之后将源文件里的类名也改为ModEntry。

之后需要添加模组需要用到的NuGet包，我们可以使用命令dotnet add package Pathoschild.Stardew.ModBuildConfig来添加模组所需用的包。'

编写模组代码

首先进入到ModEntry之中，之后继承Mod这个抽象类，这里如果Visual Studio Code没有提示，可以重新打开。

using StardewModdingAPI;

namespace awesome;

public class ModEntry : Mod
{

}

这里由于是抽象类，我们需要实现它的抽象的方法，这里Visual Studio Code会在ModEntry上提示，在这里使用快捷键Shift+Alt+.可以使用快速修复。

using StardewModdingAPI;

namespace awesome;

public class ModEntry : Mod
{
    public override void Entry(IModHelper helper)
    {
        throw new NotImplementedException();
    }
}

这样它就会实现一个方法，这个方法会在模组加载时调用，我们可以打印一个日志来测试一下。

using StardewModdingAPI;

namespace awesome;

public class ModEntry : Mod
{
    public override void Entry(IModHelper helper)
    {
        Monitor.Log("Hello SMAPI!.", LogLevel.Debug);
    }
}

这里我们使用Monitor.Log来打印一个日志，第一个参数是日志的内容，第二个参数是日志的等级，这里我们使用LogLevel.Debug来打印一个调试日志。

编写模组配置

编写完代码之后，我们还需要再写一个模组的配置，它就叫manifest.json:

{
    "Name": "Awesome",
    "Author": "Enaium",
    "Version": "1.0.0",
    "Description": "This is an awesome mod.",
    "UniqueID": "Enaium.Awesome",
    "EntryDll": "Awesome.dll",
    "MinimumApiVersion": "4.0.0"
}

上面的配置文件中，Name是模组项目的名称，Author是作者，Version是版本号，Description是描述，UniqueID是唯一标识符，EntryDll是入口文件，MinimumApiVersion是最低的SMAPI版本。

测试模组

这里我们可以直接使用dotnet run来运行我们的模组，这里会自动编译我们的模组，之后会自动运行Stardew Valley，之后我们可以看到终端中会输出我们的日志。

如果你装了ModMenu这个模组就会在模组列表里看到