Bug Reporting

From STN Wiki
Jump to: navigation, search


UnderConstruction.png
UnderConstruction.png

UNDER CONSTRUCTION! The Survive the Nights Wiki is still very early in it's development. Some pages may be incomplete or missing entirely.
We will do our best to continually update pages as in-game content & features are confirmed. Check in periodically for updated information!


Please Note: The in-game browser has been disabled. Instead of opening the page in the in-game browser, clicking the Changelog, Community, Wiki or Issue Tracker tabs will open their respective links in your default web browser (such as Internet Explorer, Firefox, Chrome, or Edge). As a result, you will not be able to make bug reports in-game until this feature is re-enabled. You will still be able to submit bug reports using a web browser.


Before You Report Bugs

As the game progresses, there will be bugs to find and mechanics to test. We need the community's help to find/report as many bugs and other issues as possible. We can then resolve these issues in order of priority as quickly as possible and roll out patches/updates as necessary for minimal downtime. With that in mind, there are some things you should take care of first before you begin reporting bugs. Taking care of these steps early means you won't need to do them later and can get right to testing/reporting bugs! If you plan on reporting bugs/issues you will need to create an account on Trello, where the STN Issue Tracker is located. Follow the steps below to create a Trello account. If you have an existing Trello account, you can skip these steps and continue to the "How To Report Bugs" section further below.


Step 1.
You can create a Trello account by going to https://trello.com/ and clicking "Sign Up" in the upper-right corner (see below image).

Trello Main Page

BugReporting01.png


Step 2.
Once on the "Sign Up" page, you will need to enter a name, email address and password. (Please note that the name you enter will be your username, visible to other members). The email address you enter will be used to send an account confirmation email as well as password recovery emails should you forget your password so be sure to use an email address you have access to. After filling out the form click "Create New Account" (see image below).

Trello Sign Up Page

BugReporting02.png


Step 3.
After filling out the required fields and clicking "Create New Account," a page will load letting you know an account verification email has been sent to your email. Check your inbox, open the email and click the link to verify your email address. The verification email will be sent by "Trello" (do-not-reply@trello.com) with the subject "Trello Account Confirmation." Check your spam/junk folders if you do not see it in your inbox. Clicking the "Verify Email" address link in the account confirmation email will complete your account creation and take you to https://trello.com/.


Step 4.
That's it! You can now report bugs by visiting the STN Issue Tracker board on Trello. The link to the board will become available at a later time. Continue reading the information below to learn how to report bugs!



How To Report Bugs

To report bugs, you will need to log into the STN Issue Tracker board on Trello in a web browser of your choice (such as Internet Explorer, Firefox, Chrome or Edge).
PLEASE NOTE: If you did not create an account on Trello then you will need to do so now. You will be unable to report bugg/issues until you do so. Please follow the steps outlined in the "Before You Report Bugs" section above.


Step 1. The STN Issue Tracker Board
Log into the STN Issue Tracker board on Trello. The link to the board will become available at a later time. The STN Issue Tracker board is set up in vertical "lists" and each list contains "cards." For bug reporting you will be using the first two lists on the left labeled "Templates & Information" and "Submitted Bug Reports" respectively (see below image). Before submitting a bug report (creating a new issue card), be sure to use the search bar located in the upper left corner. This will search all content on the board. Alternatively, you can browse the various lists and view issue cards that have already been submitted by other community members or sorted by the development staff. You can also comment on existing issue cards, which you would want to do if you've experienced the same issue rather than create a duplicate card.

Searching the existing issue cards to see if your issue has already been reported is extremely important, DON'T SKIP IT! If you find an existing issue card which details the same issue you are having, continue reading Step 2. If you can't find an existing card for your issue, skip to Step 3.

STN Issue Tracker Board

BugReporting03.png


Step 2. Commenting on Existing Issue Cards
If you've found an existing issue card for your issue then click on the corresponding card to open it. You can then add your own comments and upload your own screenshots, log files and other attachments. After you have successfully added your comments and/or uploaded your attachments, you can close the card by clicking the "X" in the upper-right corner of the card (see image below).

Existing Issue Card

BugReporting04.png


Step 3. Creating a New Issue Card
To create a new issue card click the "Bug Report Template - v1.X.X" card in the far left list labeled "Templates & Information." After the template card opens, click "Copy" located on the right side of the card to open the copy window. Do not edit anything in the template card before you click copy. The template card must remain unedited so everyone can locate it easily. With the copy window open, rename the title of the card using the format "Your Issue - Game Version." For example, "Unable to Log In - v1.0.0" (see first image below). If you're unsure of what version of STN you're running you can find the version number when in-game in the upper-right corner of your screen (see second image below).

Copy Card Window

BugReporting06.png


STN Game Version

BugReporting07.png


Below the title click the "List" button to select a destination list for the copied card then select the "Submitted Bug Reports" list (see image below). Now click the green "Create Card" button at the bottom of the copy card window. Do not create or move cards to any other list. The development team will review the submitted issue cards and sort them accordingly.

Select Destination List

BugReporting08.png


Step 4. Filling Out the Issue Card
After clicking the Create Card button you will see your new issue card at the top of the "Submitted Bug Reports" list. Now it's time to fill out the rest! Filling out the issue card is simple. See the below information explaining each field as well as providing guidelines to use during your bug report.

  • Title
  • Explanation: The title gives a general overview of what the bug/issue is and appears at the top of each submitted issue card displayed in the various lists.
  • Guidelines: It's important to keep the title short and to the point while ensuring the bug/issue can be easily identified & searched for. Use the the format "Your Issue - Game Version" for the title if your issue card. For example, "Unable to Log In - v1.0.0." You may have already changed this in Step 3 above. If you need to change the title, you can do so now by clicking on the card's title and editing the text.


  • Priority
  • Explanation: The priority field is found between the card's title and description. Make sure you assign this field correctly! Simply click on the "Choose a Priority" box to open the drop-down menu. Then select an option (see first image below). If you are unable to see the priority field, click on "Custom Fields" on the right side of the card (see second image below). When the Custom Fields window opens, simply select the desired priority and click the green "Save" button at the bottom. Note that you can also select a "Bug Type" and "Game Version. " If you do not see those fields on your card they are located in the same area as the Priority field.
Select Priority Method 01

BugReporting09.png

Select Priority Method 02

BugReporting10.png

  • Guidelines: If it is a small bug that does not affect much such as minor graphical errors then it could be "trivial" or "minor." If the bug stops you from playing (game crashes or disconnects) then you might want to choose "critical" or "blocker." Assigning the correct priority will help with getting the most important issues fixed first! Use the following descriptions of each priority type to help assign the correct one to your issue card:
  • Trivial: Trivial issues are issues that don't effect any features or mechanics. These can include texture flickering, missing/incorrect textures, typos in item descriptions or menus, etc.
  • Minor: Minor issues are issues that have slight effects on gameplay but don't prevent you from doing anything. These can include invisible colliders/barriers, misplaced props/items, sound or animation glitches, etc.
  • Major: Major issues are issues that have substantial effects on gameplay. These can include
  • Critical: Critical issues are issues that significant effects on gameplay. These can include
  • Blocker: Blockers are critical issues that prevent you from playing the game entirely. These can include crashes to desktop, indefinite client freezing, inability to connect to servers, server crashes, etc.


  • Bug Type
  • Explanation: The Bug Type field is located next to the Priority field. Like the Priority field, to select a bug type simply click "Choose a Bug Type" and make a selection in the drop-down window. Also like the Priority field, if you cannot see the Bug Type field, click "Custom Fields" on the right side of the card then make your selection. This is what type of bug your issue is such as an Animation bug, a Login bug, a Sound bug, or many others. This helps categorize the issue cards and sort them to the proper list.
  • Guidelines: Some issues are very easy to categorize, where as other issues you may find difficult to choose a bug type. Issues can often fall into more than one category. An issue of footstep sounds not playing at the same time as the character's feet touching the ground could be listed as either a Sound issue or an Animation issue. In situations like this just use your best judgement. Use the following descriptions of each bug type to help you choose the right one:
  • Animation Issue: Animation deals with movement so issues that fall into this category will most likely have something to do with player or AI models. Issues in this list could include character animations not playing when they should, holding weapons/items incorrectly, etc.
  • Audio Issues: Audio deals with sound and sound is everywhere in STN. Issues in this list could include sounds not playing, incorrect sounds playing, volume options changing incorrectly, etc.
  • AI Issue (Animals/Zombies): AI is the "Artificial Intelligence" of non-player character elements such as animals and zombies. AI is a term used to describe the behaviors of & interactions with living or undead creatures. Issues in this list could include animals or zombies freezing in place, not attacking or running away when they should, being unable to hit them, etc.
  • Building/Structure Issue: Building or Structure issues will address issues with the buildings themselves & player interactions with them. Issues in this list could include being unable to enter a building/structure, door interactions not working correctly, etc.
  • Character Issue - General: General character issues will include issues such as
  • Character Issue - Stats: Character stat issues will include issues such as eating/drinking items not affecting stats or affecting them incorrectly, stats not being influenced correctly through player interactions such as killing players, etc.
  • Collider Issue: Collider is another term used to describe barriers, or things you cannot walk through. Obvious colliders are things like wall or terrain colliders. Issues in this list could include misplaced or missing colliders, invisible colliders where there should not be any, etc.
  • Container/Inventory Issue: Container or inventory issues will include items not displaying or stacking correctly, being unable to deposit/withdraw items from a container, being unable to drop items, etc.
  • Client Issue - Connection: Client Connection issues will address issues such as being unable to connect to the lobby, unable to connect to a server, disconnects, synchronization issues between clients and servers, etc.
  • Client Issue - Crash: Crash issues will of course include client crashes, such as crashing to desktop when picking up a specific item or performing a specific action, crashing for no apparent reason, etc.
  • Client Issue - Launch: Launch issues will include being unable to launch STN. Issues in this list could be freezing on start-up, crashing on start-up, etc.
  • Crafting Issue: Crafting issues will include issues involving the crafting of items or materials. Issues in this list could include not being able to craft a certain item even though you have the required materials/tools, incorrect amount of materials being used to craft an item, etc.
  • Fortifications Issue: Fortifications issues will of course address issues with the fortification system. Issues in this list could include incorrect fortification placement, being unable to build or craft fortifications, etc.
  • Graphics Issue: Graphics issues will cover all things graphics related. Items in this list could include flickering textures, missing textures, etc.
  • Item Issue - Description: Item description issues will include things like missing item descriptions, typos in item or tooltip descriptions, etc.
  • Item Issue - General: General item issues will include items disappearing when you drop them, being unable to pick-up an item, etc.
  • Item Issue - Misplaced: Issues in this list will include props (containers, rocks/other inanimate objects, trees) being out-of-place or floating, items not being placed in the correct location when using the free-placement system, etc.
  • Item Issue - Spawn: Item spawn issues include items spawning under the world, nothing spawning in an area you know loot is supposed to spawn, floating item spawns, etc.
  • Menu Issue: Menu issues will include all things menu related. This could include being unable to navigate the main menu, being unable to open or exit the main menu, etc.
  • Other Issue: Other issues include issues that do not fit into any other bug category. You are not likely to use this issue type often.
  • Server Issue: Server issues address all server related issues. This could be incorrect connected/max players being displayed in the server list, your server not showing up in the server list, server settings not working or working incorrectly, server crashes, etc.
  • Settings Issue: Settings issues address in-game settings issues, such as graphics settings working incorrectly, audio settings not working, etc.
  • Terrain Issue: Terrain issues include being unable to walk up a hill you should be able to walk up, spawning inside rocks or other objects, falling through the world, etc.
  • User Interface Issue: User interface, or GUI, issues could include item tooltips not displaying, being unable to open/close the in-game chat, in-game windows appearing off the screen or not opening, etc.


  • Version
  • Explanation: This is the game version you are in when the bug occurs. This field is changed the same way as the Priority and Bug Type fields. If you're unsure what game version you're running, the game version can be found in the upper-right portion of you're screen when you're in-game (see below image).
STN Game Version
BugReporting07.png
  • Guidelines: This is straightforward - select the game version you are running when the bug occurs.


  • Assignee
  • Explanation: This assigns the issue to an a2z staff member to fix. It's best to leave this blank and let the development members assign it.
  • Guidelines: *You do not have to fill in this field* It's best to leave this blank and let the development team assign it.


  • Description
  • Explanation: The description is one of the most important sections where the bulk of your information goes. Every detail helps so be as descriptive as you can. The more information there is the easier we can pinpoint and resolve the issue! To edit the card's description, click the "Edit" link where it says description located just below the Priority, Bug Type, and Game Version fields mentioned earlier.
  • Guidelines: Important information to include is:
  • What Happened?: Detail exactly what happened, what you were doing when it happened, what events followed, etc.
  • Location: Use coordinates when possible. Also use any nearby landmarks to describe the location such as the name of the town you're in or near, name of a nearby street, specific buildings nearby (such as a water tower or grocery store), etc.
  • Steps to Recreate: If you can recreate the issue, list the steps to do so. This allows us to follow those steps & see exactly what happens for themselves to more easily pinpoint the root cause of the issue. Also, if it's an issue that inhibits game functionality, it can educate other members so they can avoid taking those actions until the issue is resolved.
  • Time Bug Occurred: Knowing when the bug occurred can be very valuable information. A2z can cross reference the time with logs to pinpoint the root cause of the issue. Your time does not need to be exact, but the closer it is the better. When providing the time you should use the following format (without quotes): "UTC timezone - your local time", for example UTC-7 - 10:30pm. If you are unsure what UTC timezone you are located in you can look it up here: https://www.timeanddate.com/time/map/
  • Server: If the bug occurred while you were connected to a server, be sure to include the name of the server you were on. This is especially important for server crash issue reports.
  • Were you able to resolve the issue?: Many issues have work-around. If you discover a work-around for an issue be sure to include those details in your report!
  • Other Info: Add any other information you think might be helpful. It's better to have too much information than not enough!


  • Attachments
  • Description: This is the final chance to include additional information such as screenshots or log files.
  • Guidelines: The following are descriptions of various attachments you should include with your bug report whenever possible:
  • Screenshots Always try to include a screenshot whenever possible. You can take a screenshot by pressing the "F12" key. Note: F12 is the default shortcut key to take screenshots in Steam games. If you have changed your screenshot shortcut key to something else then use the appropriate shortcut key that you have assigned.
  • Client Log Files:
  • DxDiag Log: A DxDiag log contains information about your computer's audio & video hardware & drivers. It's extremely helpful when pinpointing various compatibility issues and conflicts and very easy to create. To create a DxDiag use the following steps:
1. In Windows Vista/7 or higher, press the [Windows]+[R] keys on your keyboard to bring up the Run command.
2. Type "DxDiag" (without quotes) then press [Enter]. This will start the Direct X Diagnostic Tool.
3. Once the Direct X Diagnostic Tool appears, click on the save all information button at the bottom.
4. When asked where to save the file to, select Desktop (or other location easily accessible) then click Save.
5. After saving click the Exit button to exit the Direct X Diagnostic Tool.
6. On your desktop or wherever you chose to save the file, you should see the file "DxDiag.txt". If there is no file with this name, please repeat the steps above to ensure the file is saved to the desktop.


Step 5.
After you've filled out the necessary forms and uploaded any attachments, click the "Create Issue" button to create the issue. Congratulations, you have successfully reported a bug and helped a2z improve STN! If you need to edit your card you can do so by clicking on the card to open it. Please be sure to only edit issue cards that you created. Do not edit other people's issue cards. However, you can comment or upload attachments to someone else's issue card as explained above. </div>