From 779b5d15bb11e325db548f4ba19cca95836ded3f Mon Sep 17 00:00:00 2001 From: David G Date: Fri, 22 Mar 2019 21:07:19 -0700 Subject: [PATCH] Update documentation. --- README.md | 24 +++++++++++++----------- init.lua | 6 +++--- settingtypes.txt | 1 + 3 files changed, 17 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 99ae325..e57f0b9 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,8 @@ For Minetest 0.4.x, use the git branch legacy, or the following zip file: [tunne Quick Use Guide --------------- -- Works in creative or survival mode, but must have "tunneling" privileges to use. However, no crafting recipe so needs to be given to player. +- Requires "tunneling" privileges to use: *(/grant <player> tunneling)*. +- No crafting recipe: *(/give <player> tunnelmaker:tool1)*. - Left-click mouse to dig just about any node with one click. - To dig train tunnel: - Point cursor at ground level. @@ -26,10 +27,11 @@ Features *(Does way more than just dig tunnels!)* -------- - Create paths, bridges, and tunnels in all sixteen possible advtrains track directions with one click. - Also digs up or down in the eight possible advtrains slope track directions. -- Digging mode and options can be set using new User Options menu. -- Supports Advanced trains mod with gravel embankment, arched and optionally lined tunnels, and two widths of bridges. -- Supports Bike mod with two widths of cobblestone pathways and bridges, along with unlined tunnels. -- Supports general excavation with unlined and lined tunnels. +- New User Options menu to set digging mode and other options. +- Mode 1: General purpose excavation with unlined and lined tunnels. +- Mode 2: Advanced trains mod with gravel embankment, arched and optionally lined tunnels, and two widths of bridges. +- Mode 3: Bike mod with two widths of cobblestone pathways and bridges, along with unlined tunnels. +- Supports - Adds reference nodes to help digging and laying advtrains track—now easy to remove when done. - Adds glass enclosure when in water to create water tunnels. - Requires "tunneling" privilege, and checks protections before digging. @@ -39,18 +41,18 @@ Features *(Does way more than just dig tunnels!)* ![Bike path up mountain](images/bike_path.png "Bike path up mountain") -Controls *(Revert back to classic controls.)* ----------------------------------------------- -- **Left-click:** Super dig one node. One click digs any node (non-repeating) and places it in player's inventory. However, it can't be used to pick up dropped items. -- **Shift-left-click:** Bring up User Options menu. Can also use Aux-right-click for Android. +Controls +-------- +- **Left-click:** Super dig one node. One click digs nearly any node (non-repeating) and places it in player's inventory. +- **Shift-left-click:** Bring up User Options menu. (Can also use Aux-right-click for Android.) - **Right-click:** - Dig tunnel in direction player pointed. Note that this won't place any of the dug nodes in player's inventory. - **Shift-right-click:** Cycle through vertical digging modes, up, down, and horizontal. How to enable ------------- - Install tunnelmaker mod, requires default and stairs. For nicer bike path ramps, I recommend installing the angledstairs mod, which was used for the picture above, but it's not required. -- Grant player "tunneling" privilege (/grant <player> tunneling). -- To give player a tunnelmaker tool use (/give <player> tunnelmaker:tool1). +- Grant player "tunneling" privilege *(/grant <player> tunneling)*. +- To give player a tunnelmaker tool use *(/give <player> tunnelmaker:tool1)*. How to dig ---------- diff --git a/init.lua b/init.lua index 5b2047d..b68ad31 100644 --- a/init.lua +++ b/init.lua @@ -6,9 +6,8 @@ -- by David G (kestral246@gmail.com) -- and by Mikola --- Version 2.0.4 - 2019-03-14 --- Remove all references to morebl*ks mod. --- This mod will rename all default stairs nodes, so don't use it if you care about stairs. +-- Version 2.0.5 - 2019-03-22 +-- Update documentation. -- Controls for operation ------------------------- @@ -30,6 +29,7 @@ -- User Options defaults (for minetest.conf) ------------------------------------------- -- Initial digging mode for User Options (1, 2, or 3). +-- 1 = General purpose, 2 = Advanced trains, 3 = Bike paths. local tunnel_mode_default = tonumber(minetest.settings:get("tunnel_digging_mode") or 2) -- Train tunnels can be lined with a coating. diff --git a/settingtypes.txt b/settingtypes.txt index c35fcd3..ddf4db1 100644 --- a/settingtypes.txt +++ b/settingtypes.txt @@ -2,6 +2,7 @@ # minetest.conf # Default for digging mode in User config menu. +# 1 = General purpose, 2 = Advanced trains, 3 = Bike paths. # (default = 2) tunnel_digging_mode (Tunnel digging mode) int 2 1 3