Help:Style guide/Versions

All version pages should follow this style guide in order to maintain page styling consistency.

The Version history page should only link to stable versions of Vintage Story. Any release candidate or pre-release versions should be linked to via their respective parent version.

Summary

Before all article content, the {{VersionInfo}} template should be used.

The summary section of a versions' article should state the version name, its' release date, as well as a general overview of the changes made in said version relative to the previous stable release. If the major version has a subtitle, this should also be referenced in the summary.

Examples

Major updates

1.17.0, also known as the De-Jank and Game Juice Update is a major update that is currently unreleased, the main focus of which is to improve various backend systems as well as graphical features in order to improve the overall experience of the game.

Minor updates

1.16.5 is a minor update released on April 13, 2022, which makes two small tweaks, some API changes, and fixes a handful of bugs.

Version changes

Every change made by a game version should be categorized into one of two sections:

• Additions: Any new content, be it blocks/items or entirely new systems and features introduced in this version
• Changes: Changes made to content already in the game prior to this version - this includes both bug fixes and tweaks

These should be the two main sections of the article.

Additions

To further organise the articles, additions should be categorized into any of the following sub-sections that fit:

• Blocks: New blocks first introduced in this version
• Items: New items introduced in this version - this can include anything from weapons and tools, to armor or food
• Mobs: New animals and enemies
• Gameplay: New systems or additions to previous systems that relate directly to gameplay, such as new UI elements, or other miscellaneous gameplay mechanics
• Commands: Anything pertaining to client and/or server commands
• World generation: Any new structures, biomes, or overall major world generation changes
• General: Additions that don't fit into other categories i.e. additions relating to weather, visual effects, or so on

Changes

Similarly to additions, changes should be categorized into one of the following sub-sections:

• Fixes: Bug/glitch fixes
• Tweaks: Minor changes pertaining to previously released content
• API Changes: Modifications made to the modding API, fixes and tweaks

Fixes

Bug fixes presented on a stable version article should include all development version fixes as well. On stable game version articles, these should be categorized under the following headers:

• Since <previous stable version>
• Since the previous development version