Updated the documentation.

This commit is contained in:
drwhut 2024-09-04 12:58:19 +01:00
parent 72d6b29a1a
commit 163cd2653e
4 changed files with 36 additions and 28 deletions

View File

@ -68,6 +68,13 @@ Here is a simple example that will apply a back face texture (in this example,
; back face will be imported.
ignore = true
.. tip::
When cards are placed in other player's hands, the front face is covered
with the colour at the top-left pixel. If your cards use different background
colours, consider adding a border around the edge of the front face so that
other players cannot tell the difference between the cards.
.. _object-type-container:

View File

@ -9,6 +9,11 @@ what are called **asset packs**, which are essentially just specially-made
folders. This chapter describes the specification for the custom assets, and
the asset packs that contain them.
If you just want to download community-made asset packs and install them, feel
free to have a look at the `official forum <https://forum.tabletopclub.net/c/asset-packs>`_.
Instructions for installing asset packs can be found
`here <https://forum.tabletopclub.net/t/about-the-asset-packs-category/13>`_.
For reference, you can have a look at the Tabletop Club asset pack, which comes
with the game by default.

View File

@ -29,20 +29,17 @@ command in a terminal to download the fork of Godot:
.. note::
The version number after ``-b tabletop`` refers to the Godot version the
modified code is based on. You might need to change which version of Godot
to download if you're planning on downloading a specific version of
Tabletop Club, as different versions of Tabletop Club might use different
versions of Godot.
The text after ``-b`` refers to the branch of the fork that is downloaded.
You may need to change the branch depending on which version of Tabletop Club
you plan to compile:
If you just plan on downloading the current ``master`` branch from
Tabletop Club, then you don't need to change the above command.
If you know which version of Tabletop Club you want to download, check this
page in it's documentation and look for a command similar to the one above.
Then, replace what comes after the ``-b`` above with what the documentation
says. This way, you know you're compiling a compatible version of Godot for
the Tabletop Club version you want.
+-----------------------+---------------+--------------------+
| Tabletop Club Version | Godot Version | Git Branch |
+=======================+===============+====================+
| 0.1.x | 3.4.5 | ``tabletop-3.4.5`` |
+-----------------------+---------------+--------------------+
| 0.2.x | 3.5.3 | ``tabletop-3.5.3`` |
+-----------------------+---------------+--------------------+
.. tip::
@ -71,20 +68,15 @@ For all platforms, you will need *at least* the following:
* `Python 3.5+ <https://www.python.org/downloads/>`_. Make sure Python is added
to your ``PATH`` environment variable.
* `SCons 3.0+ <https://www.scons.org/>`_. Once you have Python installed, you
can install it by opening a terminal/command prompt and running:
* `SCons 3.0+ <https://www.scons.org/>`_.
.. code-block:: bash
You can check to see whether you have installed Python and SCons correctly by
running:
python -m pip install scons
You can check to see whether you have installed Python and SCons correctly by
running:
.. code-block:: bash
.. code-block:: bash
python --version
scons --version
python --version
scons --version
Compiling Godot for Windows

View File

@ -44,10 +44,14 @@ As a standalone executable
--------------------------
You can also download the game as a standalone application that you can run
anywhere on your system from the `itch.io page
<https://drwhut.itch.io/tabletop-club>`_, or from the `GitHub repository
<https://github.com/drwhut/tabletop-club/releases>`_. Once it is downloaded,
there's only a couple of steps needed to run the game (see below)!
anywhere on your system from the following websites:
* `tabletopclub.net <https://tabletopclub.net/downloads>`_
* `github.com <https://github.com/drwhut/tabletop-club/releases>`_
* `itch.io <https://drwhut.itch.io/tabletop-club>`_
Once you have downloaded the game, there's only a couple of steps left in order
to play it (see below)!
In most cases, you'll want to download the latest *stable* version of the game.
While beta versions of the game have new features and are very helpful for