From 0ba3a4684b6cd55cafcb7d773b8000cc4f14bb0f Mon Sep 17 00:00:00 2001 From: myk002 Date: Mon, 18 Jul 2022 16:13:04 -0700 Subject: [PATCH] update docs for automaterial --- docs/plugins/automaterial.rst | 54 +++++++++++++++++++++-------------- 1 file changed, 33 insertions(+), 21 deletions(-) diff --git a/docs/plugins/automaterial.rst b/docs/plugins/automaterial.rst index 81de0cb3d..51701a1fc 100644 --- a/docs/plugins/automaterial.rst +++ b/docs/plugins/automaterial.rst @@ -1,33 +1,45 @@ automaterial ============ -This makes building constructions (walls, floors, fortifications, etc) a little bit -easier by saving you from having to trawl through long lists of materials each time -you place one. -Firstly, it moves the last used material for a given construction type to the top of -the list, if there are any left. So if you build a wall with chalk blocks, the next -time you place a wall the chalk blocks will be at the top of the list, regardless of -distance (it only does this in "grouped" mode, as individual item lists could be huge). -This should mean you can place most constructions without having to search for your -preferred material type. +Sorts building materials by recent usage. This makes building constructions +(walls, floors, fortifications, etc) much easier by saving you from having to +trawl through long lists of materials each time you place one. + +It moves the last used material for a given construction type to the top of the +list, if there are any left. So if you build a wall with chalk blocks, the next +time you place a wall the chalk blocks will be at the top of the list, +regardless of distance (it only does this in "grouped" mode, as individual item +lists could be huge). This means you can place most constructions without having +to search for your preferred material type. + +Usage:: + + enable automaterial .. image:: ../images/automaterial-mat.png -Pressing :kbd:`a` while highlighting any material will enable that material for "auto select" -for this construction type. You can enable multiple materials as autoselect. Now the next -time you place this type of construction, the plugin will automatically choose materials -for you from the kinds you enabled. If there is enough to satisfy the whole placement, -you won't be prompted with the material screen - the construction will be placed and you -will be back in the construction menu as if you did it manually. +Pressing :kbd:`a` while highlighting any material will enable that material for +"auto select" for this construction type. You can enable multiple materials. Now +the next time you place this type of construction, the plugin will automatically +choose materials for you from the kinds you enabled. If there is enough to +satisfy the whole placement, you won't be prompted with the material screen at +all -- the construction will be placed and you will be back in the construction +menu. When choosing the construction placement, you will see a couple of options: .. image:: ../images/automaterial-pos.png -Use :kbd:`a` here to temporarily disable the material autoselection, e.g. if you need -to go to the material selection screen so you can toggle some materials on or off. +Use :kbd:`a` here to temporarily disable the material autoselection, e.g. if you +need to go to the material selection screen so you can toggle some materials on +or off. + +The other option (auto type selection, off by default) can be toggled on with +:kbd:`t`. If you toggle this option on, instead of returning you to the main +construction menu after selecting materials, it returns you back to this screen. +If you use this along with several autoselect enabled materials, you should be +able to place complex constructions more conveniently. -The other option (auto type selection, off by default) can be toggled on with :kbd:`t`. If you -toggle this option on, instead of returning you to the main construction menu after selecting -materials, it returns you back to this screen. If you use this along with several autoselect -enabled materials, you should be able to place complex constructions more conveniently. +The ``automaterial`` plugin also enables extra contruction placement modes, such +as designating areas larger than 10x10 and allowing you to designate hollow +rectangles instead of the default filled ones.