Docs: Add Flatpak log directory & asset troubleshooting paragraph #315
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
drwhut
requested changes
Jan 22, 2024
| @@ -28,6 +28,7 @@ find the game logs in the following folders: | |||
| * Windows: ``%APPDATA%/Tabletop Club/logs/`` | |||
| * macOS: ``~/Library/Application Support/Tabletop Club/logs`` | |||
| * Linux: ``~/.local/share/Tabletop Club/logs/`` | |||
| * Linux using FlatPak: ``~/.var/app/io.itch.drwhut.TabletopClub/data/Tabletop Club/logs`` | |||
There was a problem hiding this comment.
Slight nitpick, but for consistency the 'p' should be lowercase in 'Flatpak'.
| @@ -33,3 +33,11 @@ Once you have added what you want to your asset pack, you can either restart the | |||
| game, or go to :guilabel:`Options` > :guilabel:`General`, and click | |||
| :guilabel:`Reimport Assets` to have the game import everything you've added so | |||
| you can use it in-game! | |||
|
|
|||
| If your asset pack doesn't appear, try restarting the entire game. | |||
There was a problem hiding this comment.
This line is somewhat redundant - The previous paragraph already suggests to either restart the game, or use the options menu to re-import the assets.
| @@ -33,3 +33,11 @@ Once you have added what you want to your asset pack, you can either restart the | |||
| game, or go to :guilabel:`Options` > :guilabel:`General`, and click | |||
| :guilabel:`Reimport Assets` to have the game import everything you've added so | |||
| you can use it in-game! | |||
|
|
|||
| If your asset pack doesn't appear, try restarting the entire game. | |||
| If that doesn't help either, an error might have occured when trying to import it. | |||
There was a problem hiding this comment.
Tweak to something like "If after restarting the game or re-importing all assets, you do not see your content, an error might have occurred when trying to import it."
Comment on lines
+39
to
+43
| You can see what went wrong by checking the import log on the main-menu screen, | ||
| click the leftmost button on the bottom of the screen, labeled with an exclamation | ||
| point ``(!)`` to open it. If all else fails, searching for "ERROR" or your | ||
| AssetPack's name in the latest logfile (see :ref:`ways_to_contribute`) can show | ||
| more details of what went wrong. |
There was a problem hiding this comment.
This bit's okay, but it might be worth also including a cropped screenshot showing the button that appears for the import log, just below the description for it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes/Solves
Adds the path to the log directory for Flatpak users, which is different from the regular logfile directory. Also adds paragraph that can help Asset Pack creators who might not be aware of how to find import errors.