tunnelmaker/README.md

93 lines
4.4 KiB
Markdown
Raw Normal View History

2017-04-21 09:40:51 -07:00
![Tunnelmaker Screenshot](screenshot.png "Tunnelmaker")
A Minetest Mod to easily create arbitrarily curved tunnels.
Especially designed to make laying track for the advtrains mod easier.
by David G (kestral246@gmail.com)
Features
--------
2018-05-21 10:02:24 -07:00
- Creates tunnel segments in any of the sixteen possible advtrains track directions with one click.
2017-04-21 09:40:51 -07:00
- Direction of digging based on direction player is pointing.
2018-05-21 10:02:24 -07:00
- Provides changing icon to help player align in proper direction, based on compassgps mod.
- Checks ceiling for blocks capable of falling, and replaces them with cobblestone.
2018-05-21 10:02:24 -07:00
- Adds cobblestone reference blocks in floor to show next dig point, and to help with placing advtrains track.
2018-05-21 09:09:27 -07:00
- Adds torches to ceiling if ceiling is stone or desert_stone, to help with seeing.
- Only allows tunnel digging when in creative mode.
2017-04-21 09:40:51 -07:00
- Uses privileges, requires "tunneling" privilege to be able to use.
- Checks protection, and doesn't dig any protected nodes.
2018-05-21 09:09:27 -07:00
2017-04-21 09:40:51 -07:00
- Reference point is at ground level: possible to increase or decrease the grade by changing the height of the reference node.
- Fills in holes in flooring with stone.
2017-04-21 09:40:51 -07:00
- Works outside of tunnels to clear ground and provide cuts and fills.
How to use
----------
2018-05-21 09:09:27 -07:00
Minetest needs to be in creative mode for this mod to work—it is too overpowered otherwise.
2017-04-21 09:40:51 -07:00
Player needs to have tunneling privilege to be able to use the tunnelmaker tool (/grant <player> tunneling).
To give player a tunnelmaker tool use (/give <player> tunnelmaker:1). *See below for crafting recipe.*
The following diagrams show how to make curved tunnels that support the different track configurations used by advtrains. There are three basic directions that are supported: 0° (orthogonal, rook moves), 45° (diagonal, bishop moves), and 26.6° (knight moves, two blocks forward and one block to the side).
To use this mod, move your character to the existing end of the tunnel, highlight the gray node marked with an x, and point character in direction of red arrow. The icon in the inventory, if visible, will change it's image to confirm direction. Then right-click mouse to dig the green highlighted area. (Note that turns with angles other than those show are possible, but aren't supported by advtrains track.)
Using left-click digs similarly to a wooden pickaxe, which is useful for making minor adjustments.
To increase the grade, place a block on the gray node and select that before right-clicking. To decrease the grade, dig out the gray node and select the lower node before right-clicking. (Note that advtrains only supports slopes for 0° and 45° track.)
![Turns from 0°](images/dir0.png "Turns from 0")
![Turns from 26.6°](images/dir26.png "Turns from 26.6")
![Turns from 45°](images/dir45.png "Turns from 45")
Update
------
Switched digging function from dig_node to node_dig. This was based on what matyilona200 used for the tunneltest mod. Thanks matyilona! This gives several improvements:
- When tunneling, the inventory adds only a single instance of each type of block dug. Still works if inventory is full.
- Works the same with minetest versions 0.4.16 and 0.5.0-dev—no more blocks raining down.
- Works with digall mod enabled. However, make sure digall is deactivated before tunneling!
Digging pattern reference
-------------------------
Here are all sixteen possible digging patterns for reference. The white blocks have a height of 5 blocks, while the light gray blocks on the sides have a height of 4 blocks. Ground fill is only done in white block area.
2018-05-21 10:38:34 -07:00
![Digging patterns](images/digging_patterns.png "Digging patterns")
2018-05-21 10:38:34 -07:00
2017-04-21 09:40:51 -07:00
Crafting guide
--------------
```
diamondblock mese_block diamondblock
mese_block diamondblock mese_block
diamondblock mese_block diamondblock
```
![Crafting guide](images/crafting.png "Crafting guide")
License
-------
- **textures:** License CC0-1.0
- **code:** My changes to original code are CC0-1.0
- **original compassgps license:** Original code by Echo, PilzAdam, and TeTpaAka is WTFPL. Kilarin (Donald Hines) changes are CC0 (No rights reserved)
Thanks
------
- [advtrains](https://github.com/orwell96/advtrains/) / orwell96, et.
al. - For providing the amazing advtrains mod that this mod tries to make
just a little easier to use.
- [compassgps](https://github.com/Kilarin/compassgps) / Kilarin (Donald Hines),
et. al. - Top level code to change icon based on direction player is pointing.