STEP:Versioning: Difference between revisions

Latest revision as of 15:28, March 30, 2023

Step Versioning Scheme

Scheme used for official Step Game Guides

by: Step Modifications | Forum Topic

Implemented after Feb, 2023

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 Feb, 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 version 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.

Examples[edit | edit source]

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

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

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.

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 and 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 and 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.

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.
NOTE: The #.# version scheme prefixed on every file version name is consistent.
Files downloaded from Nexus are named using the file label appended with -modID-fileVersion-Timestamp.

WIKI/NEXUS GLOBAL VERSION = 1.2

Key:

NexusFileLabel                      |    NexusArchiveName.7z                    |    DownloadedArchiveName.7z    |    {GuideVersionString}[.{ABBR[.Version]}]

Main Files[edit | edit source]

As long as the version of the Main File matches the global page version, MO will not flag this for update. Recall that the global version is tied to the wiki guide, so it must remain unchanged until the wiki guide is updated.

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]

This is for updates to the Main File ONLY. Like the Main File, it's versioning is tied to the global version, and this will always be flagged for update by MO. Updating the Main File to this version --with replacement or not-- has the same effect, so merging or separating this file on install will flag it as outdated in MO.

Step Patch - Conflict Resolution    |    Step Patch - Conflict Resolution.7z    |    Step Patch - Conflict Resolution-31054-1-2-1674096762.7z    |    1.2.1

Optional Files[edit | edit source]

Note that CACO and LW patches have been updated previously.

Step Patch - CACO                   |    Step Patch - CACO.7z                   |    Step Patch - CACO-31054-1-2-1674096762.7z                   |    1.2.1.CACO
Step Patch - CCOR                   |    Step Patch - CACO.7z                   |    Step Patch - CACO-31054-1-2-1674096762.7z                   |    1.2.CCOR
Step Patch - Lighting and Weather   |    Step Patch - Lighting and Weather.7z   |    Step Patch - Lighting and Weather-31054-1-2-1674096762.7z   |    1.2.2.LW
Step Patch - Post Processing        |    Step Patch - Post Processing.7z        |    Step Patch - Post Processing-31054-1-2-1674096762.7z        |    1.2.PP
Step Patch - TCIY                   |    Step Patch - TCIY.7z                   |    Step Patch - TCIY-31054-1-2-1674096762.7z                   |    1.2.TCIY

Miscellaneous Files[edit | edit source]

Note that ENB includes its own versioning apart from the Guide/mod versioning and is appended to the end of the version string. Note also that the ENB versions were updated from v4.9 and re-uploaded, incrementing both file and ENB version strings.
NOTE: Step Grass could just as well be under Optional Files.

Step ENB - Heavy          |    Step ENB - Heavy.7z          |    Step ENB - Heavy-31054-1-2-1674096762.7z          |    1.2.1.ENB.HV.0.5.0
Step ENB - Light          |    Step ENB - Light.7z          |    Step ENB - Light-31054-1-2-1674096762.7z          |    1.2.1.ENB.LT.0.5.0
Step ENB - Milk Drinker   |    Step ENB - Milk Drinker.7z   |    Step ENB - Milk Drinker-31054-1-2-1674096762.7z   |    1.2.1.ENB.MD.0.5.0
Step Grass                |    Step Grass.7z                |    Step Grass-31054-1-2-1674096762.7z                |    1.2.GRASS

@@ Line 1: / Line 1: @@
 __NOTOC__[[Category:Administration]]
 {{PageTitle|title=Step Versioning Scheme|subtitle=Scheme used for official Step Game Guides|author=Step Modifications|forumtid=16846}}
-: {{fc|highlight|''Implemented as of Step SkyrimLE Guide v2.10.0''}}
+: {{fc|highlight|''Implemented after Feb, 2023''}}
-==={{fc|green|Major}}.{{Fc|orange|Minor}}.{{Fc|highlight|Hotfix}}===
+==={{fc|green|Major}}.{{Fc|orange|Minor}}.{{Fc|highlight|NexusUpdate}}===
-* {{fc|green|Major}} - introduce new functionality, mod groups, guide section, tools, or methods. (e.g., changing from Wrye Bash to MO, adding a new tool, adding a new mod group, etc.)
+* {{fc|green|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.)
-* {{Fc|orange|Minor}} - changes to guide mod list or tool instructions. (e.g., adding/removing mods, changing selections in BethINI, etc.)
+* {{Fc|orange|Minor}} - changes to guide mod list or tool instructions. (e.g., adding/removing/repositioning mods, significant changes to settings or methods, etc.)
-* {{Fc|highlight|Hotfix}} - changes/fixes that require immediate remedial actions. (e.g., corrections to guide instructions, changes to mod install order, updates to mod instructions, Patch updates, etc.)
+* {{Fc|highlight|NexusUpdate}} - changes/fixes that impact the Nexus files and require immediate remedial action. (e.g., Patch updates, asset changes, etc.)<br>
-** Hotfixes are typically released when a small collection of these "fixes" have accumulated. Until that time, changes will be reflected on the current Changelog.
+*: {{Fc|salmon|'''''NOTE:''' The third slot is no longer used in the versioning on this website as of Feb, 2023. This slot is ONLY used on Nexus to indicate a hotfix to an existing file for the Step guide with matching {{fc|green|Major}}/{{Fc|orange|Minor}} versioning. Past Step guides will retain the third slot in the versioning scheme.''}}
-* If a guide version is in a pre-release state, the version number may have a 'b' suffix to indicate a 'beta' version state.
-====Under this scheme====
+Additionally ...
-<p>'''New Guide Versioning''': {{fc|green|1}}.{{Fc|orange|0}}.{{Fc|highlight|0}}</p>
+* New Step guides will always begin at 1.0 (1.0.0 on Nexus).
-* New guides start at the beginning of the versioning scheme.
+* A version 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.
-<p>'''Beta Versioning''': {{fc|green|0}}.{{Fc|orange|1}}.{{Fc|highlight|0}}</p>
+===Examples===
-* {{fc|green|Major}} is always {{fc|green|0}} when releases are in a beta state. Only a full release can trigger a change to {{fc|green|Major}}, at which point version defaults New Guide versioning.
+Hypothetical Step-guide version example: {{fc|green|6}}.{{Fc|orange|2}}.({{fc|highlight|0}})
-* The remainder of the scheme will remain the same.
+* Increment of the major version from {{fc|green|5}} to {{fc|green|6}} could bring changes to lighting, added post processing, and introduced methodological changes to the LODGen process.
+* Increment of the minor version from {{fc|orange|1}} to {{fc|orange|2}} could bring changes to the mod lineup, some BethINI settings, and DynDOLOD settings.
+* Increment of the NexusUpdate version from {{fc|highlight|0}} to {{fc|highlight|1}} might be a hotfix of select Step patches.
 ===No Man's Sky Exception===
-Since No Man's Sky is not a Bethesda game it has slightly different rules regarding incrementing {{Fc|orange|Minor}} versions. The following will cause an increment:
+Since No Man's Sky is not a Bethesda game it has slightly different rules regarding incrementing {{Fc|orange|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.)
-*: {{fc|instruction|Game updates '''''without''''' a version name change (e.g., ''NMS:Sentinel v'''3.83''''' to ''NMS:Sentinel v'''3.84''''') are updated in-place and '''do not''' increment any version numbers.}}<br>This is due to HelloGames haphazard patch updates after any major update, which are the "version name changes". It's not uncommon for these updates to happen twice a week, therefore these patch updates are handled without implementing a new guide version.
+** ''Expedition'' updates '''do not''' trigger Minor version updates
+** Game updates '''''without''''' a version name change (e.g., ''NMS:Sentinel v'''3.83''''' to ''NMS:Sentinel v'''3.84''''') are updated in-place and '''do not''' increment any version numbers.<br>
+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==
+== Nexus File/Version Maintenance ==
-STEP Guide version example: {{fc|green|2}}.{{Fc|orange|9}}.{{Fc|highlight|2}}
+=== File Nomenclature ===
-* {{fc|green|v2}} brought changes to mod sorting software, mod management software, and introduced alpha Pack support
+{{Fc|yellow|'''Rule:''' File naming & organization conventions are IDENTICAL across Game guides.}}
-* {{Fc|orange|v9}} constitutes nine changes to the mod lineup since the change to {{fc|green|v2}}.
-* {{Fc|highlight|v2}} constitutes two bug/hotfixes have been released since the last mod lineup change ({{Fc|orange|v9}}).
-{{AlertSmall|type=notice|text=The following are only '''hypothetical examples''' to illustrate changes that would apply to a specific level of versioning.}}
+==== Plugin File Names ====
-=====Skyrim Guides:=====
+* Required Conflict Resolution (CR) Patch: '''Step Patch - Conflict Resolution.es''x'''''
-'''Skyrim  (current Skyrim STEP Guide version)''': {{fc|green|2}}.{{Fc|orange|9}}.{{Fc|highlight|2}}
+* Optional CR patches: '''Step Patch - ABBR.es''x'''''
-* Switch to official Wrye Bash support: {{fc|green|3}}.{{Fc|orange|0}}.{{Fc|highlight|0}} (major changes resets minor/hotfix versions)
+* Optional Lighting and Weather (LW) Patch: '''Step Patch - Lighting and Weather.es''x'''''
-* Remove a mod or add new mods: {{fc|green|2}}.{{Fc|orange|10}}.{{Fc|highlight|0}} (minor changes resets hotfix version)
+* Optional Post-Processing (PP) Patch: '''Step Patch - Post Processing.es''x'''''
-* Update mod installation instructions: {{fc|green|2}}.{{Fc|orange|9}}.{{Fc|highlight|3}}
+{{Fc|salmon|NOTE: ''Archive name formats are identical to plugin name formats but for the extension (*.es''x'' vs *.7z).}}
-* Separate Extended Pack from Core Guide AND change mod management software: {{fc|green|3}}.{{Fc|orange|0}}.{{Fc|highlight|0}}
+==== Nexus File Labels ====
+* Required Conflict Resolution (CR) Patch: '''Step Patch - Conflict Resolution'''
+* Optional CR patches: '''Step Patch - ABBR'''
+* Optional Lighting and Weather (LW) Patch: '''Step Patch - Lighting and Weather'''
+* Optional Post-Processing (PP) Patch: '''Step Patch - Post Processing'''
+* 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.}}
+==== Examples (SSE) ====
+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.<br>
+{{Fc|salmon|'''''NOTE:''' The #.# version scheme prefixed on every file version name is consistent.<br>
+Files downloaded from Nexus are named using the file ''label'' appended with <code>-modID-fileVersion-Timestamp</code>.
+''}}
+ {{Fc|highlight|WIKI/NEXUS GLOBAL VERSION}} = {{Fc|orange|1.2}}
+'''Key:'''
+ {{Fc|highlight|NexusFileLabel}}                      |    {{Fc|blue|NexusArchiveName.7z}}                    |    {{Fc|green|DownloadedArchiveName.7z}}    |    {{Fc|orange|{GuideVersionString}[.{ABBR[.Version]}]}}
+===== Main Files =====
+As long as the version of the Main File matches the global page version, MO will not flag this for update. Recall that the global version is tied to the wiki guide, so it must remain unchanged until the wiki guide is updated.
+ {{Fc|highlight|Step Patch - Conflict Resolution}}    |    {{Fc|blue|Step Patch - Conflict Resolution.7z}}    |    {{Fc|green|Step Patch - Conflict Resolution-31054-1-2-1674096762.7z}}    |    {{Fc|orange|1.2}}
+===== Update Files =====
+This is for updates to the Main File ONLY. Like the Main File, it's versioning is tied to the global version, and this will always be flagged for update by MO. Updating the Main File to this version --with replacement or not-- has the same effect, so merging or separating this file on install will flag it as outdated in MO.
+ {{Fc|highlight|Step Patch - Conflict Resolution}}    |    {{Fc|blue|Step Patch - Conflict Resolution.7z}}    |    {{Fc|green|Step Patch - Conflict Resolution-31054-1-2-1674096762.7z}}    |    {{Fc|orange|1.2.1}}
+===== Optional Files =====
+Note that CACO and LW patches have been updated previously.
+ {{Fc|highlight|Step Patch - CACO}}                   |    {{Fc|blue|Step Patch - CACO.7z}}                   |    {{Fc|green|Step Patch - CACO-31054-1-2-1674096762.7z}}                   |    {{Fc|orange|1.2.1.CACO}}
+ {{Fc|highlight|Step Patch - CCOR}}                   |    {{Fc|blue|Step Patch - CACO.7z}}                   |    {{Fc|green|Step Patch - CACO-31054-1-2-1674096762.7z}}                   |    {{Fc|orange|1.2.CCOR}}
+ {{Fc|highlight|Step Patch - Lighting and Weather}}   |    {{Fc|blue|Step Patch - Lighting and Weather.7z}}   |    {{Fc|green|Step Patch - Lighting and Weather-31054-1-2-1674096762.7z}}   |    {{Fc|orange|1.2.2.LW}}
+ {{Fc|highlight|Step Patch - Post Processing}}        |    {{Fc|blue|Step Patch - Post Processing.7z}}        |    {{Fc|green|Step Patch - Post Processing-31054-1-2-1674096762.7z}}        |    {{Fc|orange|1.2.PP}}
+ {{Fc|highlight|Step Patch - TCIY}}                   |    {{Fc|blue|Step Patch - TCIY.7z}}                   |    {{Fc|green|Step Patch - TCIY-31054-1-2-1674096762.7z}}                   |    {{Fc|orange|1.2.TCIY}}
+===== Miscellaneous Files =====
+Note that ENB includes its own versioning apart from the Guide/mod versioning and is appended to the end of the version string. Note also that the ENB versions were updated from v4.9 and re-uploaded, incrementing both file and ENB version strings.<br>
+{{Fc|salmon|'''''NOTE:''' Step Grass could just as well be under Optional Files.}}
+ {{Fc|highlight|Step ENB - Heavy}}          |    {{Fc|blue|Step ENB - Heavy.7z}}          |    {{Fc|green|Step ENB - Heavy-31054-1-2-1674096762.7z}}          |    {{Fc|orange|1.2.1.ENB.HV.0.5.0}}
+ {{Fc|highlight|Step ENB - Light}}          |    {{Fc|blue|Step ENB - Light.7z}}          |    {{Fc|green|Step ENB - Light-31054-1-2-1674096762.7z}}          |    {{Fc|orange|1.2.1.ENB.LT.0.5.0}}
+ {{Fc|highlight|Step ENB - Milk Drinker}}   |    {{Fc|blue|Step ENB - Milk Drinker.7z}}   |    {{Fc|green|Step ENB - Milk Drinker-31054-1-2-1674096762.7z}}   |    {{Fc|orange|1.2.1.ENB.MD.0.5.0}}
+ {{Fc|highlight|Step Grass}}                |    {{Fc|blue|Step Grass.7z}}                |    {{Fc|green|Step Grass-31054-1-2-1674096762.7z}}                |    {{Fc|orange|1.2.GRASS}}