Project:Data Dictionary/Mod

From STEP Modding Wiki
Form Form:ModP
Templates Template:ExternalURL | Template:Gallery | Template:GalleryItems | Template:Mod | Template:ModAttributes | Template:Recommendations |

This form allows for the creation and editing of Mod pages. All Mod pages are added to Category:Mods, which is declared to use Form:Mod.

Contents

Template:Mod

Template Template:ModP

Used to populate the Mod InfoBox.

Template Field Semantic Property Semantic Type Notes
author Author String The author.
fullname FullName String Full Name of the Mod.
sourcename SourceName String List of supported sites that uses an ID. Other specifies the download location is a full URL.
sourceurl SourceURL URL The full URL to a Mod source. Associated with the choice of Other from SourceName.
sourceid SourceID String The ID of the Mod from the download source. Associated with a valid SourceName.
section Section String Mod Section assignment. Contains "allows value" declarations.
N/A SectionLabel String This is not passed into the template, only referenced.
baseline Baseline String Short note to specify resource selection when multiple are available.
forumtid ForumTID String URL is formulated in the template from the ID.
externalitems N/A N/A Holds multiple-instance template Template:ExternalURL.

Template:ExternalURL

Template Template:ExternalURLP

This is a multiple-instance template contained in Mod[externalitems].

Template Field Semantic Property Semantic Type Notes
externallabel ExternalLabel String The link text (ex. Facebook).
externalurl ExternalURL URL URL to a site containing additional information (ex. http://www.facebook.com/page).

Template:ModAttributes

Template Template:ModAttributesP

Describes the mod-specific attributes obtained from examining the mod's contents as well as by reaching consensus based on mod tickets and performance reports.

Template Field Semantic Property Semantic Type Notes
resource HasResource String Indicates how a mod's resources files are packaged. (BSA, Loose, None).
dlcrequired DLCRequired String Indicates which DLC's are required by the mod.
dlcsupported DLCSupported String Indicates which DLC's are supported by the mod via an addon.
docdescription DocDescription Boolean Indicates that the mod includes a description of what the mod does.
docinstall DocInstall Boolean Indicates that the mod includes installation instructions.
docuninstall DocUninstall Boolean Indicates that the mod includes un-installation instructions.
script HasScript Boolean Indicates that the mod uses scripts.
bain CompatibleBAIN Boolean Indicates that the mod package has BAIN support.
fomod CompatibleFOMOD Boolean Indicates that the mod package has FOMOD support.
optimized IsOptimized Boolean Indicates that the mod's texture files are optimized.
skse HasSKSE Boolean Indicates that the mod depends on SKSE.
mcm HasMCM Boolean Indicates that the mod has MCM functionality and depends on SkyUI.
skyproc HasSkyProc Boolean Indicates that the mod contains a SkyProc patcher.
clean IsClean Boolean Indicates that the mod's EPS/M files are free of ITM/UDR errors.
lorefriendly LoreFriendly Boolean Indicates that the mod is considered lore friendly.
cleanuninstall CleanUninstall Boolean Indicates that mod can be deactivated without corrupting save games.
core IsCore Boolean Indicates if a mod is CORE to the STEP experience.
merged IsMerged Boolean Indicates if a mod is merged into any of the STEP Patches
lorefriendly LoreFriendly Boolean Indicates if a mod is considered lore friendly.
fps AffectsFPS Boolean Indicates if a mod has a noticeable FPS impact.
vram AffectsVRAM Boolean Indicates if a mod has a noticeable VRAM impact.
performance PerformanceAvailable Boolean Indicates if a mod has a performance version available.
quality QualityAvailable Boolean Indicates if a mod has a quality version available.

Template:Gallery

Template Template:GalleryP
Template Field Semantic Property Semantic Type Notes
enable N/A N/A Allows disabling of the Gallery.
title N/A N/A Title that appears above the gallery (Optional).
galleryitems N/A N/A Holds multiple-instance template Template:GalleryItems.

Template:GalleryItems

Template Template:GalleryItemsP

This is a multiple-instance template contained in Gallery[galleryitems].

Template Field Semantic Property Semantic Type Notes
url N/A N/A URL to the screenshot image.
caption N/A N/A Caption description that appears below the thumbnail.

Template:Recommendations

Template Template:RecommendationsP

Used to associate STEP-specific recommendations. The "notes" section.

Template Field Semantic Property Semantic Type Notes
enabledetailed N/A N/A Allows enabling/disabling of detailed instructions without losing content.
detailed N/A N/A Detailed instructions that are too big to fit in the guide.
short N/A N/A Short note that can fit in the guide.
N/A Recommendations Text Contains either the short note, or a link to the Mod page if detailed instructions are available.