Project talk:Data Dictionary: Difference between revisions
From Step Mods | Change The Game
No edit summary |
|||
Line 11: | Line 11: | ||
*: {{Fc|white|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}} | *: {{Fc|white|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}} | ||
*:* {{Fc|#9eb6e6|'''''Description'''''}} (string) - Brief mod description. | *:* {{Fc|#9eb6e6|'''''Description'''''}} (string) - Brief mod description. | ||
*:: {{Fc|white| Agreed, at the very least it'll help fill out the mod pages. }} ~[[User:Farlo|Farlo]][[File:User Farlo Sig.png|19px|link=User:Farlo]]<small>[[User talk:Farlo|Talk]]</small> 18:20, July 16, 2013 (MDT) | |||
* {{Fc|#e6b69e|'''''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. | * {{Fc|#e6b69e|'''''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. | ||
** {{Fc|#e6b69e|'''''SourceID'''''}} (string) - "Steam" or "Nexus" mod SourceID if either is specified in SourceName. | ** {{Fc|#e6b69e|'''''SourceID'''''}} (string) - "Steam" or "Nexus" mod SourceID if either is specified in SourceName. | ||
** {{Fc|#e6b69e|'''''SourceURL'''''}} (URL) - Full URL if SourceName is specified as "Other". | ** {{Fc|#e6b69e|'''''SourceURL'''''}} (URL) - Full URL if SourceName is specified as "Other". | ||
* {{Fc|#e6b69e|'''''Section'''''}} (string) - STEP installation "blocks" specified using "allows value" declarations. | * {{Fc|#e6b69e|'''''Section'''''}} (string) - STEP installation "blocks" specified using "allows value" declarations. | ||
*: {{Fc|white|Proposed: Change to broad categorization of the mod (<u>'''NOT''' the STEP section</u>, similar idea to the [http://skyrim.nexusmods.com/mods/categories/ Nexus categories] but hopefully with categories more relevant to STEP)}} | *: {{Fc|white|Proposed: Change to broad categorization of the mod (<u>'''NOT''' the STEP section</u>, similar idea to the [http://skyrim.nexusmods.com/mods/categories/ Nexus categories] but hopefully with categories more relevant to STEP)}} ~[[User:Farlo|Farlo]][[File:User Farlo Sig.png|19px|link=User:Farlo]]<small>[[User talk:Farlo|Talk]]</small> 18:20, July 16, 2013 (MDT) | ||
* {{Fc|#e6b69e|'''''SectionLabel'''''}} (string) - A human-meaningful label associated with Section. This is not passed into the template, only referenced. | * {{Fc|#e6b69e|'''''SectionLabel'''''}} (string) - A human-meaningful label associated with Section. This is not passed into the template, only referenced. | ||
* {{Fc|#e6b69e|'''''Baseline'''''}} (string) - Specifies the recommended mod option when more than one are available. | * {{Fc|#e6b69e|'''''Baseline'''''}} (string) - Specifies the recommended mod option when more than one are available. | ||
Line 35: | Line 36: | ||
* {{Fc|#e6b69e|'''''CompatibleFOMOD'''''}} (Boolean) - Indicates that the mod package has FOMOD support. | * {{Fc|#e6b69e|'''''CompatibleFOMOD'''''}} (Boolean) - Indicates that the mod package has FOMOD support. | ||
* {{Fc|#e6b69e|'''''IsOptimized'''''}} (Boolean) - Applies to texture mods only. Indicates that the mod textures are correctly formatted (but not that they are necessarily size/constraint optimized). | * {{Fc|#e6b69e|'''''IsOptimized'''''}} (Boolean) - Applies to texture mods only. Indicates that the mod textures are correctly formatted (but not that they are necessarily size/constraint optimized). | ||
*: {{Fc|white| | *: {{Fc|white|Comment: 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.}} ~[[User:Kelmych|Kelmych]] [[User talk:Kelmych|Talk]] 12:26, July 16, 2013 | ||
*: {{Fc|white| | *:: {{Fc|white|I think that this is a good flag for things that really should not be run through DDSopt for whatever reason. We can change the property and tag names easily enough if necessary.}} ~[[User:z929669|z929669]] [[File:Ixian_Insignia.png|25px|link=User:z929669]] [[User talk:z929669|Talk]] 15:21, July 16, 2013 (MDT) | ||
* {{Fc|#e6b69e|'''''HasSKSE'''''}} (Boolean) - Indicates that the mod depends on SKSE. | * {{Fc|#e6b69e|'''''HasSKSE'''''}} (Boolean) - Indicates that the mod depends on SKSE. | ||
* {{Fc|#e6b69e|'''''HasMCM'''''}} (Boolean) - Indicates that the mod has MCM functionality and depends on SkyUI. | * {{Fc|#e6b69e|'''''HasMCM'''''}} (Boolean) - Indicates that the mod has MCM functionality and depends on SkyUI. | ||
* {{Fc|#e6b69e|'''''HasSkyProc'''''}} (Boolean) - Indicates that the mod contains a SkyProc patcher. | * {{Fc|#e6b69e|'''''HasSkyProc'''''}} (Boolean) - Indicates that the mod contains a SkyProc patcher. | ||
* {{Fc|#e6b69e|'''''LoreFriendly'''''}} (Boolean) - Indicates that the mod is considered lore friendly.{{Fc|white| | * {{Fc|#e6b69e|'''''LoreFriendly'''''}} (Boolean) - Indicates that the mod is considered lore friendly. | ||
*: {{Fc|white|Proposed: Remove, not a whole lot of meaning for most mods and isn't well defined. Also mostly useless for our purposes.}} ~[[User:Farlo|Farlo]][[File:User Farlo Sig.png|19px|link=User:Farlo]]<small>[[User talk:Farlo|Talk]]</small> 18:20, July 16, 2013 (MDT) | |||
*:: {{Fc|white|it is often difficult to assign/verify this flag}} ~[[User:Kelmych|Kelmych]] [[User talk:Kelmych|Talk]] 12:26, July 16, 2013 | |||
* {{Fc|#e6b69e|'''''IsClean'''''}} (Boolean) - Indicates that the mod's EPS/M files are free of ITM/UDR errors. | * {{Fc|#e6b69e|'''''IsClean'''''}} (Boolean) - Indicates that the mod's EPS/M files are free of ITM/UDR errors. | ||
* {{Fc|#e6b69e|'''''CleanUninstall'''''}} (Boolean) - Indicates that mod can be deactivated without corrupting save games. | * {{Fc|#e6b69e|'''''CleanUninstall'''''}} (Boolean) - Indicates that mod can be deactivated without corrupting save games. | ||
Line 48: | Line 51: | ||
* {{Fc|#e6b69e|'''''IsCore'''''}} (Boolean) - Indicates if a mod is CORE to the STEP experience. | * {{Fc|#e6b69e|'''''IsCore'''''}} (Boolean) - Indicates if a mod is CORE to the STEP experience. | ||
*: {{Fc|white|Proposed: Remove, core mods -- will be in STEP:Core, this attribute isn't tied to the mod itself.}} | *: {{Fc|white|Proposed: Remove, core mods -- will be in STEP:Core, this attribute isn't tied to the mod itself.}} | ||
*:: {{Fc|white|Agreed}} ~[[User:Farlo|Farlo]][[File:User Farlo Sig.png|19px|link=User:Farlo]]<small>[[User talk:Farlo|Talk]]</small> 18:20, July 16, 2013 (MDT) | |||
* {{Fc|#e6b69e|'''''AffectsFPS'''''}} (Boolean) - Indicates if a mod has a noticeable FPS impact. | * {{Fc|#e6b69e|'''''AffectsFPS'''''}} (Boolean) - Indicates if a mod has a noticeable FPS impact. | ||
*: {{Fc|white|Proposed: should have way to indicate whether effect is positive or negative}} | *: {{Fc|white|Proposed: should have way to indicate whether effect is positive or negative}} ~[[User:Kelmych|Kelmych]] [[User talk:Kelmych|Talk]] 12:26, July 16, 2013 | ||
*: {{Fc|white| | *:: {{Fc|white|Only Vano89's mod positively impacts performance, so this really denotes a negative impact.}} ~[[User:z929669|z929669]] [[File:Ixian_Insignia.png|25px|link=User:z929669]] [[User talk:z929669|Talk]] 15:25, July 16, 2013 (MDT) | ||
*::: {{Fc|white|But that might not be true for much longer, what if someone made a "craptastic computer pack", it might be nice to know that a mod has a positive effect. I think a choice of positive/none/negative would be well suited.}} ~[[User:Farlo|Farlo]][[File:User Farlo Sig.png|19px|link=User:Farlo]]<small>[[User talk:Farlo|Talk]]</small> 18:20, July 16, 2013 (MDT) | |||
* {{Fc|#e6b69e|'''''AffectsVRAM'''''}} (Boolean) - Indicates if a mod has a noticeable VRAM impact. | * {{Fc|#e6b69e|'''''AffectsVRAM'''''}} (Boolean) - Indicates if a mod has a noticeable VRAM impact. | ||
*: {{Fc|white| | *: {{Fc|white|[See above]}} | ||
* {{Fc|#e6b69e|'''''PerformanceAvailable'''''}} (Boolean) - Indicates if a mod has a performance version available. | * {{Fc|#e6b69e|'''''PerformanceAvailable'''''}} (Boolean) - Indicates if a mod has a performance version available. | ||
* {{Fc|#e6b69e|'''''QualityAvailable'''''}} (Boolean) - Indicates if a mod has a quality version available. | * {{Fc|#e6b69e|'''''QualityAvailable'''''}} (Boolean) - Indicates if a mod has a quality version available. | ||
*: {{Fc|white|Proposed: Replace AffectsFPS, AffectsVRAM, PerformanceAvailable, and QualityAvailable with the following:}} | *: {{Fc|white|Proposed: Replace AffectsFPS, AffectsVRAM, PerformanceAvailable, and QualityAvailable with the following:}} ~[[User:Farlo|Farlo]][[File:User Farlo Sig.png|19px|link=User:Farlo]]<small>[[User talk:Farlo|Talk]]</small> 18:20, July 16, 2013 (MDT) | ||
*:* {{Fc|#9eb6e6|'''''QualityItems'''''}} {{Fc|white|(object) - Multiple-instance template containing:}} | *:* {{Fc|#9eb6e6|'''''QualityItems'''''}} {{Fc|white|(object) - Multiple-instance template containing:}} | ||
*:** {{Fc|#9eb6e6|'''''QualityValue'''''}} {{Fc|white|(string) - Available graphical tiers or options available (2048, 1024, High, Low, etc.).}} | *:** {{Fc|#9eb6e6|'''''QualityValue'''''}} {{Fc|white|(string) - Available graphical tiers or options available (2048, 1024, High, Low, etc.).}} |
Revision as of 00:20, July 17, 2013
New Properties for STEP Guides - WIP (Discussion Page)[edit source]
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)