Help:Style guide/Versions: Difference between revisions
m (Editing navbox) |
(Hefty overhaul) |
||
| Line 4: | Line 4: | ||
== Summary == | == Summary == | ||
Before all article content, the {{Tl| | Before all article content, the {{Tl|Version info}} 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. | 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 === | === Examples === | ||
'''Major | '''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. | '''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 | '''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. | '''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 a development version for [[1.17.0]] released on August 9, 2022, which fixes several major issues and includes a few minor tweaks. | |||
== Version changes == | == Version changes == | ||
Every change made by a game version should be categorized into one of | 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 | * '''Additions''': Any new content, be it blocks/items or entirely new systems and features introduced in this version | ||
* '''Changes''': Changes made to | * '''Changes''': 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 | |||
Each section apart from '''API Changes''' should have its' 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 | |||
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 == | === 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: | 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 <''previous stable version''> | ||
| Line 47: | Line 48: | ||
{{Editing navbox}} | {{Editing navbox}} | ||
[[Category:Style guides]] | |||
Revision as of 23:27, 27 August 2022
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 {{Version info}} 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 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 a development version for 1.17.0 released on August 9, 2022, which fixes several major issues and includes a few minor tweaks.
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
- Changes: 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
Each section apart from API Changes should have its' 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
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. On stable game version articles, these should be categorized under the following headers:
- Since <previous stable version>
- Since the previous development version
| Editing articles | |
|---|---|
| Hubs | Community noticeboard |
| Guides | How to help • How to translate the wiki |
| Styling | Style guide • Versions |
