~fgaz/minetest-extruder

f96de7d9f9ca175986c2c957a4cec63c58e74dac — Francesco Gazzetta 1 year, 2 months ago 6c95571
Add settings documentation
2 files changed, 21 insertions(+), 3 deletions(-)

M .cdb.json
M README.md
M .cdb.json => .cdb.json +1 -1
@@ 15,5 15,5 @@
  "issue_tracker": "https://todo.sr.ht/~fgaz/minetest-mods",
  "forums": 28702,
  "short_description": "Adds an extruder tool that can extend continuous surfaces towards the node face that was clicked",
  "long_description": "# Minetest Extruder Tool (`extruder`)\n\nThis [Minetest](https://minetest.net) mod adds an extruder tool that can extend or reduce continuous surfaces towards the node face that was clicked.\n\nRight click (\"place\" action): extrude the clicked surface by one block.\nLeft click (\"use\" action): remove a layer from the clicked surface.\n\n## How is it different from `//copy` from WorldEdit?\n\nGood question!\n\nWorldEdit operates on rectangular cuboids (boxes), so for example it isn't possible to extend the edge of a cylinder without also extending its contents.\n`extruder` instead operates on surfaces of any shape and size.\nIt is also remarkably easier to use, not requiring any command at all.\nOn the other hand, at the moment `extruder` can only replicate a single 1-node-thin slice of the selection.\n\n## License\n\nCode is licensed under the EUPL-1.2-or-later.\nYou can find the text of this license in the LICENSE file or in multiple languages at https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12\n\nAssets are licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.\n"
  "long_description": "# Minetest Extruder Tool (`extruder`)\n\nThis [Minetest](https://minetest.net) mod adds an extruder tool that can extend or reduce continuous surfaces towards the node face that was clicked.\n\nRight click (\"place\" action): extrude the clicked surface.\nLeft click (\"use\" action): remove the clicked surface.\nRight click on air (\"secondary use\" action): open settings dialog.\n\n## Settings\n\n* **Extrusion amount**: How many nodes to extrude (or remove) on top of each node of the clicked surface.\n* **Allow overwriting**: If enabled, existing nodes other than air in the space occupied by the extrusion will be overwritten.\n* **Select through vertices (diagonally)**: If enabled, the selection will expand through vertices too. If disabled, it will expand only through sides. Here's an example. `░` is a node, `█` is the clicked node, `▓` is a selected node.\n  * Disabled:\n    ```\n    ▓ ░░\n    ▓█\n    ```\n  * Enabled:\n    ```\n    ▓ ▓▓\n    ▓█\n    ```\n* **Only select nodes of the same type**: If enabled, the selection will expand only through the same node. For example, if you click on wood, only wood will be extruded. If disabled, the selection will expand through any node except air.\n\n## How is it different from `//copy` from WorldEdit?\n\nGood question!\n\nWorldEdit operates on rectangular cuboids (boxes), so for example it isn't possible to extend the edge of a cylinder without also extending its contents.\n`extruder` instead operates on surfaces of any shape and size.\nIt is also remarkably easier to use, not requiring any command at all.\nOn the other hand, at the moment `extruder` can only replicate a single 1-node-thin slice of the selection.\n\n## License\n\nCode is licensed under the EUPL-1.2-or-later.\nYou can find the text of this license in the LICENSE file or in multiple languages at https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12\n\nAssets are licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.\n"
}

M README.md => README.md +20 -2
@@ 2,8 2,26 @@

This [Minetest](https://minetest.net) mod adds an extruder tool that can extend or reduce continuous surfaces towards the node face that was clicked.

Right click ("place" action): extrude the clicked surface by one block.
Left click ("use" action): remove a layer from the clicked surface.
Right click ("place" action): extrude the clicked surface.
Left click ("use" action): remove the clicked surface.
Right click on air ("secondary use" action): open settings dialog.

## Settings

* **Extrusion amount**: How many nodes to extrude (or remove) on top of each node of the clicked surface.
* **Allow overwriting**: If enabled, existing nodes other than air in the space occupied by the extrusion will be overwritten.
* **Select through vertices (diagonally)**: If enabled, the selection will expand through vertices too. If disabled, it will expand only through sides. Here's an example. `░` is a node, `█` is the clicked node, `▓` is a selected node.
  * Disabled:
    ```
    ▓ ░░
    ▓█
    ```
  * Enabled:
    ```
    ▓ ▓▓
    ▓█
    ```
* **Only select nodes of the same type**: If enabled, the selection will expand only through the same node. For example, if you click on wood, only wood will be extruded. If disabled, the selection will expand through any node except air.

## How is it different from `//copy` from WorldEdit?