Skip to content

Commit

Permalink
docs: A few more small updates
Browse files Browse the repository at this point in the history
  • Loading branch information
bjorn committed Jun 17, 2020
1 parent 6486a76 commit ea7ad58
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 22 deletions.
16 changes: 8 additions & 8 deletions docs/manual/custom-properties.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,14 @@ The property type is used to choose a custom editor in the Properties
view. Choosing a number or boolean type also avoids that the value will
get quoted in JSON and Lua exports.

.. raw:: html

<div class="new">New in Tiled 1.4</div>

The context menu for custom file properties provides a quick way to open the
file in its preferred editor. For object references, there is an action to
quickly jump to the referenced object.

.. raw:: html

<div class="new new-prev">Since Tiled 1.0</div>
Expand Down Expand Up @@ -126,9 +134,6 @@ those values if you need to.
- **Enumerations**, where you can predefine all possible values and it
forms a combo box
(`#1211 <https://github.com/bjorn/tiled/issues/1211>`__).
- **Object references**, which would allow easily linking objects
together and Tiled could display such connections
(`#707 <https://github.com/bjorn/tiled/issues/707>`__).
- **Array properties**, which would be properties having a list of
values (`#1493 <https://github.com/bjorn/tiled/issues/1493>`__).
- **Dictionary properties**, which would be properties that can contain
Expand All @@ -144,11 +149,6 @@ those values if you need to.
defining which custom properties are valid for maps, tilesets, layers,
etc. (`#1410 <https://github.com/bjorn/tiled/issues/1410>`__)

Finally, the predefined properties would work very well together with
explicit **support for projects**. Then you could switch between
different projects or get started on an existing project, without
needing to configure Tiled to use the right object type definitions.

If you like any of these plans, please help me getting around to it
faster by `sponsoring Tiled development <https://www.mapeditor.org/donate>`__. The
more support I receive the more time I can afford to spend improving
Expand Down
36 changes: 24 additions & 12 deletions docs/manual/export.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ While there are many :doc:`libraries and frameworks
also supports a number of additional file and export formats, as well as
:ref:`exporting a map to an image <export-as-image>`.

Exporting can be done by clicking *File > Export*. When triggering the
menu action multiple times, Tiled will only ask for the file name the
first time. Exporting can also be automated using the ``--export-map``
command-line parameter.
Exporting can be done by clicking *File > Export*. When triggering the menu
action multiple times, Tiled will only ask for the file name the first time.
Exporting can also be automated using the ``--export-map`` and
``--export-tileset`` command-line parameters.

Several :ref:`export-options` are available, which are applied to maps
or tilesets before they are exported (without affecting the map
Expand Down Expand Up @@ -228,18 +228,22 @@ what you are doing.
Defold
------

Tiled can export to Defold using one of the two supplied plugins. Both are disabled by default.
Tiled can export to Defold using one of the two supplied plugins. Both are
disabled by default.

**defold**

This plugin exports a map to a `Defold Tile Map <https://www.defold.com/manuals/tilemap/>`__ (\*.tilemap).
This plugin exports a map to a `Defold Tile Map <https://www.defold.com/manuals/tilemap/>`__ (\*.tilemap).
It only supports tile layers and only a single tileset may be used.

Upon export, the ``tile_set`` property of the Tile Map is left empty, so it will need to be set up in Defold after each export.
Upon export, the ``tile_set`` property of the Tile Map is left empty, so it
will need to be set up in Defold after each export.

**defoldcollection**

This plugin exports a map to a `Defold Collection <https://www.defold.com/manuals/building-blocks/>`__ (\*.collection), while also creating multiple .tilemap files.
This plugin exports a map to a `Defold Collection
<https://www.defold.com/manuals/building-blocks/>`__ (\*.collection), while
also creating multiple .tilemap files.

It supports:

Expand All @@ -248,12 +252,20 @@ It supports:

Upon export:

* The ``Path`` property of each Tileset may need to be set up manually in Defold after each export. However, Tiled will attempt to find the .tilesource file corresponding with the name your Tileset in Tiled in your project's ``/tilesources/`` directory. If one is found, manual adjustments won't be necessary.
* The ``Path`` property of each Tileset may need to be set up manually in
Defold after each export. However, Tiled will attempt to find the
.tilesource file corresponding with the name your Tileset in Tiled in your
project's ``/tilesources/`` directory. If one is found, manual adjustments
won't be necessary.

* If you create custom properties on your map called ``x-offset`` and ``y-offset``, these values will be used as coordinates for your top-level GameObject in the Collection. This is useful when working with :doc:`Worlds <worlds>`.
* If you create custom properties on your map called ``x-offset`` and
``y-offset``, these values will be used as coordinates for your top-level
GameObject in the Collection. This is useful when working with :doc:`Worlds
<worlds>`.

All layers of a Tilemap will have Z-index property assigned with values ranging between 0 and 0.1.
The plugin supports the use of 9999 Group Layers and 9999 Tile Layers per Group Layer.
All layers of a Tilemap will have Z-index property assigned with values
ranging between 0 and 0.1. The plugin supports the use of 9999 Group Layers
and 9999 Tile Layers per Group Layer.

When any additional information from the map is needed, the map can be
exported in :ref:`Lua format <lua-export>` and loaded as Defold script.
Expand Down
4 changes: 2 additions & 2 deletions docs/manual/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,8 @@ Debugging Your Script
---------------------

Any errors that happen while parsing or running the script are printed
to the Debug Console, which can be enabled in *View > Views and Toolbars
> Debug Console*.
to the Console, which can be enabled in *View > Views and Toolbars
> Console*.

API Reference
-------------
Expand Down

0 comments on commit ea7ad58

Please sign in to comment.