模组:IDE 參考

出自Stardew Valley Wiki
跳至導覽 跳至搜尋

目錄


此頁面描述了如何使用 Visual Studio 2019 或 MonoDevelop/Visual Studio for Mac 來製作 SMAPI 模組。參閱在主頁面中的 創建 SMAPI 模組

在你開始之前

  • 安裝 Visual Studio Community (Windows)、MonoDevelop (Linux)、Visual Studio for Mac (Mac)
  • 注意如果是在 Windows 上,請在 Visual Studio Installer 中的 工作負載 中選擇 .NET 桌面開發
  • 並在 單個組件 中勾選 .NET Framework 目標包 的 4.5、4.5.1、4.5.2 版本
  • 安裝都要人教的話那基本上告別開發了
  • 你應該具備 C# 入門基礎(其實 Visual Basic 也可以,但是跨平台會出問題)
  • 以下是一些需要記住的基本術語:
    term definition
    IDE 開發環境,就是現在你的 Visual Studio 或 MonoDevelop
    DLL .dll 後綴的文件(全稱叫 動態連結庫,英文 Dynamic Link Library),文件包括了你的代碼,SMAPI 將加載的東西
    項目 每個項目在生成(編譯,或者說是構建)的時候都會生成獨立的文件
    解決方案 項目的集合,每一個工程可以包含多個項目。所謂的工程也稱為解決方案,可以理解為要解決問題的方案,可能聽起來有點奇怪,不過這是專業術語

創建一個模組項目

在編寫模組的代碼之前,需要創建一個解決方案和一個包含它的項目

Windows (Visual Studio 2019)

  1. 打開 Visual Studio 2019.
  2. 點擊 創建新項目
    Modding - IDE reference - create project (Visual Studio 1) ZH.png
  3. 篩選器選擇語言 C#,然後選擇 類庫(.NET Framework),點擊 下一步。確保你選擇了正確的選項,否則是不會起作用的
    Modding - IDE reference - create project (Visual Studio 2) ZH.png
  4. 配置新項目 窗口中:
    1. 輸入你的模組名稱。按照約定,名稱應該是一個由幾個單詞去除空格連起來的字符串(例如 MyNewMod,避免使用特殊字符,如果實在看不習慣可以用下劃線來代替空格。可以使用中文,不過這會讓其他國家的玩家感到困惑,所以為了便於在國際上交流請儘可能避免使用中文)。
    2. 取消勾選 將解決方案和項目放在同一目錄中
    3. 確保選擇的是 .NET Framework 4.5.2
    4. 點擊 創建 來創建項目
    Modding - IDE reference - create project (Visual Studio 3) ZH.png

設置目標框架

目標框架 是代碼使用的 .NET Framework 版本,它會影響運行模組所需的版本。
推薦的目標框架是 .NET Framework 4.5,它是 SMAPI 所使用的框架版本
那為什麼其他地方說推薦 4.5.2 ?,別問,我也不知道為什麼

在 Visual Studio 2019 中

  1. 打開解決方案資源管理器。如果你那沒有,可以從菜單欄的 視圖 » 解決方案資源管理器 打開:
    Modding - IDE reference - show solution pane (Visual Studio) ZH.png
  2. 右鍵你的項目,選擇 屬性,或者你也可以從菜單欄的 項目 » <項目名>屬性 打開
    Modding - IDE reference - change target framework (Visual Studio 1) ZH.png
  3. 應用程式 選項卡,在 目標框架 下拉菜單中選擇 .NET Framework 4.5
    Modding - IDE reference - change target framework (Visual Studio 2) ZH.png
  4. 然後會彈出確認對話框,點擊 確認更改:
    Modding - IDE reference - change target framework (Visual Studio 3) ZH.png

添加文件

在 Visual Studio 2019 中

  1. 打開解決方案資源管理器,如果忘了怎麼打開回去看上邊的
  2. 右鍵你的項目,選擇 添加 » 新建項
    Modding - IDE reference - create file (Visual Studio 1) ZH.png
  3. 在彈出的窗口中選擇 文件(位於 Visual C# 項 » 類):
    Modding - IDE reference - create file (Visual Studio 2) ZH.png
  4. 輸入文件名,這裏按照教程流程填寫 ModEntry.cs ,然後點擊 添加

刪除文件

在 Visual Studio 2019 中

  1. 打開解決方案資源管理器,你應該沒忘吧
  2. 右鍵你要刪除的文件,這裏按照教程流程刪除 Class1.cs,選擇 刪除 來刪除它:
    Modding - IDE reference - delete file (Visual Studio) ZH.png

當然為了防止你手賤或者反悔了,這裏刪除文件只會發送到回收站,你可以去回收站恢復文件

添加 NuGet 程序包

在 Visual Studio 2019 中

  1. 在菜單欄點擊 工具 » 管理 NuGet 程序包
    Modding - IDE reference - add NuGet package (Visual Studio 1) ZH.png
  2. 瀏覽 選項卡中搜索 Pathoschild.Stardew.ModBuildConfig 然後點擊 安裝
    Modding - IDE reference - add NuGet package (Visual Studio 2) ZH.png
  3. 如果彈出了預覽更改窗口,點擊 即可:
    Modding - IDE reference - add NuGet package (Visual Studio 4) ZH.png