Project talk:Data Dictionary

Archive

---

• /Archive 1

New Properties for STEP Guides - WIP (Discussion Page)

Following is a work-in-progress list of current and proposed attributes that can be associated with 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. ~FarloTalk 19:56, July 15, 2013 (MDT)

Mods

Packs

[edit]

Mod Info

• Author (string) - The author(s) of the mod.
• FullName (string) - Full name of the mod according to source.

  Proposed: add Short Mod Description here (1 sentence, possibly from the Nexus API); currently this isn't in either the mod page or the STEP guide. It would be hard to include this in a STEP guide (core or pack) since it doesn't fit well in a multi-column format like those used in the guide

  • Description (string) - Brief mod description.

• SourceName (string) - Supported mod source. Specifies a URL created from "Steam" or "Nexus" mod ID. "Other" prompts for user input of a full URL string.
  • SourceID (string) - "Steam" or "Nexus" mod SourceID if either is specified in SourceName.
  • SourceURL (URL) - Full URL if SourceName is specified as "Other".
• Section (string) - STEP installation "blocks" specified using "allows value" declarations.

  Proposed: Change to broad categorization of the mod (NOT the STEP section, similar idea to the Nexus categories but hopefully with categories more relevant to STEP)

• SectionLabel (string) - A human-meaningful label associated with Section. This is not passed into the template, only referenced.
• Baseline (string) - Specifies the recommended mod option when more than one are available.
• ForumTID (string) - Specifies a URL created using the thread ID of the mod on the STEP forums.
  
• External URL (object) - Multiple-instance template containing:
  • ExternalURL (URL) - URL string specifying a page associated with the mod; other hosts, Facebook, etc. (URL)
  • ExternalLabel (string) - A human-meaningful label associated with ExternalURL (string)
    

• HasResource (string) - Indicates how a mod's resources files are packaged. (BSA, Loose, None).
• DLCRequired (string) - Indicates which DLC's are required by the mod.
• DLCSupported (string) - Indicates which DLC's are supported by the mod via an addon.

Mod Flags

• DocDescription (Boolean) - Indicates that the mod includes a description of what the mod does.
• DocInstall (Boolean) - Indicates that the mod includes installation instructions.
• DocUninstall (Boolean) - Indicates that the mod includes un-installation instructions.
• HasScript (Boolean) - Indicates that the mod uses scripts.
  
• CompatibleBAIN (Boolean) - Indicates that the mod package has BAIN support.
• CompatibleFOMOD (Boolean) - Indicates that the mod package has FOMOD support.
• IsOptimized (Boolean) - Indicates that the mod has MCM functionality and depends on SkyUI. Kelmych comments: This was apparently overwritten with the wrong description. The flag is somewhat problematic since it applies only to textures and can be hard to verify especially for non-core mods. Moreover, we may still want to separately optimize/reoptimize the normal maps even if the color map textures are adequately optimized.
• HasSKSE (Boolean) - Indicates that the mod depends on SKSE.
• HasMCM (Boolean) - Indicates that the mod has MCM functionality and depends on SkyUI.
• HasSkyProc (Boolean) - Indicates that the mod contains a SkyProc patcher.
• LoreFriendly (Boolean) - Indicates that the mod is considered lore friendly.Kelmych comment: it is often difficult to assign/verify this flag
• IsClean (Boolean) - Indicates that the mod's EPS/M files are free of ITM/UDR errors.
• CleanUninstall (Boolean) - Indicates that mod can be deactivated without corrupting save games.

  Proposed: Fully specify if mod has plugins and that they are clean. Also, disambiguate clean plugins from clean uninstall (or eliminate clean uninstall altogether)

  • HasPlugin (Boolean) - Indicates that the mod has a plugin file (ESP, ESM, None).
    • CleanPlugin (Boolean) - Indicates that the mod's plugin is clean. Dependent on HasPlugin.

• IsCore (Boolean) - Indicates if a mod is CORE to the STEP experience.

  Proposed by Farlo: Remove, core mods -- will be in STEP:Core, this attribute isn't tied to the mod itself.

• AffectsFPS (Boolean) - Indicates if a mod has a noticeable FPS impact.

Proposed by Kelmych: should have way to indicate whether effect is positive or negative

• AffectsVRAM (Boolean) - Indicates if a mod has a noticeable VRAM impact.

Proposed by Kelmych: should have way to indicate whether effect is positive or negative

• PerformanceAvailable (Boolean) - Indicates if a mod has a performance version available.
• QualityAvailable (Boolean) - Indicates if a mod has a quality version available.

  Proposed: Replace AffectsFPS, AffectsVRAM, PerformanceAvailable, and QualityAvailable with the following:

  • QualityItems (object) - Multiple-instance template containing:
    • QualityValue (string) - Available graphical tiers or options available (2048, 1024, High, Low, etc.).
    • AffectsFPS (Boolean) - Indicates if a mod has a noticeable FPS impact.
    • AffectsVRAM (Boolean) - Indicates if a mod has a noticeable VRAM impact.

Recommendations

• Recommendations (Text) - Contains either the short note, or a link to the Mod page if detailed instructions are available. This property is specified by Template:Recommendations.

  Proposed: Attach mod-specific notes to mod pages. Packs will also need recommendations relating to specific mods. Template:Recommendations could be used at the Pack level as it currently stands.

  • Notes (string) - Mod-specific information or special notes (string).
    

Proposed by Kelmych: I thought s4n suggested adding a capability to add a set of flags or similar binary indicators (plus mod name) to note conflicts with other mods.

[edit]