Jump to content

Module:Changelog/doc: Difference between revisions

From Deadlock Wiki
Browse history interactively
← Older edit
VisualWikitext
Sur (talk | contribs)
Moderators
2,108 edits
m reordered invokes; fixed category links hiding; mentioned usecase for get_last_updated; removed todo
Sur (talk | contribs)
Moderators
2,108 edits
m moved How to Edit type info over to Help:Contributing to Patch Notes
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:
Generates lines of changes for all data pages. See <nowiki>[[Category:Changelog Dates]]</nowiki> for the dates of all changelogs, and [[Changelogs]] for list of all the data pages that contain a Changelog.
Generates lines of changes for all data pages. See <nowiki>[[Category:Changelog Dates]]</nowiki> for the dates of all changelogs, and [[Changelogs]] for list of all the data pages that contain a Changelog.


=How to edit changelogs=
=Functions=
Each changelogs should be exactly as written on the forum post, so edits are rarely justified, below are the exceptions to look out for
All of these functions are callable by wikitext, i.e. <code><nowiki>{{#invoke|Changelog|invokable_name|param1|paramN}}</nowiki></code>


* Typos by the poster should have <code><nowiki>{{sic}}</nowiki></code> added so that readers know the typoe was intentionally written verbatim
==write_changelog_by_tag==
* An entity's name is old, i.e. [[Yamato]]'s [[Shadow Explosion]] was renamed to [[Shadow Transformation]]. See [[Module:Changelog/doc#Missing tags|#Missing tags]] for detailed examples
* Similarly named but unrelated entities (tags) are both mistakenly assigned, i.e. [[Barrage]] and [[Heavy Barrage]]. See [[Module:Changelog/doc#Similar tags are assigned|#Similar tags are assigned]] for detailed examples
* Entity is referenced but isn't affected by the change. See [[Module:Changelog/doc#Tag referenced but unaffected|#Tag referenced but unaffected]] for a detailed example
 
==What are tags?==
Each line in a changelog is parsed by [[User:DeadBot]] to have certain tags assigned to it. For example, if the forum post looks like <code>Abrams: Shoulder Bash blah blah</code>
 
It will be assigned tags, <code>Shoulder Bash</code> since its named explicitly, and therefore <code>Ability</code>, <code>Abrams</code>, and <code>Hero</code>. This will make this line added to all changelogs on pages [[Abrams/Update history]], [[Shoulder Bash/Update history]], [[Ability/Update history]], and [[Hero/Update history]].
 
Similarly, for the line <code>Warp Stone: Distance traveled blah blah</code>, the tags assigned would be <code>Warp Stone</code> since its named explicitly, along with the tags <code>Item</code> and <code>Weapon Item</code>.
 
 
==Missing tags==
Given the line <code>Yamato: Shadow Explosion bonus Spirit per victim increased from 10 to 15</code>, [[User:DeadBot]] will be able to assign the <code>Yamato</code> tag, but will not know which ability it is referring to, as [[Yamato]]'s ability was renamed to [[Shadow Transformation]]. This would originally appear as
 
<pre>
        "Description": "* {{PageRef|Yamato}}: Shadow Explosion bonus Spirit per victim increased from 10 to 15",
        "Tags": [
            "Yamato",
            "Hero"
        ]
</pre>
 
To correct is, simply add the related tags for Shadow Transformation. To determine the related tags, see To see all related tags, see [[Module:Changelog/doc#Tag tree]]. Add the call to [[Template:PageRef]] in the description. The <code>alt_name</code> parameter will need to be passed to nickname the ability as Shadow Explosion, so that it stays written as is, but still links and is added to the relevant pages. The corrected changelog would then be
 
<pre>
        "Description": "* {{PageRef|Yamato}}: {{PageRef|Shadow Transformation|alt_name=Shadow Explosion}} bonus Spirit per victim increased from 10 to 15",
        "Tags": [
            "Yamato",
            "Hero",
            "Ability",
            "Shadow Transformation"
        ]
</pre>
 
 
==Similar tags are assigned==
Given the line <code>* McGinnis: Heavy Barrage spirit scaling increased from 0.3 to 0.35</code>, [[User:DeadBot]] will see both [[McGinnis]]' [[Heavy Barrage]] ability and [[Pocket]]'s [[Barrage]] ability and assign both as tags. This would originally appear as
 
<pre>
        "Description": "* {{PageRef|McGinnis}}: {{PageRef|Heavy Barrage}} spirit scaling increased from 0.3 to 0.35",
        "Tags": [
            "McGinnis",
            "Hero",
            "Heavy Barrage",
            "Ability",
            "Barrage",
            "Pocket"
        ]
</pre>
 
To correct it, first determine if its referring to McGinnis' Heavy Barrage or Pocket's Barrage. In this case, it is quite obvious that its referring to McGinnis' Heavy Barrage. Then, simply remove all tags related to Pocket's Barrage. This includes both <code>"Barrage"</code> and <code>"Pocket"</code>. To determine all related tags, see [[Module:Changelog/doc#Tag tree]].
 
The corrected list of tags would then be
 
<pre>
        "Tags": [
            "McGinnis",
            "Hero",
            "Heavy Barrage",
            "Ability",
        ]
</pre>
 
Similarly, for the following example
 
<pre>
        "Description": "* {{PageRef|Torment Pulse}}: Interval improved from 2s to 1.5s",
        "Tags": [
            "Torment Pulse",
            "Item",
            "Spirit Item",
            "Pulse",
            "Ability",
            "Rutger",
            "Hero"
        ]
</pre>
 
It is actually referring to Torment Pulse the Item, so the tags <code>"Pulse"</code>, <code>"Ability"</code>, and <code>"Rutger"</code>, <code>"Hero"</code> would all need to be removed.
 
 
 
Another example, given the line:
 
<pre>
        "Description": "* {{PageRef|Cosmic Veil|alt_name=Veil}} {{PageRef|Walker}}: Cooldown increased from 20s to 25s",
        "Tags": [
            "Veil Walker",
            "Item",
            "Vitality Item",
            "Objective",
            "NPC",
            "Walker"
            "Cosmic Veil"
        ]
</pre>
 
Here, the changelog is clearly referring to the item [[Veil Walker]], not [[Cosmic Veil]]s and [[Walker]]s. The fixed line would be:
 
<pre>
        "Description": "* {{PageRef|Veil Walker}}: Cooldown increased from 20s to 25s",
        "Tags": [
            "Veil Walker",
            "Item",
            "Vitality Item",
            "Objective",
            "NPC",
        ]
</pre>
 
==Tag referenced but unaffected==
Given the line <code>Surge of Power: When the passive procs, you no longer get slowed when shooting (similar to Fleetfoot).</code>, [[User:DeadBot]] will assign the tag [[Fleetfoot]] and all its related tags, even if Fleetfloot wasn't actually changed or modified at all. This would originally appear as
 
<pre>
        "Description": "* {{PageRef|Surge of Power}}: When the passive procs, you no longer get slowed when shooting (similar to {{PageRef|Fleetfoot}})",
        "Tags": [
            "Fleetfoot",
            "Item",
            "Weapon Item",
            "Surge of Power",
            "Spirit Item"
        ]
</pre>
 
To correct it, remove Fleetfoot and all its related tags (Weapon Item tag in this case), but leave the call to PageRef so that it can still refer users to the [[Fleetfoot]] page. After correction it should be
 
<pre>
        "Description": "* {{PageRef|Surge of Power}}: When the passive procs, you no longer get slowed when shooting (similar to {{PageRef|Fleetfoot}})",
        "Tags": [
            "Item",
            "Surge of Power",
            "Spirit Item"
        ]
</pre>
 
=Tag tree=
The tag tree is how to determine what tags are related. Given a tag, the tags that are in the same chain and have a shorter indentation will/should also be added to the list of tags.
 
For example, any change to [[Frost Bomb]] will also be referenced on the pages [[Ability]], [[Kelvin]], and [[Hero]].
 
* Hero
** <hero_name> i.e. [[Abrams]]
*** Ability
**** <ability_name> i.e. [[Frost Bomb]]
* Item
** Weapon Item
*** <weapon_item_name> i.e. [[Basic Magazine]]
** Vitality Item
*** <vitality_item_name> i.e. [[Extra Health]]
** Spirit Item
*** <spirit_item_name> i.e. [[Boundless Spirit]]
* Map
* Other
 
More Tag tree examples:
* If <code>Map</code> tag is assigned, no other tags should be assigned
* If <code>Weapon Item</code> is assigned, <code>Basic Magazine</code> shouldn't be assigned unless it is also referenced in the line, but <code>Item</code> should be assigned
* If <code>Basic Magazine</code> is assigned, <code>Weapon Item</code>, and <code>Item</code> should be assigned
 
<b>The full tree can be found at [[Changelogs]]</b>
 
=Invokes=
Invokes are callable by wikitext, i.e. <code><nowiki>{{#invoke|Changelog|invokable_name|param1|paramN}}</nowiki></code>
 
==write_changelogs==
The main invokable that will be used. Given a specific tag, it outputs all relevant changelogs from all dates in a [[Template:Update history table]].
The main invokable that will be used. Given a specific tag, it outputs all relevant changelogs from all dates in a [[Template:Update history table]].


Line 180: Line 14:
===Examples===
===Examples===
For use on [[Pocket/Update history]]:
For use on [[Pocket/Update history]]:
<code><nowiki>{{#invoke:Changelog|write_changelogs|Pocket}}</nowiki></code>
<code><nowiki>{{#invoke:Changelog|write_changelog_by_tag|Pocket}}</nowiki></code>


Outputs
Outputs
{{#invoke:Changelog|write_changelogs|Pocket}}
{{#invoke:Changelog|write_changelog_by_tag|Pocket}}




For use on [[Pocket#Update history]]:
For use on [[Pocket#Update history]]:
<code><nowiki>{{#invoke:Changelog|write_changelogs|Pocket|3}}</nowiki></code>
<code><nowiki>{{#invoke:Changelog|write_changelog_by_tag|Pocket|3}}</nowiki></code>


Outputs
Outputs


{{#invoke:Changelog|write_changelogs|Pocket|3}}
{{#invoke:Changelog|write_changelog_by_tag|Pocket|3}}


==write_changelog_by_date_id==
==write_changelog_by_date_id==
Line 200: Line 34:


===Examples===
===Examples===
For a non-herolab patch page<br>
<code><nowiki>{{#invoke:Changelog|write_changelog_by_date_id|2024-05-03}}</nowiki></code>
<code><nowiki>{{#invoke:Changelog|write_changelog_by_date_id|2024-05-03}}</nowiki></code>


{{#invoke:Changelog|write_changelog_by_date_id|2024-05-03}}
{{#invoke:Changelog|write_changelog_by_date_id|2024-05-03}}
For a herolab patch page<br>
<code><nowiki>{{#invoke:Changelog|write_changelog_by_date_id|2024-12-06_HeroLab}}</nowiki></code>
{{#invoke:Changelog|write_changelog_by_date_id|2024-12-06_HeroLab}}


==write_data_pages_list==
==write_data_pages_list==
Line 218: Line 59:


==get_last_updated==
==get_last_updated==
Retrieve the last date that a tag was updated on. Planned to be used on a given tag's page, i.e. [[Basic Magazine]]'s infobox could mention that it was last updated on 2024-05-03.
Retrieve the last (or first) date that a tag was updated on. Planned to be used on a given tag's page, i.e. [[Abrams]]'s infobox could mention that it was last updated on 2024-05-03, or that Mirage was released on 2024-05-03, etc.


===Parameters===
===Parameters===
* '''tag''' - Tag to search
* '''tag''' - Tag to search
* '''last_or_first''' - Named optional - Must be ''last'' or ''first'' - defaults to ''last'' - Retrieves last or first date


===Examples===
===Examples===
Example using ''last''
<code><nowiki>{{#invoke:Changelog|get_last_updated|Basic Magazine}}</nowiki></code>
<code><nowiki>{{#invoke:Changelog|get_last_updated|Basic Magazine}}</nowiki></code>


Line 229: Line 72:


{{#invoke:Changelog|get_last_updated|Basic Magazine}}
{{#invoke:Changelog|get_last_updated|Basic Magazine}}
Example using ''first''
<code><nowiki>{{#invoke:Changelog|get_last_updated|Basic Magazine|last_or_first=first}}</nowiki></code>
Outputs
{{#invoke:Changelog|get_last_updated|Basic Magazine|last_or_first=first}}

Latest revision as of 22:16, 24 December 2024

Overview

Generates lines of changes for all data pages. See [[Category:Changelog Dates]] for the dates of all changelogs, and Changelogs for list of all the data pages that contain a Changelog.

Functions

All of these functions are callable by wikitext, i.e. {{#invoke|Changelog|invokable_name|param1|paramN}}

write_changelog_by_tag

The main invokable that will be used. Given a specific tag, it outputs all relevant changelogs from all dates in a Template:Update history table.

Parameters

  • tag - Tag to search relevant changelogs for. Should be localized, i.e. Abrams for hero_atlas in english.
  • num_dates - (OPTIONAL) Number of dates to add, recommend 3 for articles. If unprovided, defaults to all.

Examples

For use on Pocket/Update history: {{#invoke:Changelog|write_changelog_by_tag|Pocket}}

Outputs

Update Changes

May 3, 2024

  • Fixed Flying Cloak teleporting players into geometry or out of the world

May 13, 2024


May 23, 2024

  • Pocket: Barrage T3 added, now heals Pocket for 100% of its damage (33% vs non-heroes)
  • Pocket: Fixed some issues with Barrage projectiles getting caught on map geometry
  • Pocket: Flying Cloak pathing improved, it will no longer bounce erratically off map geometry

May 30, 2024

June 6, 2024

June 13, 2024


June 20, 2024


For use on Pocket#Update history: {{#invoke:Changelog|write_changelog_by_tag|Pocket|3}}

Outputs

Update Changes

May 3, 2024

  • Fixed Flying Cloak teleporting players into geometry or out of the world

May 13, 2024

write_changelog_by_date_id

Write's a specific date's changelog, as opposed to a specific tag's changelog.

Parameters

  • date_id_to_write - Date-id to write, format yyyy-mm-dd, view all at [[Category:Changelog Dates]]

Examples

For a non-herolab patch page
{{#invoke:Changelog|write_changelog_by_date_id|2024-05-03}}

Updates
← N/A May 3, 2024 May 10, 2024 →

Patch notes

General Changes

  • Added a Recommend A Friend button to the dashboard that you can use to send us requests for people to include in our playtesting
  • Added a Resources page to the dashboard which contains a browsable item shop
  • Added overhead text display when another hero uses active items
  • The hotkeys F1-F5 to change cameras to allied heroes now maps directly to the order of heroes on the top bar left to right
  • Added the Patron to the spectate-when-dead cycle if the enemy is in your base or everyone on your team is dead
  • Added support for Flex Items in the Hero Sandbox
  • Increased the range of the mouse sensitivity slider from 0.5→4.0 to 0.05→8.0
  • Increased the default framerate cap from 120 to 400
  • Improved UI display when endgame objectives are being attacked
  • Added music for when the base is under attack
  • Changed the local player icon on the the minimap to always be on top of enemy icons
  • Shop music will now only play for shops players can access
  • Postgame graphs now default to team stats rather than individual
  • Added borders around hero icons on the minimap when watching replays/spectating
  • Top bar now shows incoming players before they are fully connected
  • Added console command to hide the bar at the bottom in replays ('citadel_hide_replay_hud 1' to hide it, 'citadel_hide_replay_hud 0' to bring it back)
  • Various VOIP improvements
  • Fixed open mic threshold
  • Fixed various consistency issues with the presentation of Souls terminology, icons, etc
  • Fixed Flying Cloak teleporting players into geometry or out of the world
  • Fixed Warp Stone teleporting you through geometry
  • Fixed Fixation decimal point display
  • Fixed Parry animation not playing
  • Fixed various issues with the spectate UI display
  • Removed the slow climbing vertical recoil on Yamato's alt fire
  • Fixed AP count not showing if you are dead, spectating a team mate or when holding alt/tab to upgrade your abilities

Gameplay Changes


For a herolab patch page
{{#invoke:Changelog|write_changelog_by_date_id|2024-12-06_HeroLab}}

date id 2024-12-06_HeroLab not found

write_data_pages_list

Writes list of all changelog data pages using the list of patches at Data:ChangelogConfigs.json. Used on [[Category:Changelog Dates]].

Parameters

None

Examples

{{#invoke:Changelog|write_data_pages_list}}

Outputs

Data:Changelog 2024-05-03.json
Data:Changelog 2024-05-10.json
Data:Changelog 2024-05-13.json
Data:Changelog 2024-05-16.json
Data:Changelog 2024-05-19.json
Data:Changelog 2024-05-23.json
Data:Changelog 2024-05-24.json
Data:Changelog 2024-05-30.json
Data:Changelog 2024-06-01.json
Data:Changelog 2024-06-06.json
Data:Changelog 2024-06-07.json
Data:Changelog 2024-06-13.json
Data:Changelog 2024-06-14.json
Data:Changelog 2024-06-16.json
Data:Changelog 2024-06-20.json

get_last_updated

Retrieve the last (or first) date that a tag was updated on. Planned to be used on a given tag's page, i.e. Abrams's infobox could mention that it was last updated on 2024-05-03, or that Mirage was released on 2024-05-03, etc.

Parameters

  • tag - Tag to search
  • last_or_first - Named optional - Must be last or first - defaults to last - Retrieves last or first date

Examples

Example using last {{#invoke:Changelog|get_last_updated|Basic Magazine}}

Outputs

May 30, 2024


Example using first {{#invoke:Changelog|get_last_updated|Basic Magazine|last_or_first=first}}

Outputs

May 30, 2024

Retrieved from "https://deadlock.wiki/index.php?title=Module:Changelog/doc&oldid=17777"