mirror of
https://github.com/huderlem/porymap.git
synced 2026-08-11 11:26:00 -05:00
Add documentation for prefabs
This commit is contained in:
@@ -167,3 +167,31 @@ Undo & Redo
|
||||
-----------
|
||||
|
||||
When painting metatiles, you can undo and redo actions you take. This makes it very easy to fix mistakes or go back in time. Undo can be performed with ``Ctrl+Z`` or *Edit -> Undo*. Redo can be performed with ``Ctrl+Y`` or *Edit -> Redo*.
|
||||
|
||||
Prefabs
|
||||
-------
|
||||
|
||||
Prefabs, or "prefabricated selections", are a way to optimize your map-editing workflow by defining pre-built metatile selections. This can be useful when larger map objects can't be selected from the main metatile selector window. For example, the Poké Mart building is only partially selectable in the metatile selector view.
|
||||
|
||||
.. figure:: images/editing-map-tiles/prefab-list.png
|
||||
:alt: Prefab Tab
|
||||
|
||||
Prefab Tab
|
||||
|
||||
To create a new prefab, simply select a group of metatiles from the main map view. (See the `Selecting Metatiles`_. section above for how to use right-click-drag to select from the map area.) Then, click the "Create from Selection" button. This will bring up the following window where individual metatiles can be toggled on/off in the prefab. You can also give your prefab a name.
|
||||
|
||||
.. figure:: images/editing-map-tiles/prefab-create.png
|
||||
:alt: Prefab Creation Window
|
||||
|
||||
Prefab Creation Window
|
||||
|
||||
Prefabs are designated for whichever primary and secondary tilesets were used to create them. As such, any prefabs for with tilesets that are incompatible with the currently-opened map will be hidden from the Prefab list.
|
||||
|
||||
To select a prefab to use for painting on the map, simply click on the prefab image in the list view.
|
||||
|
||||
.. figure:: images/editing-map-tiles/prefab-demo.gif
|
||||
:alt: Painting with a Prefab
|
||||
|
||||
Painting with a Prefab
|
||||
|
||||
Prefab data is saved to a JSON file. It defaults to ``<project_root>/prefabs.json``. However, it can be configured in Porymap's project config file.
|
||||
|
||||
BIN
docsrc/manual/images/editing-map-tiles/prefab-create.png
Normal file
BIN
docsrc/manual/images/editing-map-tiles/prefab-create.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.1 KiB |
BIN
docsrc/manual/images/editing-map-tiles/prefab-demo.gif
Normal file
BIN
docsrc/manual/images/editing-map-tiles/prefab-demo.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 352 KiB |
BIN
docsrc/manual/images/editing-map-tiles/prefab-list.png
Normal file
BIN
docsrc/manual/images/editing-map-tiles/prefab-list.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
@@ -48,5 +48,6 @@ determined by this file.
|
||||
``create_map_text_file``, 1 if not ``pokeemerald``, project, yes, A ``text.inc`` or ``text.pory`` file will be created for any new map
|
||||
``enable_triple_layer_metatiles``, 0, project, yes, Enables triple-layer metatiles (See https://github.com/pret/pokeemerald/wiki/Triple-layer-metatiles)
|
||||
``custom_scripts``, , project, yes, A list of script files to load into the scripting engine
|
||||
``prefabs_filepath``, ``<project_root>/prefabs.json``, project, yes, The filepath containing prefab JSON data
|
||||
|
||||
Some of these settings can be toggled manually in porymap via the *Options* menu.
|
||||
|
||||
Reference in New Issue
Block a user