Project talk:Data Dictionary: Difference between revisions

From Step Mods | Change The Game
No edit summary
Line 24: Line 24:


===== Mod Attributes =====
===== Mod Attributes =====
* ''DocDescription'' - Indicates that the mod includes a description of what the mod does (boolean).
* ''DocInstall'' - Indicates that the mod includes installation instructions (boolean).
* ''DocUninstall'' - Indicates that the mod includes un-installation instructions (boolean).
* ''CompatibleBAIN'' - Indicates that the mod package has BAIN support (boolean).
* ''CompatibleFOMOD'' - Indicates that the mod package has FOMOD/NMM support (boolean).
* ''HasResource'' - Indicates for a mod's resource files are packaged (select: BSA, Loose, None).
* ''QualityItems'' - multiple instances of a ''QualityValue''.
* ''QualityItems'' - multiple instances of a ''QualityValue''.
** ''QualityValue'' - Available graphical tiers or options available (2048, 1024, High, Low, etc.) (string).
** ''QualityValue'' - Available graphical tiers or options available (2048, 1024, High, Low, etc.) (string).
* ''HasPlugin'' - Indicates that the mod has a plugin file (select: ESP, ESM, None).
* ''HasPlugin'' - Indicates that the mod has a plugin file (select: ESP, ESM, None).
** ''CleanPlugin'' - Indicates that the mod's plugin is clean (boolean). Dependent on ''HasPlugin''.
** ''CleanPlugin'' - Indicates that the mod's plugin is clean (boolean). Dependent on ''HasPlugin''.
* ''HasScript'' - Indicates that the mod uses scripts (boolean).
* ''Notes'' - Mod-specific information or special notes (string).* ''HasResource'' - Indicates how a mod's resources files are packaged. (BSA, Loose, None).
* ''IsOptimized'' - Indicates that the mod's texture files are optimized (boolean).
* ''SKSERequired'' - Indicates that the mod depends on SKSE (boolean).
* ''MCMSupport'' - Indicates that the mod supports the MCM (boolean).
* ''HasSkyProc'' - Indicates that the mod has a SkyProc patcher (boolean).
* ''Notes'' - Mod-specific information or special notes (string).
 
* ''DLCRequired'' - Indicates which DLCs are <u>required</u> by the mod (multi-select: DG, HF, DB)
* ''DLCSupported'' - Indicates which DLCs are <u>supported</u>, either natively or through a patch/addon (multi-select: DG, HF, DB).
 
* ''HasResource'' - Indicates how a mod's resources files are packaged. (BSA, Loose, None).
* ''DLCRequired'' - Indicates which DLC's are required by the mod.
* ''DLCRequired'' - Indicates which DLC's are required by the mod.
* ''DLCSupported'' - Indicates which DLC's are supported by the mod via an addon.
* ''DLCSupported'' - Indicates which DLC's are supported by the mod via an addon.

Revision as of 05:33, July 16, 2013

Vista-file-manager.png
Archive


Additional Info for Mod Pages (Discussion Page)

Below is a work-in-progress list of additional data points that will be tracked on mod pages. Feel free to add anything you might think is useful. Let's try to keep it organized, so group similar or related properties as best you can. Note that Baseline has been removed from this list on purpose, that should be a Pack attribute based on the Pack's guidelines. ~FarloUser Farlo Sig.pngTalk 19:56, July 15, 2013 (MDT)


Basic Info
  • Author - The author of the mod (string).
  • FullName - Full name of the mod according to source (string).
  • Section - Broad categorization of the mod (NOT the STEP section, similar idea to the Nexus categories)
  • ForumTID - Thread ID of the mod on the STEP forums (string).
  • ExternalItems - multiple instances of an ExternalURL and ExternalLabel. (object)
    • ExternalURL - URL to a page related to the mod; other hosts, Facebook, etc. (URL)
    • ExternalLabel - Label to be displayed for the above ExternalURL (string)
Source
  • SourceName - List of supported sites that uses an ID (Nexus, Steam, Other). Other specifies the download location is a full URL.
  • SourceID - The ID of the mod from the download source. Associated with a valid SourceName (string).
  • SourceURL - The full URL to a mod source. Associated with the choice of Other from SourceName (URL).
Mod Attributes
  • QualityItems - multiple instances of a QualityValue.
    • QualityValue - Available graphical tiers or options available (2048, 1024, High, Low, etc.) (string).
  • HasPlugin - Indicates that the mod has a plugin file (select: ESP, ESM, None).
    • CleanPlugin - Indicates that the mod's plugin is clean (boolean). Dependent on HasPlugin.
  • Notes - Mod-specific information or special notes (string).* HasResource - Indicates how a mod's resources files are packaged. (BSA, Loose, None).
  • DLCRequired - Indicates which DLC's are required by the mod.
  • DLCSupported - Indicates which DLC's are supported by the mod via an addon.
  • DocDescription - Indicates that the mod includes a description of what the mod does.
  • DocInstall - Indicates that the mod includes installation instructions.
  • DocUninstall - Indicates that the mod includes un-installation instructions.
  • HasScript - Indicates that the mod uses scripts.
  • CompatibleBAIN - Indicates that the mod package has BAIN support.
  • CompatibleFOMOD - Indicates that the mod package has FOMOD support.
  • IsOptimized - Indicates that the mod's texture files are optimized.
  • HasSKSE - Indicates that the mod depends on SKSE.
  • HasMCM - Indicates that the mod has MCM functionality and depends on SkyUI.
  • HasSkyProc - Indicates that the mod contains a SkyProc patcher.
  • IsClean - Indicates that the mod's EPS/M files are free of ITM/UDR errors.
  • LoreFriendly - Indicates that the mod is considered lore friendly.
  • CleanUninstall - Indicates that mod can be deactivated without corrupting save games.
  • LoreFriendly - Indicates if a mod is considered lore friendly.
  • IsCore - Indicates if a mod is CORE to the STEP experience.
  • AffectsFPS - Indicates if a mod has a noticeable FPS impact.
  • AffectsVRAM - Indicates if a mod has a noticeable VRAM impact.
  • PerformanceAvailable - Indicates if a mod has a performance version available.
  • QualityAvailable - Indicates if a mod has a quality version available.