STEP:Versioning: Difference between revisions

From Step Mods | Change The Game
Line 34: Line 34:
* Optional Lighting & Weather (LW) Patch: '''Step Patch - Lighting and Weather.es''x'''''
* Optional Lighting & Weather (LW) Patch: '''Step Patch - Lighting and Weather.es''x'''''
* Optional Post-Processing (PP) Patch: '''Step Patch - Post Processing.es''x'''''
* Optional Post-Processing (PP) Patch: '''Step Patch - Post Processing.es''x'''''
{{Fc|salmon|NOTE: ''Archive name formats are identical to plugin name formats but for the extension (*.es''x''''' vs *.7z).''}}


==== Nexus File Labels ====
==== Nexus File Labels ====
Line 42: Line 43:
* Miscellaneous files: '''Step WhateverThisFileIs'''
* Miscellaneous files: '''Step WhateverThisFileIs'''


{{Fc|yellow|Rule: Nexus mod 'global' version, Nexus Main File version, and Step wiki Guide version remain in sync for any particular Guide iteration.}}
{{Fc|yellow|Rule: Nexus mod 'global' version, Nexus Main File version, and Step wiki Guide version remain in sync for any particular Guide iteration. Files downloaded from Nexus are named using the file ''label'' appended with <code>-modID-fileVersion-Timestamp</code>.}}


    Nexus mod & Guide version string (see Step Versioning)
==== Examples (SSE) ====
        ONLY changes with the wiki Guide version string
The following is a hypothetical example for Step SkyrimSE Guide version 1.2. Files were downloaded on Thursday, January 19, 2023 2:52:42 AM. 1674096762
        Sets the Nexus page version string until the Guide version itself is incremented
        Syntax: #.#.# (the third slot may be redundant ... see note further below)
    Nexus file label & upload archive name (these always remain in sync but for the upload archive 7z extension)
        NEVER change on updates to Nexus file
        Main File names are IDENTICAL across Game guides
        Must be unique within Nexus page/Game
        Use file descriptions (NOT file labels) to provide further info about the file. This minimizes the length of file labels.
        Match plugin nomenclature where practical
    Nexus file version string
        ALWAYS change on updates to Nexus file UNLESS it's the Main File (which is updated only with new guide release)
        Nexus appends -modID-fileVersion-Timestamp to all downloads. Adding to the uploaded file name is REDUNDANT.
        Should be unique within a Game Nexus page/Guide (but we still need to determine this ... see note further below)
        Syntax: #.#.#.ABBR (append .Update## on update; or : .#.#.# version string for things like ENB)


   
Key:   
  NexusFileLabel  |    NexusArchiveName.7z  |    DownloadedArchiveName.7z    |    {WikiGuideVersionString}[.{UniquFileID[Version]}]


Examples (SSE)
===== Main Files =====


Key:      fileLabel  |    archiveName.7z   |    {guideVersionString}.{fileString[Version]}
Step Patch - Conflict Resolution    |    Step Patch - Conflict Resolution.7z   |    Step Patch - Conflict Resolution-31054-1-2-1674096762.7z    |    1.2


Main Files
===== Update Files =====
 
    Step Patch - Conflict Resolution    |    Step Patch - Conflict Resolution.7z    |    2.2.0
 
Update Files


Update Files most likely behave as Main Files, so include only changed files rather than all assets. Indicate version increment using the third slot, and DO NOT increment the global version likewise (i.e., the global and Main File versions are always in sync and only change with a new guide release). So NEVER update the Main File in place. Always add the incremented version update to Update Files, since these should always include only changed assets (e.g., the plugin is updated, and the Main File is still required).
Update Files most likely behave as Main Files, so include only changed files rather than all assets. Indicate version increment using the third slot, and DO NOT increment the global version likewise (i.e., the global and Main File versions are always in sync and only change with a new guide release). So NEVER update the Main File in place. Always add the incremented version update to Update Files, since these should always include only changed assets (e.g., the plugin is updated, and the Main File is still required).
Line 76: Line 61:
We know this will not update the global version, but will MO flag this version? If it does, then the version must remain 2.2.0, and the 'hotfix' version in the third slot is basically redundant, since it will never change unless we want to release a new wiki guide with hotfix version increments (no way!).
We know this will not update the global version, but will MO flag this version? If it does, then the version must remain 2.2.0, and the 'hotfix' version in the third slot is basically redundant, since it will never change unless we want to release a new wiki guide with hotfix version increments (no way!).


    Step Patch - Conflict Resolution    |  Step Patch - Conflict Resolution.7z    |    2.2.1
Step Patch - Conflict Resolution    |  Step Patch - Conflict Resolution.7z    |    2.2.1


Optional Files
===== Optional Files =====


Optional Files versions increment independent of the global version, so these are tracked by MO. Always tick the box for "This is a new version of an existing file (optional)" when updating Optional Files. This will archive the previous version without having to manually clean it up.
Optional Files versions increment independent of the global version, so these are tracked by MO. Always tick the box for "This is a new version of an existing file (optional)" when updating Optional Files. This will archive the previous version without having to manually clean it up.


    Step Patch - CACO  |    Step Patch - CACO.7z  |    2.2.0.CACO
Step Patch - CACO  |    Step Patch - CACO.7z  |    2.2.0.CACO
    Step Patch - CCOR  |    Step Patch - CCOR.7z  |    2.2.0.CCOR
Step Patch - CCOR  |    Step Patch - CCOR.7z  |    2.2.0.CCOR
    Step Patch - TCIY  |    Step Patch - TCIY.7z  |    2.2.0.TCIY
Step Patch - TCIY  |    Step Patch - TCIY.7z  |    2.2.0.TCIY
    Step Patch - Lighting and Weather  |    Step Patch - Lighting and Weather.7z  |    2.2.0.LW
Step Patch - Lighting and Weather  |    Step Patch - Lighting and Weather.7z  |    2.2.0.LW
    Step Patch - Post Processing        |    Step Patch - Post Processing.7z        |    2.2.0.PP
Step Patch - Post Processing        |    Step Patch - Post Processing.7z        |    2.2.0.PP


Miscellaneous Files
===== Miscellaneous Files =====


Miscellaneous Files versions increment independent of the global version, so these are tracked by MO. Always tick the box for "This is a new version of an existing file (optional)" when updating Miscellaneous Files. This will archive the previous version without having to manually clean it up. Arguably, GRASS could also be under Optional Files.
Miscellaneous Files versions increment independent of the global version, so these are tracked by MO. Always tick the box for "This is a new version of an existing file (optional)" when updating Miscellaneous Files. This will archive the previous version without having to manually clean it up. Arguably, GRASS could also be under Optional Files.


    Step ENB - Heavy          |    Step ENB - Heavy.7z          |    2.2.0.ENB.HV.0.4.0
Step ENB - Heavy          |    Step ENB - Heavy.7z          |    2.2.0.ENB.HV.0.4.0
    Step ENB - Light          |    Step ENB - Light.7z          |    2.2.0.ENB.LT.0.4.0
Step ENB - Light          |    Step ENB - Light.7z          |    2.2.0.ENB.LT.0.4.0
    Step ENB - Milk Drinker  |    Step ENB - Milk Drinker.7z  |    2.2.0.ENB.MD.0.4.0
Step ENB - Milk Drinker  |    Step ENB - Milk Drinker.7z  |    2.2.0.ENB.MD.0.4.0
    Step Grass          |    Step Grass.7z                |    2.2.0.GRASS
Step Grass          |    Step Grass.7z                |    2.2.0.GRASS

Revision as of 02:54, January 19, 2023

Delta c.png

Step Versioning Scheme

Scheme used for official Step Game Guides

by: Step Modifications  | Forum Topic

Implemented as of Step SkyrimLE Guide v2.10.0

Major.Minor.NexusUpdate[edit | edit source]

  • Major - introduce new functionality, mod groups, guide section, tools, or methods. (e.g., fundamental changes to tools or methodology, adding a new mod group, etc.)
  • Minor - changes to guide mod list or tool instructions. (e.g., adding/removing/repositioning mods, significant changes to settings or methods, etc.)
  • NexusUpdate - changes/fixes that impact the Nexus files and require immediate remedial action. (e.g., Patch updates, asset changes, etc.) NOTE: The third slot is no longer used in the versioning on this website as of Jan, 2023. This slot is ONLY used on Nexus to indicate a hotfix to an existing file for the Step guide with matching major/minor versioning. Past Step guides will retain the third slot in the versioning scheme.

Additionally ...

  • New Step guides will always begin at 1.0 (1.0.0 on Nexus).
  • A vewrsion increment to NexusUpdate will always be indicated in the Post-Release Changes section at top of the changelog of the guide with major/minor version matching the Nexus page.

No Man's Sky Exception[edit | edit source]

Since No Man's Sky is not a Bethesda game it has slightly different rules regarding incrementing Minor versions. The following will cause a minor-version increment:

  • changes to guide mod list or tool instructions (e.g., adding/removing mods, switching a mod from MO installation to AMUMSS, etc.)
  • changes to the game's version name (e.g., NMS:Frontiers becomes NMS:Expeditions, NMS:Sentinel becomes NMS:Outlaws, etc.)
    • Expedition updates do not trigger Minor version updates
    • Game updates without a version name change (e.g., NMS:Sentinel v3.83 to NMS:Sentinel v3.84) are updated in-place and do not increment any version numbers.
      This is due to HelloGames patch release conduct, which are quick and multiple patch releases following any major update (version name changes). It's common for these updates to happen twice a week or more, therefore these minor patch updates are handled without implementing a new guide version.

Examples[edit | edit source]

Hypothetical Step-guide version example: 6.2.(0)

  • Increment of the major version from 5 to 6 brought changes to lighting, added post processing, and introduced methodological changes to the LODGen process.
  • Increment of the minor version from 1 to 2 brought changes to the mod lineup, some BethINI settings, and DynDOLOD settings.
  • Increment of the NexusUpdate version from 0 to 1 was due to a hotfix of select Step patches.

Nexus File/Version Maintenance[edit | edit source]

File Nomenclature[edit | edit source]

Rule: File naming & organization conventions are IDENTICAL across Game guides.

Plugin File Names[edit | edit source]

  • Required Conflict Resolution (CR) Patch: Step Patch - Conflict Resolution.esx
  • Optional CR patches: Step Patch - ABBR.esx
  • Optional Lighting & Weather (LW) Patch: Step Patch - Lighting and Weather.esx
  • Optional Post-Processing (PP) Patch: Step Patch - Post Processing.esx

NOTE: Archive name formats are identical to plugin name formats but for the extension (*.esx vs *.7z).

Nexus File Labels[edit | edit source]

  • Required Conflict Resolution (CR) Patch: Step Patch - Conflict Resolution
  • Optional CR patches: Step Patch - ABBR
  • Optional Lighting & Weather (LW) Patch: Step Patch - Lighting and Weather
  • Optional Post-Processing (PP) Patch: Step Patch - Post Processing
  • Miscellaneous files: Step WhateverThisFileIs

Rule: Nexus mod 'global' version, Nexus Main File version, and Step wiki Guide version remain in sync for any particular Guide iteration. Files downloaded from Nexus are named using the file label appended with -modID-fileVersion-Timestamp.

Examples (SSE)[edit | edit source]

The following is a hypothetical example for Step SkyrimSE Guide version 1.2. Files were downloaded on Thursday, January 19, 2023 2:52:42 AM. 1674096762

Key: 

NexusFileLabel   |    NexusArchiveName.7z   |    DownloadedArchiveName.7z    |    {WikiGuideVersionString}[.{UniquFileID[Version]}]
Main Files[edit | edit source]
Step Patch - Conflict Resolution    |    Step Patch - Conflict Resolution.7z    |    Step Patch - Conflict Resolution-31054-1-2-1674096762.7z    |    1.2
Update Files[edit | edit source]

Update Files most likely behave as Main Files, so include only changed files rather than all assets. Indicate version increment using the third slot, and DO NOT increment the global version likewise (i.e., the global and Main File versions are always in sync and only change with a new guide release). So NEVER update the Main File in place. Always add the incremented version update to Update Files, since these should always include only changed assets (e.g., the plugin is updated, and the Main File is still required).

We know this will not update the global version, but will MO flag this version? If it does, then the version must remain 2.2.0, and the 'hotfix' version in the third slot is basically redundant, since it will never change unless we want to release a new wiki guide with hotfix version increments (no way!). 

Step Patch - Conflict Resolution    |   Step Patch - Conflict Resolution.7z    |    2.2.1
Optional Files[edit | edit source]

Optional Files versions increment independent of the global version, so these are tracked by MO. Always tick the box for "This is a new version of an existing file (optional)" when updating Optional Files. This will archive the previous version without having to manually clean it up. 

Step Patch - CACO   |    Step Patch - CACO.7z   |    2.2.0.CACO
Step Patch - CCOR   |    Step Patch - CCOR.7z   |    2.2.0.CCOR
Step Patch - TCIY   |    Step Patch - TCIY.7z   |    2.2.0.TCIY
Step Patch - Lighting and Weather   |    Step Patch - Lighting and Weather.7z   |    2.2.0.LW
Step Patch - Post Processing        |    Step Patch - Post Processing.7z        |    2.2.0.PP
Miscellaneous Files[edit | edit source]

Miscellaneous Files versions increment independent of the global version, so these are tracked by MO. Always tick the box for "This is a new version of an existing file (optional)" when updating Miscellaneous Files. This will archive the previous version without having to manually clean it up. Arguably, GRASS could also be under Optional Files. 

Step ENB - Heavy          |    Step ENB - Heavy.7z          |    2.2.0.ENB.HV.0.4.0
Step ENB - Light          |    Step ENB - Light.7z          |    2.2.0.ENB.LT.0.4.0
Step ENB - Milk Drinker   |    Step ENB - Milk Drinker.7z   |    2.2.0.ENB.MD.0.4.0
Step Grass          |    Step Grass.7z                |    2.2.0.GRASS
Retrieved from "https://stepmodifications.org/wiki/index.php?title=STEP:Versioning&oldid=182405"