Unity v2 Plugin 0.1
mod management for Unity projects
Public Attributes | List of all members
ModIO.ModProfileDetails Class Reference

Use this class to fill out the details of a Mod Profile that you'd like to create or edit. If you're submitting this via CreateModProfile you must assign values to logo, name and summary, otherwise the submission will be rejected (All fields except modId are optional if submitting this via EditModProfile) More...

Public Attributes

ModId? modId
 Make sure to set this field when submitting a request to Edit a Mod Profile
 
bool? visible
 Whether this mod will appear as public or hidden.
 
Texture2D logo
 Image file which will represent your mods logo. Must be gif, jpg or png format and cannot exceed 8MB in filesize. Dimensions must be at least 512x288 and we recommend you supply a high resolution image with a 16 / 9 ratio. mod.io will use this image to make three thumbnails for the dimensions 320x180, 640x360 and 1280x720
 
Texture2D[] images
 Image files that will be included in the mod profile details.
 
string name
 Name of your mod
 
string name_id
 Path for the mod on mod.io. For example: https://gamename.mod.io/mod-name-id-here. If no name_id is specified the name will be used. For example: 'Stellaris Shader Mod' will become 'stellaris-shader-mod'. Cannot exceed 80 characters
 
string summary
 Summary for your mod, giving a brief overview of what it's about. Cannot exceed 250 characters. More...
 
string description
 Detailed description for your mod, which can include details such as 'About', 'Features', 'Install Instructions', 'FAQ', etc. HTML supported and encouraged
 
string homepage_url
 Official homepage for your mod. Must be a valid URL
 
int? maxSubscribers
 This will create a cap on the number of subscribers for this mod. Set to 0 to allow for infinite subscribers.
 
ContentWarnings? contentWarning
 This is a Bitwise enum so you can assign multiple values More...
 
string metadata
 Your own custom metadata that can be uploaded with the mod profile. (This is for the entire mod profile, a unique metadata field can be assigned to each modfile as well) More...
 
string[] tags
 The tags this mod profile has. Only tags that are supported by the parent game can be applied. (Invalid tags will be ignored)
 

Detailed Description

Use this class to fill out the details of a Mod Profile that you'd like to create or edit. If you're submitting this via CreateModProfile you must assign values to logo, name and summary, otherwise the submission will be rejected (All fields except modId are optional if submitting this via EditModProfile)

Member Data Documentation

◆ contentWarning

ContentWarnings? ModIO.ModProfileDetails.contentWarning

This is a Bitwise enum so you can assign multiple values

See also
ContentWarnings

◆ metadata

string ModIO.ModProfileDetails.metadata

Your own custom metadata that can be uploaded with the mod profile. (This is for the entire mod profile, a unique metadata field can be assigned to each modfile as well)

See also
ModfileDetails

the metadata has a maximum size of 50,000 characters.

◆ summary

string ModIO.ModProfileDetails.summary

Summary for your mod, giving a brief overview of what it's about. Cannot exceed 250 characters.

This field must be assigned when submitting a new Mod Profile

The documentation for this class was generated from the following file: