Jump to content

Module:Changelog/doc: Difference between revisions

From Deadlock Wiki
Sur (talk | contribs)
m 2nd example using Heroes tag
Sur (talk | contribs)
m moved How to Edit type info over to Help:Contributing to Patch Notes
 
(38 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.


=Invokes=
=Functions=
Invokes are callable by wikitext, i.e. <pre style="width: fit-content">{{#invoke|Changelog|invokable_name|param1|paramN}}</pre>
All of these functions are callable by wikitext, i.e. <code><nowiki>{{#invoke|Changelog|invokable_name|param1|paramN}}</nowiki></code>
 
==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]]:
<code><nowiki>{{#invoke:Changelog|write_changelog_by_tag|Pocket}}</nowiki></code>
 
Outputs
{{#invoke:Changelog|write_changelog_by_tag|Pocket}}
 
 
For use on [[Pocket#Update history]]:
<code><nowiki>{{#invoke:Changelog|write_changelog_by_tag|Pocket|3}}</nowiki></code>
 
Outputs
 
{{#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>


==test==
===Examples===
not a final invoke, just used for testing purposes right now
For a non-herolab patch page<br>
<code><nowiki>{{#invoke:Changelog|write_changelog_by_date_id|2024-05-03}}</nowiki></code>


=Functions=
{{#invoke:Changelog|write_changelog_by_date_id|2024-05-03}}
Functions are callable by lua modules, i.e. <pre style="width: fit-content">function_name(param1, paramN)</pre>
 
 
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}}


==date_tag_to_lines==
==write_data_pages_list==
Given the data of a changelog and a specific tag, output the lines / bullet points of that changelog that pertain to that tag.
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===
* '''date''' - Date of the changelog, in the format 05-03-2024
None
* '''tag''' - Tag to search relevant changelogs for


===Examples===
===Examples===
For use in 1 row of [[Abrams/Update history]]
<code><nowiki>{{#invoke:Changelog|write_data_pages_list}}</nowiki></code>
<pre style="width: fit-content">date_tag_to_lines('05-03-2024','Abrams')</pre>


Outputs
Outputs


{{#invoke:Changelog|invoke_date_tag_to_lines|05-03-2024|Abrams}}
{{#invoke:Changelog|write_data_pages_list}}


==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


For use on [[Heroes/Update history]]
===Examples===
<pre style="width: fit-content">date_tag_to_lines('05-03-2024','Heroes')</pre>
Example using ''last''
<code><nowiki>{{#invoke:Changelog|get_last_updated|Basic Magazine}}</nowiki></code>


Outputs
Outputs


{{#invoke:Changelog|invoke_date_tag_to_lines|05-03-2024|Heroes}}
{{#invoke:Changelog|get_last_updated|Basic Magazine}}


===Notes===
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.


=Todo=
Example using ''first''
<b>Backend</b>
<code><nowiki>{{#invoke:Changelog|get_last_updated|Basic Magazine|last_or_first=first}}</nowiki></code>
* Replace hyphens with asterisk to be bullet pointed by wikitext
 
* Output list of all group-tags (Heroes, Abilities, Weapon Items, etc.)
Outputs
* Add functionality for a 'Weapon' tag maybe?
* Switch <pre style="width: fit-content">{{Icon}} with {{PageRef}}</pre>


<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
* 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