Module:GameVersion/doc: Difference between revisions
From Vanguard Galaxy Wiki
More actions
Content deleted Content added
Doc for Module:GameVersion |
Update doc for stable/beta/status |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
Single source of truth for the current ''Vanguard Galaxy'' |
Single source of truth for the current ''Vanguard Galaxy'' version state. |
||
== |
== Configuration == |
||
Edit two values at the top of [[Module:GameVersion]] once per release: |
|||
Bump the <code>CURRENT</code> string in [[Module:GameVersion]] once per game release. Every {{tl|Ver}} stamp on the wiki re-evaluates against it, so pages written for an older version turn red and drop into the matching tracking category automatically. |
|||
; <code>STABLE</code> |
|||
: The latest stable public release. Content stamped at this version reads as current. |
|||
; <code>BETA</code> |
|||
: The current beta / preview line (or <code>""</code> if none). Content newer than STABLE reads as beta. |
|||
Promote a beta by setting <code>STABLE</code> to the old <code>BETA</code> value — every {{tl|Ver}} stamp for that version turns green automatically. |
|||
== Entry points == |
== Entry points == |
||
; <code>{{#invoke:GameVersion| |
; <code>{{#invoke:GameVersion|stable}}</code> / <code>|beta</code> |
||
: Return the configured version strings. |
|||
: Returns the current version string (e.g. <code>0.8.1</code>). Used by {{tl|Ver}}. |
|||
; <code> |
; <code>{{#invoke:GameVersion|status|<var>v</var>}}</code> |
||
: Returns <code>current</code> / <code>beta</code> / <code>outdated</code> / <code>unknown</code> for version <var>v</var>. Used by {{tl|Ver}}. |
|||
: Plain-Lua accessor for other modules. |
|||
; <code>require('Module:GameVersion')</code> |
|||
: Exposes <code>stableVersion</code>, <code>betaVersion</code>, and <code>_cmp(a,b)</code> for other modules. |
|||
== See also == |
== See also == |
||
Latest revision as of 22:26, 2 June 2026
Template:Documentation subpage Single source of truth for the current Vanguard Galaxy version state.
Configuration
Edit two values at the top of Module:GameVersion once per release:
STABLE- The latest stable public release. Content stamped at this version reads as current.
BETA- The current beta / preview line (or
""if none). Content newer than STABLE reads as beta.
Promote a beta by setting STABLE to the old BETA value — every Template:Tl stamp for that version turns green automatically.
Entry points
0.8.0/|beta- Return the configured version strings.
outdated- Returns
current/beta/outdated/unknownfor version v. Used by Template:Tl. require('Module:GameVersion')- Exposes
stableVersion,betaVersion, and_cmp(a,b)for other modules.
See also
- Template:Tl — the per-content version stamp that consumes this module.