1User Preferences
2================
3
4There are only a few options located in the Preferences, accessible
5though the menu via *Edit > Preferences*. Most other options, like
6whether to draw the grid, what kind snapping to do or the last used
7settings when creating a new map are simply remembered persistently.
8
9The preferences are stored in a system-dependent format and location:
10
11+-------------+-----------------------------------------------------------------+
12| **Windows** | Registry key ``HKEY_CURRENT_USER\SOFTWARE\mapeditor.org\Tiled`` |
13+-------------+-----------------------------------------------------------------+
14| **macOS**   | :file:`~/Library/Preferences/org.mapeditor.Tiled.plist`         |
15+-------------+-----------------------------------------------------------------+
16| **Linux**   | :file:`~/.config/mapeditor.org/tiled.conf`                      |
17+-------------+-----------------------------------------------------------------+
18
19
20General
21-------
22
23.. figure:: images/preferences-general.png
24   :alt: General Preferences
25   :scale: 50
26   :align: right
27
28Saving and Loading
29~~~~~~~~~~~~~~~~~~
30
31Include DTD reference in saved maps
32    This option is not enabled by default, since it is of very little
33    use whereas it can in some environments cause problems. Feel free to
34    enable it if it helps with validation for example, but note that the
35    referenced DTD is likely out of date (there is a somewhat more up-to-date
36    XSD file available in the repository).
37
38Reload tileset images when they change
39    This is very useful while working on the tiles or when the tiles
40    might change as a result of a source control system.
41
42Open last files on startup
43    Generally a useful thing to keep enabled.
44
45Use safe writing of files
46    This setting causes files to be written to a temporary file, and
47    when all went well, to be swapped with the target file. This avoids
48    data getting lost due to errors while saving or due to insufficient
49    disk space. Unfortunately, it is known to cause issues when saving
50    files to a Dropbox folder or a network drive, in which case it helps
51    to disable this feature.
52
53.. raw:: html
54
55   <div class="new new-prev">Since Tiled 1.2</div>
56
57.. _export-options:
58
59Export Options
60~~~~~~~~~~~~~~
61
62The following export options are applied each time a map or tileset gets
63exported, without affecting the map or tileset itself.
64
65Embed tilesets
66    All tilesets are embedded in the exported map. Useful for example
67    when you are exporting to JSON and loading an external tileset is
68    not desired.
69
70Detach templates
71    All template instances are detached. Useful when you want to use the
72    templates feature but can't or don't want to load the external
73    template object files.
74
75Resolve object types and properties
76    Stores effective object type and properties with each object.
77    Object properties are inherited from a tile (in case of a tile
78    object) and from the default properties of their type.
79
80Minimize output
81    Omits unnecessary whitespace in the output file. This option is supported
82    for XML (TMX and TSX), JSON and Lua formats.
83
84These options are also available as options when exporting using the
85command-line.
86
87Interface
88---------
89
90Interface
91~~~~~~~~~
92
93Language
94    By default the language tries to match that of the system, but if it
95    picks the wrong one you can change it here.
96
97Grid colour
98    Because black is not always the best color for the grid.
99
100Fine grid divisions
101    The tile grid can be divided further using this setting, which
102    affects the "Snap to Fine Grid" setting in the *View > Snapping*
103    menu.
104
105Object line width
106    Shapes are by default rendered with a 2 pixel wide line, but some
107    people like it thinner or even thicker. On some systems the DPI-based
108    scaling will affect this setting as well.
109
110.. raw:: html
111
112   <div class="new">New in Tiled 1.5</div>
113
114Object selection behavior
115    By default the :ref:`select-objects-tool` tool selects objects from any
116    layer. With this setting, you can make it prefer to select objects from the
117    currently selected layers, or to only pick objects from the selected
118    layers.
119
120    When the "Highlight Current Layer" option is enabled, Tiled automatically
121    prefers to select objects from the currently selected layers.
122
123Hardware accelerated drawing (OpenGL)
124    This enables a rather unoptimized way of rendering the map using
125    OpenGL. It's usually not an improvement and may lead to crashes, but
126    in some scenarios it can make editing more responsive.
127
128.. raw:: html
129
130   <div class="new new-prev">Since Tiled 1.1</div>
131
132Mouse wheel zooms by default
133    This option causes the mouse wheel to zoom without the need to hold
134    Control (or Command on macOS). It can be a convenient way to
135    navigate the map, but it can also interfere with panning on a
136    touchpad.
137
138.. raw:: html
139
140   <div class="new">New in Tiled 1.5</div>
141
142Middle mouse button uses auto-scrolling
143    With this option enabled, the clicking middle mouse button doesn't drag the
144    map directly but instead controls the speed of a continuous panning
145    movement.
146
147.. raw:: html
148
149   <div class="new">New in Tiled 1.5</div>
150
151Use smooth scrolling
152    This option affects the behavior when scrolling with the arrow keys. When
153    disabled, the view scrolls in steps based on key press events. When enabled
154    (the default), the view scrolls continuously while the keys are held down.
155
156.. raw:: html
157
158   <div class="new new-prev">Since Tiled 1.3</div>
159
160Updates
161~~~~~~~
162
163By default, Tiled checks for news and new versions and highlights any updates
164in the status bar. Here you can disable this functionality. It is recommended
165to keep at least one of these enabled.
166
167If you disable displaying of new versions, you can still manually check
168whether a new version is available by opening the *About Tiled* dialog.
169
170.. raw:: html
171
172   <div class="new new-prev">Since Tiled 1.3</div>
173
174.. _keyboard-options:
175
176Keyboard
177--------
178
179Here you can add, remove or change the keyboard shortcuts of most available
180actions.
181
182Conflicting keybindings are highlighted in red. They will not work until you
183resolve the conflict.
184
185If you customize multiple shortcuts, it is recommended to use the export
186functionality to save the keybindings somewhere, so that you can easily
187recover that setup or copy it to other Tiled installations.
188
189
190Theme
191-----
192
193On Windows and Linux, the default style used by Tiled is "Tiled Fusion".
194This is a customized version of the "Fusion" style that ships with Qt.
195On macOS, this style can also be used, but because it looks so out of
196place the default is "Native" there.
197
198The "Tiled Fusion" style allows customizing the base color. When
199choosing a dark base color, the text automatically switches to white and
200some other adjustments are made to keep things readable. You can also
201choose a custom selection color.
202
203The "Native" style tries to fit in with the operating system, and is
204available since it is in some cases preferable to the custom style. The
205base color and selection color can't be changed when using this style,
206as they depend on the system.
207
208Plugins
209-------
210
211Here you can choose which plugins are enabled, as well as opening the
212:doc:`scripted extensions </reference/scripting>` folder.
213
214Plugins add support for map and/or tileset file formats. Some generic plugins
215are enabled by default, while more specific ones need to be manually enabled.
216
217There is no need to restart Tiled when enabling or disabling plugins.
218When a plugin fails to load, try hovering its icon to see if the tool
219tip displays a useful error message.
220
221See :doc:`export` for more information about supported file formats.
222