Difference between revisions of "Help:Style guide/Bugs"

From Team Fortress Wiki
Jump to: navigation, search
(Pushing Bug Style Guide as per discussion on main/IRC)
 
m (Notability)
(7 intermediate revisions by 4 users not shown)
Line 6: Line 6:
 
* ...be clear, concise, and informative.
 
* ...be clear, concise, and informative.
 
* ...be determined by asking ''did someone break it, or is that just how it is?''
 
* ...be determined by asking ''did someone break it, or is that just how it is?''
* ...not be expected properties of items or models.}}
+
* ...be backed up with sufficient proof when making the edit.
 +
* ...not be expected properties of the subject.}}
  
The following page is a '''style guide (bugs)'''. Many pages contain Bug sections near the end of the article. These sections are meant to hold any bugs the relevant item may have. Due to different servers, player customizations, and preferences, it is sometimes unclear what should or should not be included. Before adding an item to a page's Bug section, please consult these guidelines first.
+
''Bugs'' in Team Fortress 2 are classified as behaviour of in-game things (weapons, cosmetic items, in-game mechanics, map features, etc.) that were not intended by the developers. This can range from harmless bugs such as the Payload cart flipping suddenly, to bugs that can impact your game quite a bit such as certain doorways being visually solid, but not having any collision, in Pyroland on Mercenary Park.
  
== Reporting bugs ==
+
The definition of ''bugs'' can also be stretched to include oversights, such as the lack of a {{code|[[vdc:func_nobuild|func_nobuild]]}} in an early version of Wutville. This is not a behaviour malfunction, but rather the developer forgetting something. It's expected that spawnrooms are exempt from being built in, unless mentioned otherwise (such as an outline on the floor and a sign saying "Teleporters here").
* Bugs should be informative, clear, and concise. All Bug sections are styled as bullet points, not paragraphs. If the bug you are writing about seems to have a particularly long description, such as describing how to perform a bug, consider summarizing it briefly and linking to a source with more relevant information.
 
* Do not post images or videos to prove a point unless absolutely necessary. If it is absolutely vital that a video be included, it is better to link to the video. Images should also be linked to, but can be shown as thumbnails if they have been uploaded to the Wiki.
 
*All bugs should still uphold to the rest of the [[Help:Style guide|style guide]]. This includes grammar, spelling, and formatting.
 
  
== Removing bugs ==
+
== Notability ==
Before removing any bugs, first consider whether or not it is indeed a bug by utilising the following guidelines. If it is found not to be a bug, then it should be removed. '''State why it isn't considered a bug in the edit summary''' - if you cannot justify removing a bug in the edit summary, you should not be removing it. If the information is relevant in some way consider finding a way to work it into an existing article. It is always possible that an item that is not a bug is in fact relevant information for ''another'' article.
+
The following are guidelines on when bugs are and aren't notable. Bugs should only be on the page if they are notable. The general purpose of the bugs section should be for players to see if what they experienced is intended or not and serve as a place that players can learn certain things to avoid doing in order to not affect their game.
  
=== What if ''my'' bug is removed? ===
+
; Bugs should be unintended behaviour, not a (hidden) mechanic.
If your own addition to the Bugs section is removed, ''do '''not''''' immediately add it back into the article. First check the page's history to see who removed the item, and if they left a reason in the edit summary. If the person did not leave a reason or if you do not agree with their reason, consider asking them for an explanation or elaboration on their Talk page. If the matter is not resolved, make a new post on that talk page and state your case as to why your item is a valid bug. The resulting discussion will determine the final fate of that bug entry. If it is decided that a bug removal was justified, ''do '''not''''' ignore this decision. Repeated adding of a removed bug entry and ignoring the reason for its removal can be grounds for a temporary block from editing the Wiki.
+
: '''Good example''': ''While equipped, this set reduces the time taken to consume a lunchbox item, such as the [[Sandvich]]. This is due to the set taunt replacing the standard eating animation. However, this does not speed up the [[Sandvich]]'s healing rate. Therefore, only 225 health will be healed after eaten instead of the full health received without the set equipped.'' (From [[FrankenHeavy]])
 +
: This bug is a result of the default taunt of the Sandvich also healing the player, it being replaced with a faster taunt means less health is gained.
  
== Guidelines for bugs ==
+
: '''Bad example''': ''When a Medic uses ÜberCharge when on fire, critical hit resistance will be reduced from 100% to 80%. This results in items such as the Backburner and Phlogistinator being able to "pierce" through the Vaccinator's ÜberCharge.'' (Removed from [[Vaccinator]])
The following is a set of guidelines to follow when writing bugs. Before making an addition to a Bugs section, try to make sure that the item follows these guidelines.  
+
: This is an intended mechanic; a {{botignore|flamethrower}}'s flames reduce the effect of resistance shields and healing.
  
Bugs should be ordered as follows in this section :
+
; Minor bugs or bugs that happen with a lot of items should not be noted to keep the list from becoming too long and cluttered.
*'''Game-breaking (major)'''. The bug greatly alters the weapon's attributes and affects how it is used within the game to such an extent.
+
: '''Good example''': ''If the player has their model quality set to medium or lower, the Scout will not break open the Shortstop during reloading or inspecting.'' (From [[Shortstop]])
**''The Half-Zatoichi is no longer honorbound and can be sheathed at any time.''
+
: This is a visual bug that is notable, because it makes it more difficult to see when the gun is close to finishing its reload due to the fact that you cannot see the gun close.
*'''Game-breaking (minor)'''. The bug alters the weapon, but its effects are not obvious and only take effect in certain circumstances.
 
**''The Sandman's ball can pass through setup gates.''
 
*'''Cosmetic'''. The bug has no discernable effect on gameplay; it is merely an eyesore.
 
**''The Saxxy does not Cloak with the Spy in the first-person view.''
 
  
'''Note:''' Cosmetic bugs, and their status as a bug, are open to debate. Many feel they are irrelevant, whilst others note their value. Please raise the issue with other editors in the IRC or the general discussion page, and come to a reasonable conclusion.
+
: '''Bad example''': ''When the rocket jumper reloads the hand clips through the orange part at the tip. [...]'' (Removed from [[Rocket Jumper]])
 +
: This is a visual bug that's known as "clipping". Clipping happens often with weapons and cosmetics alike and is not noteworthy.
  
== Determining Bugs ==
+
; Bugs that affect gameplay in any meaningful way should be noted.
=== What ''are'' bugs? ===
+
: '''Good example''': ''When throwing the Mad Milk on the ground on a ramped surface or while Scout is running, there is a possibility that the Mad Milk will roll first before shattering, thus delaying the effects that come with it.'' (From [[Mad Milk]])
* Bugs should be ''facts'' about the item in question. They may only be tangent to the actual nature of the page in question, but should have a direct relation nonetheless. <br/>
+
: This bug has gameplay consequences, as an enemy player standing on a ramped surface may not be affected by the Mad Milk if thrown on the ground due to this bug. The player can then try and aim for a nearby wall or try to hit the enemy themselves to get around this bug.
:''' Examples:'''  
 
<blockquote>'''Good bug:''' The model, on rare occasions, will deform when it crits. (''From [[Holy Mackerel]]'') <br/>
 
This entry states a hard fact that when a player gets a critical swing with the Holy Mackerel the item may deform.</blockquote>
 
<blockquote>'''Poor bug:''' When the Flare Gun is dropped on death, you can see a flare model attached near the underside of the gun. (''Removed from <span class="plainlinks">[http://wiki.teamfortress.com/w/index.php?title=Flare_Gun&diff=prev&oldid=1093606 Flare Gun]'')</span> <br/>
 
While this entry is a fact, it is an expected property of the item due to the way it has been made and thus was removed.</blockquote>
 
  
* Bugs should be new information that is not already available in the infobox or elsewhere in the page. It should also be information that does not belong in the infobox or elsewhere in the page.
+
: '''Bad example''': ''When the Boost Meter has been completely filled, the bar on the HUD does not fully reach the end of the meter.'' (Removed from [[Baby Face's Blaster]])
:''' Examples:'''  
+
: While this bug may have gameplay consequences (the player thinking you may not have filled the boost in its entirety), the actual difference between the end of the bar and the maximum boost you can get is a few pixels wide. It can be understood after only one or two times of checking the bar with full boost that this is an incredibly minor visual bug.
<blockquote>'''Poor bug:''' This item does not have a kill-icon related to the item. (''Removed from <span class="plainlinks">[http://wiki.teamfortress.com/w/index.php?title=Frying_Pan&diff=186661&oldid=186659 Frying Pan]</span>'') <br/>
 
The kill icon for the Frying Pan is already plainly visible in the infobox on the right-hand side of the page. This bug merely restates what is depicted in the infobox. </blockquote>
 
<blockquote>'''Poor bug:'''  When the player equips this weapon, they cannot receive ammo from ammo packs for their primary and secondary slotted weapons. (''Removed from <span class="plainlinks">[http://wiki.teamfortress.com/w/index.php?title=Persian_Persuader&diff=prev&oldid=700279 Persian Persuader]</span>'') <br/>
 
This not a bug at all, but merely an extension of the listed downside of the weapon. </blockquote>
 
  
* Bugs items should be factual, and not neglect other instances of the same thing.  
+
; Bugs should be able to happen while playing a regular, non-modified game/server.
:''' Examples:'''
+
: '''Good example''': ''The Festive variant does not appear when inspected from the Backpack menu.'' (From [[Axtinguisher]])
<blockquote>'''Good bug:''' Genuine Neon Annihilators do not play the bass guitar riff when taunting. This is due to the promotional item having a different item entry from the crafted ones. (From [[Neon Annihilator]])'' <br/>
+
: This bug happens on the default HUD, therefore it can be replicated in a regular, non-modified game/server.
This item is a hard fact about the Neon Annihilator. The Neon Annihilator, like the [[Manmelter]], has a special taunt sound but, due to way the item has been coded by Valve, the unique sound does not play when taunting with a Genuine Neon Annihilator.</blockquote>
 
<blockquote>'''Poor bug:''' If a players load out is slow enough to update, the player can equip the Pyrovision goggles with The Horseless Headless Horsemann's Head. (''Removed from <span class="plainlinks">[http://wiki.teamfortress.com/w/index.php?title=Horseless_Headless_Horsemann%27s_Head&diff=prev&oldid=1085323 Horseless Headless Horsemann's Head]</span>'') <br/>
 
While true, this entry neglects that this is a well-known bug that can be applied to almost all colliding miscellaneous items.</blockquote>
 
  
=== What ''are not'' bugs? ===
+
: '''Bad example''': ''When you switch to the Gloves of Running Urgently in the loadout menu, then press the button to change your model from Team RED to Team BLU, the flame pattern will disappear, essentially making it seem that you instead have the Killing Gloves of Boxing equipped.'' (Removed from [[Gloves of Running Urgently]])
* Bugs items should not record clipping.
+
: This bug is only possible with a custom heads-up display installed. The default HUD does not come with a button to change the model from RED to BLU in the Loadout menu, however, a lot of custom HUDs do.
<blockquote>'''Poor bug:''' Summer Shades had clipping problem with the [[Anger]]. (''Removed from <span class="plainlinks">[http://wiki.teamfortress.com/w/index.php?title=Summer_Shades&diff=prev&oldid=1078912 Summer Shades]</span>'') <br/>
 
There are a lot of colliding items in Team Fortress 2, and thus many of them will end up clipping. Expected clipping is not a bug and should not be recorded.</blockquote>
 
  
* Bugs should not be trivial and not noteworthy such as a visual glitch or a quickly-patched bug. Bugs should be about the item addressed within the page, not the mistakes the developers made in the implementation. If it is a statement on the way an item once functioned, then it should be placed in the Previous changes section of that page.
+
; Listed Bugs should be current.
:''' Example:'''
+
: The Bugs section should ''only'' contain bugs that are possible in the current version of the game. Any bugs that have been fixed in previous patches are not to be listed. If Valve notes a bug as fixed, it will be considered fixed and subsequently removed from the Wiki until proven otherwise.
<blockquote>'''Poor bug:''' There is a [[Glitch]] when you hold R {to reload the weapon} and shoot, it does part of the reloading and shooting at the same time. (''Removed from <span class="plainlinks">[http://wiki.teamfortress.com/w/index.php?title=Shortstop&diff=184116&oldid=184112 Shortstop]</span>'') <br/>
 
This is a very minor visual bug and not worth mentioning in the article itself. </blockquote>
 
  
* Bugs should not concern over a lack of item's levels.
+
'''If you are unsure, you can always bring it up on the talk page.''' Editors will be more than happy to assist in the process.
:'''Example:'''
 
<blockquote>'''Poor bug:''' The Made Man's [[item levels|item level]] does not appear in the backpack view. (''Removed from <span class="plainlinks">[http://wiki.teamfortress.com/w/index.php?title=Made_Man&diff=prev&oldid=1090671 Made Man]</span>'') <br/>
 
Whilst most likely a mistake on Valve's part, some items do not have item levels. These do not need to be listed, as they provide no ill effects on gameplay, and do not count as a cosmetic bug. If there are more items with no levels, it is preferred that you add "no level" to the item's infobox.</blockquote>
 
  
*Bugs should not list how the game handles certain tasks within the game. Occasionally, there might be two colliding instances that the game decides on what happens.  
+
== How and where to submit bugs ==
:'''Example:'''
+
; Where?
<blockquote>'''Poor bug:''' The Balloonicorn assist does not show after destroying a [[building]].<br>
+
Submit a bug where the cause of the issue lies under the '''Bugs''' section. Bugs should only be mentioned once in the broadest topic affected by the bug.
When equipped with the [[Bird-Man of Aberdeen]], the Balloonicorn gets credit for kills instead of assists.<br>
+
: '''Example''': '' In the rooms with the ramp to the catwalks, it is possible for Engineers to trap people by putting a teleporter under the ramp [...]'' (Removed from [[Granary (Arena)]])
When a player has the [[Alien Swarm Parasite]] and the Balloonicorn equipped, the Alien Swarm Parasite will get the Assist instead of the Balloonicorn. (''Removed from <span class="plainlinks">[http://wiki.teamfortress.com/w/index.php?title=Balloonicorn&diff=next&oldid=1093488 Balloonicorn]</span>'')<br/>
+
: This bug is not a bug with the map, but rather a bug with the Teleporter's hidden feature of detonating when a player would get stuck in the geometry and should be noted on the Teleporter page instead. Rather than listing every map that has a spot for this, the bug is listed once on the Teleporter page.
This is the game trying to choose which one goes first, and is an expected way of how the game handles assists.</blockquote>
 
  
* Unlockable items using stock sound effects or animations are not bugs, unless the sounds/animations exist, but are unimplemented.
+
;How?
:''' Examples:'''  
+
Submit a bug under the '''Bugs''' section, or make a section if it doesn't exist yet. Describe the bug as accurately as possible, while also keeping it short enough to not bore the reader. If you know, include steps on how to reproduce the bug. Speculation as to why a bug happens is not necessary, only add it if entirely known.
<blockquote>'''Good bug:''' There are a set of walking sound effects for this item. They are pitch shifted sounds, borrowed from the Knife. (From [[Liquor Locker]])'' <br/>
+
'''However''': if a bug gives any advantage over other players (such as changing the pose of the model to that of the [[ConTracker]] inspection pose, while not having the hitbox change), these reproduction steps are not necessary as it would promote [[Exploits|exploiting]].
This states that there are unimplemented sounds for walking whilst this item is equipped. Much like the page where this comes from, it may be better to place this under a header of "Unused Content" to clear up any issues.</blockquote>
 
<blockquote>'''Poor bug:''' If the Scout has only 1 shell remaining when he reloads this weapon, he still loads two shells.(''Removed from <span class="plainlinks">[http://wiki.teamfortress.com/w/index.php?title=Force-A-Nature&diff=1080643&oldid=1080635 Force-A-Nature]</span>'') <br/>
 
This is an example of the game using a stock animation where it may appear to be a bug. In these cases, they are not bugs but simply the way the animations work - there is no animation for reloading one shell in to the Force-A-Nature.</blockquote>
 
  
* Certain Strange parts cannot be added to items that seem like they can utilise them. These are not bugs, but rather the decision of Valve. For instance, the Medi Gun cannot have the Strange Part: Allies Extinguished added on to it. This is because Valve chose to not allow it. Indeed, they choose what strange part can go on each weapon. In these cases, it is best to ask on the talk page before adding the bug entry.
+
And finally, the most important step: link to a video (if possible and needed, a timestamp to where the bug is showcased) or an image (only if a video is unnecessary, such as an item not being visible in the [[Backpack]] inspection feature. Make sure to permanently save this image on [https://archive.org/ archive.org] so it'll always be available) in the summary that shows off the recently-added bug. Once a bug has been verified, it is considered verified until proven otherwise. This means that even if a video is taken down, if it was verified at the time it was added, it will not be removed. The only exception to this rule is when a patch note mentions a certain bug as fixed, it is assumed as fixed until proven otherwise. '''If proof is not provided, the edit will be undone.'''
 +
 
 +
== Citing bugs ==
 +
'''When adding or changing a bug, provide proof that the bug or changes to the bug are actually true''': This goes for any bug, no matter how small (as long as it is notable). For bug changes, any kind of change or addition to how a bug is triggered or to the outcome of a bug requires reverification. If a bug is simply being reworded to be simpler or more clear, reverification is not needed.
 +
: '''Example''': ''If the player opens the taunt menu, then opens the Jungle Inferno ConTracker, then closes the ConTracker while at the same time pressing the key to use a taunt, [...]'' to ''If the player quickly opens and closes the Jungle Inferno ConTracker, then taunts during the contractor animation'' (From [[Jungle Inferno ConTracker]])
 +
: This has changed how the bug is performed and therefore requires reverification.
 +
 
 +
== Reporting bugs to Valve ==
 +
Although entirely optional, you can report bugs to Valve on GitHub [https://github.com/ValveSoftware/Source-1-Games/issues here] by clicking "New issue" on the right, or by sending an e-mail to the TF Team [https://www.valvesoftware.com/contact?recipient=TF+Team here]. When reporting a bug on GitHub, make sure to read the [https://github.com/ValveSoftware/Source-1-Games guide] on how to before doing so.
  
 
== See also ==
 
== See also ==
 
* [[Help:Style guide|Style guide]]
 
* [[Help:Style guide|Style guide]]

Revision as of 11:14, 28 January 2023

Bugs in Team Fortress 2 are classified as behaviour of in-game things (weapons, cosmetic items, in-game mechanics, map features, etc.) that were not intended by the developers. This can range from harmless bugs such as the Payload cart flipping suddenly, to bugs that can impact your game quite a bit such as certain doorways being visually solid, but not having any collision, in Pyroland on Mercenary Park.

The definition of bugs can also be stretched to include oversights, such as the lack of a func_nobuild in an early version of Wutville. This is not a behaviour malfunction, but rather the developer forgetting something. It's expected that spawnrooms are exempt from being built in, unless mentioned otherwise (such as an outline on the floor and a sign saying "Teleporters here").

Notability

The following are guidelines on when bugs are and aren't notable. Bugs should only be on the page if they are notable. The general purpose of the bugs section should be for players to see if what they experienced is intended or not and serve as a place that players can learn certain things to avoid doing in order to not affect their game.

Bugs should be unintended behaviour, not a (hidden) mechanic.
Good example: While equipped, this set reduces the time taken to consume a lunchbox item, such as the Sandvich. This is due to the set taunt replacing the standard eating animation. However, this does not speed up the Sandvich's healing rate. Therefore, only 225 health will be healed after eaten instead of the full health received without the set equipped. (From FrankenHeavy)
This bug is a result of the default taunt of the Sandvich also healing the player, it being replaced with a faster taunt means less health is gained.
Bad example: When a Medic uses ÜberCharge when on fire, critical hit resistance will be reduced from 100% to 80%. This results in items such as the Backburner and Phlogistinator being able to "pierce" through the Vaccinator's ÜberCharge. (Removed from Vaccinator)
This is an intended mechanic; a flamethrower's flames reduce the effect of resistance shields and healing.
Minor bugs or bugs that happen with a lot of items should not be noted to keep the list from becoming too long and cluttered.
Good example: If the player has their model quality set to medium or lower, the Scout will not break open the Shortstop during reloading or inspecting. (From Shortstop)
This is a visual bug that is notable, because it makes it more difficult to see when the gun is close to finishing its reload due to the fact that you cannot see the gun close.
Bad example: When the rocket jumper reloads the hand clips through the orange part at the tip. [...] (Removed from Rocket Jumper)
This is a visual bug that's known as "clipping". Clipping happens often with weapons and cosmetics alike and is not noteworthy.
Bugs that affect gameplay in any meaningful way should be noted.
Good example: When throwing the Mad Milk on the ground on a ramped surface or while Scout is running, there is a possibility that the Mad Milk will roll first before shattering, thus delaying the effects that come with it. (From Mad Milk)
This bug has gameplay consequences, as an enemy player standing on a ramped surface may not be affected by the Mad Milk if thrown on the ground due to this bug. The player can then try and aim for a nearby wall or try to hit the enemy themselves to get around this bug.
Bad example: When the Boost Meter has been completely filled, the bar on the HUD does not fully reach the end of the meter. (Removed from Baby Face's Blaster)
While this bug may have gameplay consequences (the player thinking you may not have filled the boost in its entirety), the actual difference between the end of the bar and the maximum boost you can get is a few pixels wide. It can be understood after only one or two times of checking the bar with full boost that this is an incredibly minor visual bug.
Bugs should be able to happen while playing a regular, non-modified game/server.
Good example: The Festive variant does not appear when inspected from the Backpack menu. (From Axtinguisher)
This bug happens on the default HUD, therefore it can be replicated in a regular, non-modified game/server.
Bad example: When you switch to the Gloves of Running Urgently in the loadout menu, then press the button to change your model from Team RED to Team BLU, the flame pattern will disappear, essentially making it seem that you instead have the Killing Gloves of Boxing equipped. (Removed from Gloves of Running Urgently)
This bug is only possible with a custom heads-up display installed. The default HUD does not come with a button to change the model from RED to BLU in the Loadout menu, however, a lot of custom HUDs do.
Listed Bugs should be current.
The Bugs section should only contain bugs that are possible in the current version of the game. Any bugs that have been fixed in previous patches are not to be listed. If Valve notes a bug as fixed, it will be considered fixed and subsequently removed from the Wiki until proven otherwise.

If you are unsure, you can always bring it up on the talk page. Editors will be more than happy to assist in the process.

How and where to submit bugs

Where?

Submit a bug where the cause of the issue lies under the Bugs section. Bugs should only be mentioned once in the broadest topic affected by the bug.

Example: In the rooms with the ramp to the catwalks, it is possible for Engineers to trap people by putting a teleporter under the ramp [...] (Removed from Granary (Arena))
This bug is not a bug with the map, but rather a bug with the Teleporter's hidden feature of detonating when a player would get stuck in the geometry and should be noted on the Teleporter page instead. Rather than listing every map that has a spot for this, the bug is listed once on the Teleporter page.
How?

Submit a bug under the Bugs section, or make a section if it doesn't exist yet. Describe the bug as accurately as possible, while also keeping it short enough to not bore the reader. If you know, include steps on how to reproduce the bug. Speculation as to why a bug happens is not necessary, only add it if entirely known. However: if a bug gives any advantage over other players (such as changing the pose of the model to that of the ConTracker inspection pose, while not having the hitbox change), these reproduction steps are not necessary as it would promote exploiting.

And finally, the most important step: link to a video (if possible and needed, a timestamp to where the bug is showcased) or an image (only if a video is unnecessary, such as an item not being visible in the Backpack inspection feature. Make sure to permanently save this image on archive.org so it'll always be available) in the summary that shows off the recently-added bug. Once a bug has been verified, it is considered verified until proven otherwise. This means that even if a video is taken down, if it was verified at the time it was added, it will not be removed. The only exception to this rule is when a patch note mentions a certain bug as fixed, it is assumed as fixed until proven otherwise. If proof is not provided, the edit will be undone.

Citing bugs

When adding or changing a bug, provide proof that the bug or changes to the bug are actually true: This goes for any bug, no matter how small (as long as it is notable). For bug changes, any kind of change or addition to how a bug is triggered or to the outcome of a bug requires reverification. If a bug is simply being reworded to be simpler or more clear, reverification is not needed.

Example: If the player opens the taunt menu, then opens the Jungle Inferno ConTracker, then closes the ConTracker while at the same time pressing the key to use a taunt, [...] to If the player quickly opens and closes the Jungle Inferno ConTracker, then taunts during the contractor animation (From Jungle Inferno ConTracker)
This has changed how the bug is performed and therefore requires reverification.

Reporting bugs to Valve

Although entirely optional, you can report bugs to Valve on GitHub here by clicking "New issue" on the right, or by sending an e-mail to the TF Team here. When reporting a bug on GitHub, make sure to read the guide on how to before doing so.

See also