Skip to content

Commit

Permalink
Added bug reporting guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeryn99 committed Jan 11, 2025
1 parent 0cae39b commit 173ceaf
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
38 changes: 38 additions & 0 deletions Writerside/topics/bugs/BugReporting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Bug Reporting Guide

If you encounter an issue with the mod, the best way to get help is by using our [GitHub Issues page](https://github.com/WhoCraft/TardisRefined/issues). This helps us accurately track problems, assign them to developers, and tag them with relevant details.

## Reporting Bugs

1. **Visit**: [GitHub Issues](https://github.com/WhoCraft/TardisRefined/issues)
2. **Provide**:
- A detailed description of the issue.
- Logs or crash reports, if applicable.
- Screenshots or videos showcasing the problem.
- Your computer specifications (e.g., OS, RAM, GPU).

---

## Known Bugs

### Console Room Rendering Issues During Flight

Sometimes, the console room may not render correctly while the TARDIS is in flight. We are actively investigating this issue.

To help us:
1. Visit the related issue page: [#423](https://github.com/WhoCraft/TardisRefined/issues/423).
2. Provide:
- A log file.
- An image of the rendering issue.
- Your computer specifications.

### Temporary Fix: Disable Fancy Rendering
To improve gameplay while we resolve this issue, you can disable the vortex rendering:

1. Close the game.
2. Navigate to your mods' config folder.
3. Open `tardis_refined-client.toml` in a text editor (e.g., Notepad).
4. Find the `disable_fancy_rendering` setting and set it to `true`.
5. Save the file and restart the game.

This will disable the vortex rendering in the doorway, temporarily fixing the issue. Enjoy your gameplay experience!
3 changes: 3 additions & 0 deletions Writerside/tr.tree
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@
</toc-element>
</toc-element>

<toc-element topic="BugReporting.md"/>

<toc-element topic="Compatiblity.md">
<toc-element topic="AdventureMode.md"/>
<toc-element topic="Shaders.md"/>
Expand All @@ -71,6 +73,7 @@
</toc-element>



<toc-element topic="Addon-Creation.md">
<toc-element topic="KnowAnyAddons.md"/>
<toc-element topic="Adding-Tardis-Refined.md"/>
Expand Down

0 comments on commit 173ceaf

Please sign in to comment.