Jump to content

Module:Changelog/doc: Difference between revisions

From Deadlock Wiki
Sur (talk | contribs)
m write_data_pages_list: point to Data:Changelog Dates
Sur (talk | contribs)
m moved How to Edit type info over to Help:Contributing to Patch Notes
 
(24 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Overview=
=Overview=
Generates changelog lines from data pages such as [[Data:Changelog_05-03-2024.json]]
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 some exceptions
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 it was intentionally written verbosely by the wiki
==write_changelog_by_tag==
* While the written portion should be 1:1, sometimes an Ability name is old, or hyperlinks in the PageRef template calls are unnecessarily broken
** For the line "Shadow Explosion now deals ...", note that the ability is now called "Shadow Transformation", meaning it was not picked up by the backend to have it be <code><nowiki>"{{PageRef|Shadow Transformation}} now deals..."</nowiki></code>, as such, edit the line in the data page (browse changelog data pages at [[Changelog Dates]] which pulls from all dates in [[Data:Changelog Dates]] (WIP)) to be <code><nowiki>"{{PageRef|Shadow Transformation|alt=Shadow Explosion}} now deals..."</nowiki></code>
** This will then appear as "{{PageRef|Shadow Transformation|Shadow Explosion}} now deals...", allowing the icon and hyperlink to [[Shadow Transformation]] page to function, while still showing it 1:1 as "Shadow Explosion"
 
=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 22: 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'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 <nowiki>[[Category:Changelog Dates]]</nowiki>
 
===Examples===
For a non-herolab patch page<br>
<code><nowiki>{{#invoke:Changelog|write_changelog_by_date_id|2024-05-03}}</nowiki></code>
 
{{#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==
Writes list of all changelog data pages using the list of dates at [[Data:Changelog Dates]]. Used on [[Changelog Dates]].
Writes list of all changelog data pages using the list of patches at [[Data:ChangelogConfigs.json]]. Used on <nowiki>[[Category:Changelog Dates]]</nowiki>.


===Parameters===
===Parameters===
Line 48: Line 58:
{{#invoke:Changelog|write_data_pages_list}}
{{#invoke:Changelog|write_data_pages_list}}


=Notes=
==get_last_updated==
To see list of all tags, see [[Changelog Tags]] (WIP). To see all tags that aren't individual entities, see [[Changelogs]] (WIP). More notes will also be at these pages, not just a list of tags.
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.


=What are tags?=
===Parameters===
Each line in a changelog is parsed to have certain tags assigned to it. For example, if the forum post looks like
* '''tag''' - Tag to search
Heroes:
* '''last_or_first''' - Named optional - Must be ''last'' or ''first'' - defaults to ''last'' - Retrieves last or first date
- Abrams: Shoulder Bash blah blah


The "Abrams: Shoulder Bash blah blah" line will be assigned tags, 'Shoulder Bash' since its named explicitly, and therefore 'Abilities', 'Abrams', and 'Heroes'. This will make this line added to all changelogs on pages [[Abrams/Update history]], [[Shoulder Bash/Update history]], [[Abilities/Update history]], and [[Heroes/Update history]].
===Examples===
Example using ''last''
<code><nowiki>{{#invoke:Changelog|get_last_updated|Basic Magazine}}</nowiki></code>


Similarly, for the line "Warp Stone: Distance traveled blah blah", the tags assigned would be 'Warp Stone' since its named explicitly, along with the tags 'Items' and 'Weapon Items'.
Outputs


=Todo=
{{#invoke:Changelog|get_last_updated|Basic Magazine}}
<b>Backend</b>
 
* Replace hyphens with asterisk to be bullet pointed by wikitext
 
* Output list of all group-tags (Heroes, Abilities, Weapon Items, etc.)
Example using ''first''
* Add functionality for a 'Weapon' tag maybe?
<code><nowiki>{{#invoke:Changelog|get_last_updated|Basic Magazine|last_or_first=first}}</nowiki></code>
* Don't remove the prefix "Mo & Krill: " from lines such as "No longer listed as a recommended new player hero" as it prevents the ability to determine the hero on pages other than Mo and Krill/Update history. Is this prefix removal necessary?
 
* Switch <code><nowiki>{{Icon}} with {{PageRef}}</nowiki></code>
Outputs
* Find a non-inefficient way to expand {Icon}/{PageRef} templates for the icon and reference
* Finish tag assignment logic to fix instances of "- Charge Shot damage increased from 95 to 105" only being assigned tags 'Heroes' and 'Grey Talon' but not 'Charge Shot' or 'Abilities'.


<b>Frontend</b>
{{#invoke:Changelog|get_last_updated|Basic Magazine|last_or_first=first}}
* <i>Create a more generic icon template [[Template:PageRef]] for svg's with color inverting depending on light/dark mode, only parameter should be the entity name like 'Abrams', 'Hook', or 'Basic Magazine'.</i>
* Make a navbar for group-tags to be presented on [[Changelogs]]
** Make a lua function to retrieve list of group-tags sent to the nav-bar, i.e. Heroes, Abilities, Items, Weapon Items, etc.
** Navbar will go to pages <group_tag>/Update history like [[Heroes/Update history]], [[Abilities/Update history]], [[Items/Update history]], etc.
* Make a lua function to retrieve list of tags for [[Changelog Tags]], no nav bar needed, this page is only really useful for editors, not viewers

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