VmailAttachments

版本 v1.0.0·更新於 2024-01-03

A common library that allows SOD mods to attach arbitrary documents to vmails.

模組介紹 作者原文

Vmail Attachments

What is it?

This plugin does nothing on its own, it exposes helper methods for other mods to use that allow them to attach arbitrary documents to vmails. The player can print these documents separately from the message body.

Installation

You should not need to manually install this mod, if it is set up as a dependency of another mod, it should install automatically, but for completion sake here is how to install this mod on its own.

r2modman or Mod Manager installation

If you are using r2modman or Mod Manager for installation, simply download the mod from the Online tab.

Manual installation

Follow these steps:

  • Download BepInEx from the official repository.
  • Extract the downloaded files into the same folder as the "Shadows of Doubt.exe" executable.
  • Launch the game, load the main menu, and then exit the game.
  • Download the latest version of the plugin from the Releases page. Unzip the files and place them in corresponding directories within "Shadows of Doubt\BepInEx...". Also, download the SOD.Common dependency.
  • Start the game.

Usage and features

Configuration

There are no configuration settings. The mod has its own save store where it saves the vmail attachments as JSON.

Modders

There are two static methods in VmailAttachmentsPlugin that you may use, once you reference this plugin:

  • VmailAttachmentsPlugin.AddAttachment: This allows you to associate an attachment with a vmail ID. This association is separate from the vmail itself, which you will need to send. (Helper methods may be added in the future.) You will need an InteractablePreset for the document and human IDs for who the document references.
  • VmailAttachmentsPlugin.TryGetAttachment: This allows you to check if a vmail has an attachment. You should not need this though, once an attachment is added to a vmail the mod handles all UI for printing the document at that point.

License

All code in this repo is distributed under the MIT License. Feel free to use, modify, and distribute as needed.

安裝與使用 安裝:按包內說明操作

  1. 解壓本站下載的壓縮包,先讀包內的 readme / 說明檔案。
  2. 多數模組依賴遊戲的模組載入器:常見做法是用社群模組管理器(如 r2modman)選中本遊戲安裝,由管理器自動處理載入器與依賴。
  3. 手動安裝時,把模組檔案放進遊戲目錄下對應的 Mod / plugins 資料夾。
  4. 啟動遊戲確認載入成功;帶「前置依賴」的模組需要把依賴一併安裝。

不同模組的安裝位置差異較大,包內說明是最可靠的依據。

前置依賴

下面這些內容需要先安裝,否則該模組不會生效:

Venomaus-SODCommon

檔案與校驗

檔案名稱
VmailAttachments-1.0.0.zip
檔案大小
129.3 KiB