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.
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.
If you are using r2modman or Thunderstore Mod Manager for installation, simply download the mod from the Online tab.
Follow these steps:
There are no configuration settings. The mod has its own save store where it saves the vmail attachments as JSON.
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.
All code in this repo is distributed under the MIT License. Feel free to use, modify, and distribute as needed.