Tutorial:Bug Reporting
NOTICE: This page is a Work in Progress as much of the lore/Development for the game is yet to be established.
description=Encountering bugs is a normal part of playing a game under active development like Starship Simulator. Reporting these bugs effectively is incredibly helpful to Fleetyard Studios in identifying and fixing issues, ultimately improving the game for everyone. This tutorial guides you through the recommended process for reporting bugs.
Importance of Good Bug Reports
Clear and detailed bug reports are essential for the developers to understand the problem, reproduce it reliably, and implement a fix. A good report saves developer time and helps get bugs fixed faster.
How to Report Bugs (In-Game F1 Form)
The primary method for reporting bugs is the built-in reporting tool accessible via the F1 key. This tool was specifically re-enabled and has received fixes during development (Build 0.225.0.57, 0.225.0.63, 0.225.0.70, 0.225.0.74), indicating it's the intended channel.
1. Access the Form: Press the F1 key at any time during gameplay. This should bring up the bug reporting interface.
2. Fill Out the Form: Provide as much clear and accurate information as possible. Essential details include:
- Summary/Title: A brief title summarizing the bug (e.g., "Cannot interact with Helm console after warping").
- Description: A detailed explanation of the problem.
- What exactly happened?
- What did you expect to happen instead?
- When did it occur?
- Steps to Reproduce (STR): This is the most crucial part. Provide clear, numbered, step-by-step instructions that someone else could follow to reliably make the bug happen again. Be specific!
- Example:
1. Load save game X / Start new game. 2. Go to Bridge. 3. Sit at the Helm station. 4. Target Sol. 5. Engage FTL Drive. 6. After arriving, attempt to interact with the Helm console using 'Hold E'. 7. Observe that the console UI does not respond.
- Location: Specify where the bug occurred. Use coordinates if possible, or refer to the panel labeling codes (e.g., "near panel FC-105-L on C Deck"). (The existence of the `/bugtp` command mentioned in Build 0.225.0.88 suggests location data might be automatically included or easily referenced from reports).
- Context: Provide relevant context:
- Game Version (e.g., Dev Build number if applicable - see Game Versions).
- Were you playing Singleplayer or Multiplayer?
- If Multiplayer, were you the Host or a Client?
- What were you doing just before the bug happened?
3. Submit the Report: Once you have filled in the details, use the submit button on the form. Be aware that the submission process might take a few seconds (approx. 10 seconds mentioned in Build 0.225.0.70).
Keeping Track Of Bugs
Current bugs can be tack on this site for the following;
- Looking for currently reported bugs as to not create a duplicate.
- Looking for current status of a bug summited by yourself or another that you have experienced, to track its progress.
- Looking for bugs that have been summited that you can test for and comment on the Discord #Bugtracker-log (requires Specific Backer tiers for access)
What Makes a Good Bug Report?
- Clear & Concise: Easy to understand summary and description.
- Reproducible: Includes reliable Steps to Reproduce (STR).
- Specific: Provides location, context, actual vs. expected results.
- Focused: Reports one bug per submission.
What Not to Report via F1
The F1 Bug Reporter is intended specifically for reporting software defects (bugs). Please use other channels (like official forums or Discord, if available) for:
- Feature Requests or Suggestions
- General Feedback or Opinions
- Support Requests (e.g., account issues)
- Bugs caused by unofficial mods (unless specifically requested by developers)
It's often helpful to quickly check known issue lists or recent reports on community platforms first to avoid duplicates, though reporting a duplicate is better than not reporting at all if you're unsure.
Troubleshooting
The F1 reporting tool itself has undergone development and fixes (Build 0.225.0.70, 0.225.0.74 mentioned crash/issue resolutions). If you encounter problems submitting a report via F1, consider noting the issue on official community channels.
Thank you for helping improve Starship Simulator by submitting detailed bug reports!