File: preferences.rst

package info (click to toggle)
tiled-qt 1.2.1%2Bdfsg.1-1
  • links: PTS
  • area: main
  • in suites: buster
  • size: 31,084 kB
  • sloc: cpp: 85,970; java: 3,602; python: 1,469; xml: 1,251; sh: 56; makefile: 32; ruby: 15
file content (164 lines) | stat: -rw-r--r-- 5,928 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
User Preferences
================

There are only a few options located in the Preferences, accessible
though the menu via *Edit > Preferences*. Most other options, like
whether to draw the grid, what kind snapping to do or the last used
settings when creating a new map are simply remembered persistently.

The preferences are stored in a system-dependent format and location:

+-------------+-----------------------------------------------------------------+
| **Windows** | Registry key ``HKEY_CURRENT_USER\SOFTWARE\mapeditor.org\Tiled`` |
+-------------+-----------------------------------------------------------------+
| **macOS**   | ``~/Library/Preferences/org.mapeditor.Tiled.plist``             |
+-------------+-----------------------------------------------------------------+
| **Linux**   |  ``~/.config/mapeditor.org/tiled.conf``                         |
+-------------+-----------------------------------------------------------------+


General
-------

.. figure:: images/preferences-general.png
   :alt: General Preferences
   :scale: 50
   :align: right

Saving and Loading
~~~~~~~~~~~~~~~~~~

Include DTD reference in saved maps
    This option is not enabled by default, since it is of very little
    use whereas it can in some environments cause problems. Feel free to
    enable it if it helps with validation for example, but note that the
    referenced DTD is likely out of date (there is a somewhat more up-to-date
    XSD file available in the repository).

Reload tileset images when they change
    This is very useful while working on the tiles or when the tiles
    might change as a result of a source control system.

Open last files on startup
    Generally a useful thing to keep enabled.

Use safe writing of files
    This setting causes files to be written to a temporary file, and
    when all went well, to be swapped with the target file. This avoids
    data getting lost due to errors while saving or due to insufficient
    disk space. Unfortunately, it is known to cause issues when saving
    files to a Dropbox folder or a network drive, in which case it helps
    to disable this feature.

.. raw:: html

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

.. _export-options:

Export Options
~~~~~~~~~~~~~~

The following export options are applied each time a map or tileset gets
exported, without affecting the map or tileset itself.

Embed tilesets
    All tilesets are embedded in the exported map. Useful for example
    when you are exporting to JSON and loading an external tileset is
    not desired.

Detach templates
    All template instances are detached. Useful when you want to use the
    templates feature but can't or don't want to load the external
    template object files.

Resolve object types and properties
    Stores effective object type and properties with each object.
    Object properties are inherited from a tile (in case of a tile
    object) and from the default properties of their type.

These options are also available as options when exporting using the command-line.

Interface
---------

Interface
~~~~~~~~~

Language
    By default the language tries to match that of the system, but if it
    picks the wrong one you can change it here.

Grid colour
    Because black is not always the best color for the grid.

Fine grid divisions
    The tile grid can be divided further using this setting, which
    affects the "Snap to Fine Grid" setting in the *View > Snapping*
    menu.

Object line width
    Shapes are by default rendered with a 2 pixel wide line, but some
    people like it thinner or even thicker. On some systems the DPI-based
    scaling will affect this setting as well.

Hardware accelerated drawing (OpenGL)
    This enables a rather unoptimized way of rendering the map using
    OpenGL. It's usually not an improvement and may lead to crashes, but
    in some scenarios it can make editing more responsive.

.. raw:: html

   <div class="new new-prev">Since Tiled 1.1</div>

Mouse wheel zooms by default
    This option causes the mouse wheel to zoom without the need to hold
    Control (or Command on macOS). It can be a convenient way to
    navigate the map, but it can also interfere with panning on a
    touchpad.

Theme
~~~~~

On Windows and Linux, the default style used by Tiled is "Tiled Fusion".
This is a customized version of the "Fusion" style that ships with Qt.
On macOS, this style can also be used, but because it looks so out of
place the default is "Native" there.

The "Tiled Fusion" style allows customizing the base color. When
choosing a dark base color, the text automatically switches to white and
some other adjustments are made to keep things readable. You can also
choose a custom selection color.

The "Native" style tries to fit in with the operating system, and is
available since it is in some cases preferable to the custom style. The
base color and selection color can't be changed when using this style,
as they depend on the system.

Updates
-------

The official macOS builds and the Windows installers of Tiled ship with
an automatic update check, done by `Sparkle`_ and `WinSparkle`_
respectively. These solutions also offer to download the new version
and to upgrade or run the installer afterwards.

You can turn off the update checks or trigger them manually using the
*Check Now* button.

Plugins
-------

Here you can choose which plugins are enabled. Currently plugins only
serve to add support for additional map and/or tileset file formats.
Some generic plugins are enabled by default, while more specific ones
need to be manually enabled.

There is no need to restart Tiled when enabling or disabling plugins.
When a plugin fails to load, try hovering its icon to see if the tool
tip displays a useful error message.

See :doc:`export` for more information about supported file formats.

.. _Sparkle: https://sparkle-project.org/
.. _WinSparkle: https://winsparkle.org/