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.
The Versions page lists all game versions, and can serve as a guide on which need to be added.
Summary
Before all article content, the {{Version info}} template should be used.
The summary section of a version's 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.
For versions that released within a few hours of each other in order to hotfix major issues (it happens a lot), a page for the original version should be made, while the subsequent immediate hotfixes should redirect to it. The page should also mention those hotfixes directly. (See 1.17.0-rc.6 for an example).
Examples
Major versions
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 versions
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.
Development versions
1.17.0-rc.5 is the 5th release candidate for 1.17.0, released on August 9, 2022, which fixes several major issues.
Version changes
Every change made by a game version should be categorized into one of four sections:
- Additions: Any new content, be it blocks/items or entirely new systems and features introduced in this version
- Tweaks: Changes made to features already in the game prior to this version
- Fixes: Any bug fixes made in this patch
- API changes: Modifications made to the game's modding API
Additions and Tweaks should have their relevant changes categorized in the following sub-sections:
- Blocks: Changes relating to blocks
- Items: Changes relating to items - this includes things such as food, armour or tools
- Mobs: Changes relating to animals, enemies and NPCs
- Gameplay: Changes relating to systems that relate directly to gameplay, such as UI elements, or other miscellaneous gameplay mechanics
- Commands: Changes pertaining to client and/or server commands
- World generation: Changes to structures, biomes, or the general world generation systems
- General: Changes that don't fit into other categories i.e. changes relating to weather, visual effects, or so on
API changes should be categorized as:
- Additions
- Refactorings
- Tweaks
- Fixes
Individual changes under the latter sub-categories should be formatted as description lists followed by bullet points, eg.
; [[Armor]] * Simplified brigdadine and leather armor repair recipes.
All changes made in the development versions of a stable patch should be included in the latters' page. i.e. changes made in 1.17.0-pre.1 to rc.7 should all be included in the 1.17.0 page.
Fixes
Bug fixes presented on a stable version article should include all development version fixes as well. Any bug fixes made between the final development version and the relevant stable version should be placed under:
- Since the previous development version
References
The end of every version article should use the {{Reference}} template to link to the official patch notes, like so:
#{{Reference|https://www.vintagestory.at/blog.html/news/fruit-tree-fix-more-vintagehosting-and-development-update-v1165-rc1-r320/|Fruit tree fix, more Vintagehosting and Development update (v1.16.5-rc.1)|Vintagestory.at, April 1, 2022}}
- "Fruit tree fix, more Vintagehosting and Development update (v1.16.5-rc.1)"– Vintagestory.at, April 1, 2022
Categories
Version categories are added automatically through the {{Version info}} template. Development version categories are further only added if the templates' type parameter is used. However, in order for the template to present relative development version links on stable versions, the respective category pages need to first be created, similarly to Release candidate builds used for 1.17.0..
Check the development version links in 1.17.0 for examples.
| Editing articles | |
|---|---|
| Hubs | Community noticeboard |
| Guides | How to help • How to translate the wiki |
| Styling | Style guide • Versions |
