Skip to content

Docs: Add Flatpak log directory & asset troubleshooting paragraph #315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Docs: Add Flatpak log directory & asset troubleshooting paragraph #315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41b90d2
Docs: Add location for Flatpak logs
AuroraBorealish Jan 21, 2024
8d41275
Docs: Add troubleshooting to asset tutorial
AuroraBorealish Jan 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/custom_assets/tutorials/create_asset_pack.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

If that doesn't help either, an error might have occured when trying to import it.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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."

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.
Comment on lines +39 to +43
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

1 change: 1 addition & 0 deletions docs/general/contributing/ways_to_contribute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slight nitpick, but for consistency the 'p' should be lowercase in 'Flatpak'.


.. hint::

Expand Down