Treasures (#50)

* Add Netherrack slabs and walls

Also adds deep netherrack stairs, and deep nether brick stairs, slabs, inner stairs and outer stairs.
Adds 9 new nodes in total.

* Treasure: Nether pickaxe takes 10x less wear damage when mining netherrack

cracky-3 mining time of Nether pickaxe reduced from 0.4 to 0.3 to mine netherrack faster.
maxlevel of nether pickaxe dropped from 3 to 2 to increase wear damage with non-netherrack nodes.

* Treasure: Nether staff of light

Adds "Nether staff of Light" and "Nether staff of Eternal Light"
One is limited to 60 uses, and the other has unlimited uses but the glowstone it creates will only last for 40 seconds.
There are no crafting recipes as I hope these to eventually be treasure that can be found in the nether.

See the pull request (#50) for more discussion

README.md

@@ -16,6 +16,8 @@ right-click/used on the frame to activate it.
 
 See portal_api.txt for how to create custom portals to your own realms.
 
+Nether Portals can allow surface fast-travel.
+
 This mod provides Nether basalts (natural, hewn, and chiseled) as nodes which
 require a player to journey to the magma ocean to obtain, so these can be used
 for gating progression through a game. For example, a portal to another realm
@@ -24,8 +26,7 @@ the nether first, or basalt might be a crafting ingredient required to reach
 a particular branch of the tech-tree.
 
 Netherbrick tools are provided (pick, shovel, axe, & sword), see tools.lua
-
-Nether Portals can allow surface fast-travel.
+The Nether pickaxe has a 10x bonus again wear when mining netherrack.
 
 
 ## License of source code:
@@ -50,9 +51,11 @@ SOFTWARE.
 ### [Public Domain Dedication (CC0 1.0)](https://creativecommons.org/publicdomain/zero/1.0/)
 
  * `nether_portal_teleport.ogg` is a timing adjusted version of "teleport" by [outroelison](https://freesound.org/people/outroelison), used under CC0 1.0
+ * `nether_rack_destroy.ogg` is from "Rock destroy" by [Bertsz](https://freesound.org/people/Bertsz/), used under CC0 1.0
 
 ### [Attribution 3.0 Unported (CC BY 3.0)](https://creativecommons.org/licenses/by/3.0/)
 
+ * `nether_lightstaff.ogg` is "Fire Burst" by [SilverIllusionist](https://freesound.org/people/SilverIllusionist/), 2019
  * `nether_portal_ambient.ogg` & `nether_portal_ambient.0.ogg` are extractions from "Deep Cinematic Rumble Stereo" by [Patrick Lieberkind](http://www.lieberkindvisuals.dk), used under CC BY 3.0
  * `nether_portal_extinguish.ogg` is an extraction from "Tight Laser Weapon Hit Scifi" by [damjancd](https://freesound.org/people/damjancd), used under CC BY 3.0
  * `nether_portal_ignite.ogg` is a derivative of "Flame Ignition" by [hykenfreak](https://freesound.org/people/hykenfreak), used under CC BY 3.0. "Nether Portal ignite" is licensed under CC BY 3.0 by Treer.
@@ -60,9 +63,11 @@ SOFTWARE.
 ### [Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)](https://creativecommons.org/licenses/by-sa/4.0/)
  * `nether_basalt`* (files starting with "nether_basalt"): Treer, 2020
  * `nether_book_`* (files starting with "nether_book"): Treer, 2019-2020
+ * `nether_brick_deep.png`: Treer, 2021
  * `nether_fumarole.ogg`: Treer, 2020
  * `nether_lava_bubble`* (files starting with "nether_lava_bubble"): Treer, 2020
  * `nether_lava_crust_animated.png`: Treer, 2019-2020
+ * `nether_lightstaff.png`: Treer, 2021
  * `nether_particle_anim`* (files starting with "nether_particle_anim"): Treer, 2019
  * `nether_portal_ignition_failure.ogg`: Treer, 2019
  * `nether_smoke_puff.png`: Treer, 2020
@@ -74,4 +79,4 @@ SOFTWARE.
  * `nether_rack`* (files starting with "nether_rack"): Zeg9
  * `nether_tool_`* (files starting with "nether_tool_"): color adjusted versions from "[default](https://github.com/minetest/minetest_game/tree/master/mods/default)" mod, originals by BlockMen
 
-All other media: Copyright © 2013 PilzAdam, licensed under CC BY-SA 3.0 by PilzAdam.
+All other media: Copyright © 2013 PilzAdam, licensed under CC BY-SA 3.0 by PilzAdam.

crafts.lua

@@ -44,6 +44,14 @@ minetest.register_craft({
 	}
 })
 
+minetest.register_craft({
+	output = "nether:brick_deep 4",
+	recipe = {
+		{"nether:rack_deep", "nether:rack_deep"},
+		{"nether:rack_deep", "nether:rack_deep"}
+	}
+})
+
 minetest.register_craft({
     output = "nether:basalt_hewn",
     type = "shapeless",
@@ -61,4 +69,4 @@ minetest.register_craft({
   }
 })
 
--- See tools.lua for tools related crafting
+-- See tools.lua for tools related crafting

init.lua

@@ -76,6 +76,19 @@ if nether.DEPTH_FLOOR + 1000 > nether.DEPTH_CEILING then
 end
 nether.DEPTH = nether.DEPTH_CEILING -- Deprecated, use nether.DEPTH_CEILING instead.
 
+-- DEPTH_FLOOR_LAYERS gives the bottom Y of all locations that wish to be
+-- considered part of the Nether.
+-- DEPTH_FLOOR_LAYERS Allows mods to insert extra layers below the
+-- Nether, by knowing where their layer ceiling should start, and letting
+-- the layers be included in effects which only happen in the Nether.
+-- If a mod wishes to add a layer below the Nether it should read
+-- nether.DEPTH_FLOOR_LAYERS to find the bottom Y of the Nether and any
+-- other layers already under the Nether. The mod should leave a small gap
+-- between DEPTH_FLOOR_LAYERS and its ceiling (e.g. use DEPTH_FLOOR_LAYERS - 6
+-- for its ceiling Y, so there is room to shift edge-case biomes), then set
+-- nether.DEPTH_FLOOR_LAYERS to reflect the mod's floor Y value, and call
+-- shift_existing_biomes() with DEPTH_FLOOR_LAYERS as the floor_y argument.
+nether.DEPTH_FLOOR_LAYERS = nether.DEPTH_FLOOR
 
 -- A debug-print function that understands vectors etc. and does not
 -- evaluate when debugging is turned off.
@@ -155,7 +168,7 @@ This opens to a truly hellish place, though for small mercies the air there is s
 The expedition parties have found no diamonds or gold, and after an experienced search party failed to return from the trail of a missing expedition party, I must conclude this is a dangerous place.]], 10 * nether.FASTTRAVEL_FACTOR),
 
 		is_within_realm = function(pos) -- return true if pos is inside the Nether
-			return pos.y < nether.DEPTH_CEILING
+			return pos.y < nether.DEPTH_CEILING and pos.y > nether.DEPTH_FLOOR
 		end,
 
 		find_realm_anchorPos = function(surface_anchorPos, player_name)
@@ -163,7 +176,7 @@ The expedition parties have found no diamonds or gold, and after an experienced
 			local destination_pos = vector.divide(surface_anchorPos, nether.FASTTRAVEL_FACTOR)
 			destination_pos.x = math.floor(0.5 + destination_pos.x) -- round to int
 			destination_pos.z = math.floor(0.5 + destination_pos.z) -- round to int
-			destination_pos.y = nether.DEPTH_CEILING - 1000 -- temp value so find_nearest_working_portal() returns nether portals
+			destination_pos.y = nether.DEPTH_CEILING - 1 -- temp value so find_nearest_working_portal() returns nether portals
 
 			-- a y_factor of 0 makes the search ignore the altitude of the portals (as long as they are in the Nether)
 			local existing_portal_location, existing_portal_orientation =
@@ -188,7 +201,7 @@ The expedition parties have found no diamonds or gold, and after an experienced
 			local destination_pos = vector.multiply(realm_anchorPos, nether.FASTTRAVEL_FACTOR)
 			destination_pos.x = math.min(30900, math.max(-30900, destination_pos.x)) -- clip to world boundary
 			destination_pos.z = math.min(30900, math.max(-30900, destination_pos.z)) -- clip to world boundary
-			destination_pos.y = 0 -- temp value so find_nearest_working_portal() doesn't return nether portals
+			destination_pos.y = nether.DEPTH_CEILING + 1 -- temp value so find_nearest_working_portal() doesn't return nether portals
 
 			-- a y_factor of 0 makes the search ignore the altitude of the portals (as long as they are outside the Nether)
 			local existing_portal_location, existing_portal_orientation =
@@ -253,12 +266,12 @@ The expedition parties have found no diamonds or gold, and after an experienced
 				if pos.y <= nether.DEPTH_CEILING and pos.y >= nether.DEPTH_FLOOR then
 					result = "nether"
 
-					-- since mapgen_nobiomes.lua has no regions it doesn't implement getRegion(),
-					-- so only use getRegion() if it exists
-					if nether.mapgen.getRegion ~= nil then
+					-- since mapgen_nobiomes.lua has no regions it doesn't implement get_region(),
+					-- so only use get_region() if it exists
+					if nether.mapgen.get_region ~= nil then
 						-- the biomes-based mapgen supports 2 extra regions
 						local regions = nether.mapgen.RegionEnum
-						local region  = nether.mapgen.getRegion(pos)
+						local region  = nether.mapgen.get_region(pos)
 						if region == regions.CENTER or region == regions.CENTERSHELL then
 							result = "mantle"
 						elseif region == regions.NEGATIVE or region == regions.NEGATIVESHELL then

mapgen.lua

@@ -81,7 +81,8 @@ local math_max, math_min, math_abs, math_floor = math.max, math.min, math.abs, m
 
 -- Inject nether_caverns biome
 
-local function override_underground_biomes()
+-- Move any existing biomes out of the y-range specified by 'floor_y' and 'ceiling_y'
+mapgen.shift_existing_biomes = function(floor_y, ceiling_y)
 	-- https://forum.minetest.net/viewtopic.php?p=257522#p257522
 	-- Q: Is there a way to override an already-registered biome so I can get it out of the
 	--    way of my own underground biomes without disturbing the other biomes registered by
@@ -124,21 +125,21 @@ local function override_underground_biomes()
 		if type(new_biome_def.y_min) == 'number' then biome_y_min = new_biome_def.y_min end
 		if type(new_biome_def.y_max) == 'number' then biome_y_max = new_biome_def.y_max end
 
-		if biome_y_max > NETHER_FLOOR and biome_y_min < NETHER_CEILING then
+		if biome_y_max > floor_y and biome_y_min < ceiling_y then
 			-- This biome occupies some or all of the depth of the Nether, shift/crop it.
 			local new_y_min, new_y_max
-			local spaceOccupiedAbove = biome_y_max - NETHER_CEILING
-			local spaceOccupiedBelow = NETHER_FLOOR - biome_y_min
+			local spaceOccupiedAbove = biome_y_max - ceiling_y
+			local spaceOccupiedBelow = floor_y - biome_y_min
 			if spaceOccupiedAbove >= spaceOccupiedBelow or biome_y_min <= -30000 then
 				-- place the biome above the Nether
 				-- We also shift biomes which extend to the bottom of the map above the Nether, since they
 				-- likely only extend that deep as a catch-all, and probably have a role nearer the surface.
-				new_y_min = NETHER_CEILING + 1
-				new_y_max = math_max(biome_y_max, NETHER_CEILING + 2)
+				new_y_min = ceiling_y + 1
+				new_y_max = math_max(biome_y_max, ceiling_y + 2)
 			else
 				-- shift the biome to below the Nether
-				new_y_max = NETHER_FLOOR - 1
-				new_y_min = math_min(biome_y_min, NETHER_CEILING - 2)
+				new_y_max = floor_y - 1
+				new_y_min = math_min(biome_y_min, floor_y - 2)
 			end
 
 			debugf("Moving biome \"%s\" from %s..%s to %s..%s", new_biome_def.name, new_biome_def.y_min, new_biome_def.y_max, new_y_min, new_y_max)
@@ -162,7 +163,7 @@ local function override_underground_biomes()
  end
 
 -- Shift any overlapping biomes out of the way before we create the Nether biomes
-override_underground_biomes()
+mapgen.shift_existing_biomes(NETHER_FLOOR, NETHER_CEILING)
 
 -- nether:native_mapgen is used to prevent ores and decorations being generated according
 -- to landforms created by the native mapgen.
@@ -259,14 +260,14 @@ mapgen.np_cave = {
 
 local cavePointPerlin = nil
 
-mapgen.getCavePointPerlin = function()
+mapgen.get_cave_point_perlin = function()
 	cavePointPerlin = cavePointPerlin or minetest.get_perlin(mapgen.np_cave)
 	return cavePointPerlin
 end
 
-mapgen.getCavePerlinAt = function(pos)
+mapgen.get_cave_perlin_at = function(pos)
 	cavePointPerlin = cavePointPerlin or minetest.get_perlin(mapgen.np_cave)
-	return cavePointPerlin:get3d(pos)
+	return cavePointPerlin:get_3d(pos)
 end
 
 
@@ -477,7 +478,7 @@ end
 -- use knowledge of the nether mapgen algorithm to return a suitable ground level for placing a portal.
 -- player_name is optional, allowing a player to spawn a remote portal in their own protected areas.
 function nether.find_nether_ground_y(target_x, target_z, start_y, player_name)
-	local nobj_cave_point = mapgen.getCavePointPerlin()
+	local nobj_cave_point = mapgen.get_cave_point_perlin()
 	local air = 0 -- Consecutive air nodes found
 
 	local minp_schem, maxp_schem = nether.get_schematic_volume({x = target_x, y = 0, z = target_z}, nil, "nether_portal")
@@ -485,7 +486,7 @@ function nether.find_nether_ground_y(target_x, target_z, start_y, player_name)
 	local maxp = {x = maxp_schem.x, y = 0, z = maxp_schem.z}
 
 	for y = start_y, math_max(NETHER_FLOOR + BLEND, start_y - 4096), -1 do
-		local nval_cave = nobj_cave_point:get3d({x = target_x, y = y, z = target_z})
+		local nval_cave = nobj_cave_point:get_3d({x = target_x, y = y, z = target_z})
 
 		if nval_cave > TCAVE then -- Cavern
 			air = air + 1
@@ -509,4 +510,4 @@ function nether.find_nether_ground_y(target_x, target_z, start_y, player_name)
 	return math_max(start_y, NETHER_FLOOR + BLEND) -- Fallback
 end
 
-minetest.register_on_generated(on_generated)
+minetest.register_on_generated(on_generated)

mapgen_mantle.lua

@@ -119,7 +119,7 @@ mapgen.add_basalt_columns = function(data, area, minp, maxp)
 	local yStride = area.ystride
 	local yCaveStride = x1 - x0 + 1
 
-	local cavePerlin = mapgen.getCavePointPerlin()
+	local cavePerlin = mapgen.get_cave_point_perlin()
 	nobj_basalt = nobj_basalt or minetest.get_perlin_map(np_basalt, {x = yCaveStride, y = yCaveStride})
 	local nvals_basalt = nobj_basalt:get_2d_map_flat({x=minp.x, y=minp.z}, {x=yCaveStride, y=yCaveStride}, nbuf_basalt)
 
@@ -136,7 +136,7 @@ mapgen.add_basalt_columns = function(data, area, minp, maxp)
 			if basaltNoise > 0 then
 				-- a basalt column is here
 
-				local abs_sealevel_cave_noise = math_abs(cavePerlin:get3d({x = x, y = nearest_sea_level, z = z}))
+				local abs_sealevel_cave_noise = math_abs(cavePerlin:get_3d({x = x, y = nearest_sea_level, z = z}))
 
 				-- Add Some quick deterministic noise to the column heights
 				-- This is probably not good noise, but it doesn't have to be.
@@ -431,13 +431,13 @@ mapgen.RegionEnum = {
 
 -- Returns (region, noise) where region is a value from mapgen.RegionEnum
 -- and noise is the unadjusted cave perlin value
-mapgen.getRegion = function(pos)
+mapgen.get_region = function(pos)
 
 	if pos.y > nether.DEPTH_CEILING or pos.y < nether.DEPTH_FLOOR then
 		return mapgen.RegionEnum.OVERWORLD, nil
 	end
 
-	local caveNoise = mapgen.getCavePerlinAt(pos)
+	local caveNoise = mapgen.get_cave_perlin_at(pos)
 	local sealevel, cavern_limit_distance = mapgen.find_nearest_lava_sealevel(pos.y)
 	local tcave_adj, centerRegionLimit_adj = mapgen.get_mapgenblend_adjustments(pos.y)
 	local tcave   = mapgen.TCAVE + tcave_adj
@@ -482,7 +482,7 @@ minetest.register_chatcommand("nether_whereami",
 			if player == nil then return false, S("Unknown player position") end
 			local playerPos = vector.round(player:get_pos())
 
-			local region, caveNoise                = mapgen.getRegion(playerPos)
+			local region, caveNoise                = mapgen.get_region(playerPos)
 			local seaLevel, cavernLimitDistance    = mapgen.find_nearest_lava_sealevel(playerPos.y)
 			local tcave_adj, centerRegionLimit_adj = mapgen.get_mapgenblend_adjustments(playerPos.y)
 

mapgen_nobiomes.lua

@@ -216,7 +216,7 @@ function nether.find_nether_ground_y(target_x, target_z, start_y, player_name)
 	local maxp = {x = maxp_schem.x, y = 0, z = maxp_schem.z}
 
 	for y = start_y, math.max(NETHER_FLOOR + BLEND, start_y - 4096), -1 do
-		local nval_cave = nobj_cave_point:get3d({x = target_x, y = y, z = target_z})
+		local nval_cave = nobj_cave_point:get_3d({x = target_x, y = y, z = target_z})
 
 		if nval_cave > TCAVE then -- Cavern
 			air = air + 1

mod.conf

@@ -1,4 +1,4 @@
 name = nether
 description = Adds a deep underground realm with different mapgen that you can reach with obsidian portals.
 depends = stairs, default
-optional_depends = moreblocks, mesecons, loot, dungeon_loot, doc_basics, fire, climate_api
+optional_depends = moreblocks, mesecons, loot, dungeon_loot, doc_basics, fire, climate_api, ethereal, walls

nether_api.txt

@@ -0,0 +1,78 @@
+Modding/interop guide to Nether
+===============================
+
+For portals API see portal_api.txt
+
+The Nether mod exposes some of its functions and data via the lua global
+`nether` and `nether.mapgen`
+
+
+* `nether.DEPTH_CEILING`: [read-only] Y value of the top of the Nether.
+
+* `nether.DEPTH_FLOOR`: [read-only] Y value of the bottom of the Nether.
+
+* `nether.DEPTH_FLOOR_LAYERS`: [writable] Gives the bottom Y of all
+  locations that wish to be considered part of the Nether.
+  DEPTH_FLOOR_LAYERS Allows mods to insert extra layers below the
+  Nether, by knowing where their layer ceiling should start, and letting
+  the layers be included in effects which only happen in the Nether.
+  If a mod wishes to add a layer below the Nether it should read
+  `nether.DEPTH_FLOOR_LAYERS` to find the bottom Y of the Nether and any
+  other layers already under the Nether. The mod should leave a small gap
+  between DEPTH_FLOOR_LAYERS and its ceiling (e.g. use DEPTH_FLOOR_LAYERS - 6
+  for its ceiling Y, so there is room to shift edge-case biomes), then set
+  `nether.DEPTH_FLOOR_LAYERS` to reflect the mod's floor Y value, and call
+  `shift_existing_biomes()` with DEPTH_FLOOR_LAYERS as the `floor_y` argument.
+
+* `nether.NETHER_REALM_ENABLED`: [read-only] Gets the value of the "Enable
+  Nether realm & portal" setting the nether mod exposes in Minetest's
+  "All Settings" -> "Mods" -> "nether" options.
+  When false, the entire nether mapgen is disabled (not run), and the portal
+  to it is not registered. Reasons someone might disable the Nether realm
+  include if a nether-layer mod was to be used as the Nether instead, or if
+  the portal mechanic was desired in a game without the Nether, etc.
+
+* `nether.useBiomes`: [read-only] When this is false, the Nether interop
+  functions below are not available (nil).
+  Indicates that the biomes-enabled mapgen is in use. The Nether mod falls back
+  to older mapgen code for v6 maps and old versions of Minetest, the older
+  mapgen code doesn't use biomes and doesn't provide API/interop functions.
+
+
+Mapgen functions available when nether.useBiomes is true
+--------------------------------------------------------
+
+The following functions are nil if `nether.useBiomes` is false,
+and also nil if `nether.NETHER_REALM_ENABLED` is false.
+
+* `nether.mapgen.shift_existing_biomes(floor_y, ceiling_y)` Move any existing
+  biomes out of the y-range specified by `floor_y` and `ceiling_y`.
+
+* `nether.mapgen.get_region(pos)`: Returns two values, (region, noise) where
+  `region` is a value from `nether.mapgen.RegionEnum` and `noise` is the
+  unadjusted cave perlin value.
+    * `nether.mapgen.RegionEnum` values are tables which contain an invariant
+      `name` and a localized `desc`. Current region names include overworld,
+      positive, positive shell, center, center shell, negative, and negative
+      shell.
+      "positive" corresponds to conventional Nether caverns, and "center"
+      corresponds to the Mantle region.
+
+* `nether.mapgen.get_cave_point_perlin()`: Returns the PerlinNoise object for
+  the Nether's cavern noise.
+
+* `nether.mapgen.get_cave_perlin_at(pos)`: Returns the Nether cavern noise
+  value at a given 3D position.
+
+
+Other mapgen functions
+-------------------------------------------
+
+If the Nether realm is enabled, then this function will be available
+regardless of whether `nether.useBiomes` is true:
+
+* `nether.find_nether_ground_y(target_x, target_z, start_y, player_name)`
+  Uses knowledge of the nether mapgen algorithm to return a suitable ground
+  level for placing a portal.
+    * `player_name` is optional, allowing a player to spawn a remote portal
+      in their own protected areas.

nodes.lua

@@ -65,13 +65,118 @@ nether.register_wormhole_node("nether:portal_alt", {
 })
 
 
+--== Transmogrification functions ==--
+-- Functions enabling selected nodes to be temporarily transformed into other nodes.
+-- (so the light staff can temporarily turn netherrack into glowstone)
+
+-- Swaps the node at `nodePos` with `newNode`, unless `newNode` is nil in which
+-- case the node is swapped back to its original type.
+-- `monoSimpleSoundSpec` is optional.
+-- returns true if a node was transmogrified
+nether.magicallyTransmogrify_node = function(nodePos, playerName, newNode, monoSimpleSoundSpec, isPermanent)
+
+	local meta         = minetest.get_meta(nodePos)
+	local playerEyePos = nodePos -- fallback value in case the player no longer exists
+	local player       = minetest.get_player_by_name(playerName)
+	if player ~= nil then
+		local playerPos = player:get_pos()
+		playerEyePos = vector.add(playerPos, {x = 0, y = 1.5, z = 0}) -- not always the cameraPos, e.g. 3rd person mode.
+	end
+
+	local oldNode = minetest.get_node(nodePos)
+	if oldNode.name == "air" then
+		-- the node has been mined or otherwise destroyed, abort the operation
+		return false
+	end
+	local oldNodeDef = minetest.registered_nodes[oldNode.name] or minetest.registered_nodes["air"]
+
+	local specialFXSize = 1 -- a specialFXSize of 1 is for full SFX, 0.5 is half-sized
+	local returningToNormal = newNode == nil
+	if returningToNormal then
+		-- This is the transmogrified node returning back to normal - a more subdued animation
+		specialFXSize = 0.5
+		-- read what the node used to be from the metadata
+		newNode = {
+			name   = meta:get_string("transmogrified_name"),
+			param1 = meta:get_string("transmogrified_param1"),
+			param2 = meta:get_string("transmogrified_param2")
+		}
+		if newNode.name == "" then
+			minetest.log("warning", "nether.magicallyTransmogrify_node() invoked to restore node which wasn't transmogrified")
+			return false
+		end
+	end
+
+	local soundSpec  = monoSimpleSoundSpec
+	if soundSpec == nil and oldNodeDef.sounds ~= nil then
+		soundSpec = oldNodeDef.sounds.dug or oldNodeDef.sounds.dig
+		if soundSpec == "__group" then soundSpec = "default_dig_cracky" end
+	end
+	if soundSpec ~= nil then
+		minetest.sound_play(soundSpec, {pos = nodePos, max_hear_distance = 50})
+	end
+
+	-- Start the particlespawner nearer the player's side of the node to create
+	-- more initial occlusion for an illusion of the old node breaking apart / falling away.
+	local dirToPlayer = vector.normalize(vector.subtract(playerEyePos, nodePos))
+	local impactPos = vector.add(nodePos, vector.multiply(dirToPlayer, 0.5))
+	local velocity = 1 + specialFXSize
+	minetest.add_particlespawner({
+		amount     = 50 * specialFXSize,
+		time       = 0.1,
+		minpos     = vector.add(impactPos, -0.3),
+		maxpos     = vector.add(impactPos,  0.3),
+		minvel     = {x = -velocity, y = -velocity,    z = -velocity},
+		maxvel     = {x =  velocity, y = 3 * velocity, z =  velocity}, -- biased upward to counter gravity in the initial stages
+		minacc     = {x=0, y=-10, z=0},
+		maxacc     = {x=0, y=-10, z=0},
+		minexptime = 1.5 * specialFXSize,
+		maxexptime = 3   * specialFXSize,
+		minsize    = 0.5,
+		maxsize    = 5,
+		node = {name = oldNodeDef.name},
+		glow = oldNodeDef.light_source
+	})
+
+	if returningToNormal or isPermanent then
+		-- clear the metadata that indicates the node is transformed
+		meta:set_string("transmogrified_name", "")
+		meta:set_int("transmogrified_param1", 0)
+		meta:set_int("transmogrified_param2", 0)
+	else
+		-- save the original node so it can be restored
+		meta:set_string("transmogrified_name", oldNode.name)
+		meta:set_int("transmogrified_param1", oldNode.param1)
+		meta:set_int("transmogrified_param2", oldNode.param2)
+	end
+
+	minetest.swap_node(nodePos, newNode)
+	return true
+end
+
+
+local function transmogrified_can_dig (pos, player)
+	if minetest.get_meta(pos):get_string("transmogrified_name") ~= "" then
+		-- This node was temporarily transformed into its current form
+		-- revert it back, rather than allow the player to mine transmogrified nodes.
+		local playerName = ""
+		if player ~= nil then playerName = player:get_player_name() end
+		nether.magicallyTransmogrify_node(pos, playerName)
+		return false
+	end
+	return true
+end
+
+
+
 -- Nether nodes
 
 minetest.register_node("nether:rack", {
 	description = S("Netherrack"),
 	tiles = {"nether_rack.png"},
 	is_ground_content = true,
-	groups = {cracky = 3, level = 2},
+	-- setting workable_with_nether_tools reduces the wear on nether:pick_nether when mining this node
+	groups = {cracky = 3, level = 2, workable_with_nether_tools = 3},
 	sounds = default.node_sound_stone_defaults(),
 })
 
@@ -81,7 +186,8 @@ minetest.register_node("nether:rack_deep", {
 	_doc_items_longdesc = S("Netherrack from deep in the mantle"),
 	tiles = {"nether_rack_deep.png"},
 	is_ground_content = true,
-	groups = {cracky = 3, level = 2},
+	-- setting workable_with_nether_tools reduces the wear on nether:pick_nether when mining this node
+	groups = {cracky = 3, level = 2, workable_with_nether_tools = 3},
 	sounds = default.node_sound_stone_defaults(),
 })
 
@@ -103,6 +209,7 @@ minetest.register_node("nether:glowstone", {
 	paramtype = "light",
 	groups = {cracky = 3, oddly_breakable_by_hand = 3},
 	sounds = default.node_sound_glass_defaults(),
+	can_dig = transmogrified_can_dig, -- to ensure glowstone temporarily created by the lightstaff can't be kept
 })
 
 -- Deep glowstone, found in the mantle / central magma layers
@@ -114,6 +221,7 @@ minetest.register_node("nether:glowstone_deep", {
 	paramtype = "light",
 	groups = {cracky = 3, oddly_breakable_by_hand = 3},
 	sounds = default.node_sound_glass_defaults(),
+	can_dig = transmogrified_can_dig, -- to ensure glowstone temporarily created by the lightstaff can't be kept
 })
 
 minetest.register_node("nether:brick", {
@@ -161,40 +269,103 @@ minetest.register_node("nether:fence_nether_brick", {
 	sounds = default.node_sound_stone_defaults(),
 })
 
+minetest.register_node("nether:brick_deep", {
+	description = S("Deep Nether Brick"),
+	tiles = {{
+		name        = "nether_brick_deep.png",
+		align_style = "world",
+		scale       = 2
+	}},
+	is_ground_content = false,
+	groups = {cracky = 2, level = 2},
+	sounds = default.node_sound_stone_defaults()
+})
 
 -- Register stair and slab
 
-stairs.register_stair_and_slab(
-	"nether_brick",
-	"nether:brick",
-	{cracky = 2, level = 2},
-	{"nether_brick.png"},
-	S("Nether Stair"),
-	S("Nether Slab"),
-	default.node_sound_stone_defaults(),
-	nil,
-	S("Inner Nether Stair"),
-	S("Outer Nether Stair")
+-- Nether bricks can be made into stairs, slabs, inner stairs, and outer stairs
+
+stairs.register_stair_and_slab( -- this function also registers inner and outer stairs
+	"nether_brick",                                    -- subname
+	"nether:brick",                                    -- recipeitem
+	{cracky = 2, level = 2},                           -- groups
+	{"nether_brick.png"},                              -- images
+	S("Nether Stair"),                                 -- desc_stair
+	S("Nether Slab"),                                  -- desc_slab
+	minetest.registered_nodes["nether:brick"].sounds,  -- sounds
+	false,                                             -- worldaligntex
+	S("Inner Nether Stair"),                           -- desc_stair_inner
+	S("Outer Nether Stair")                            -- desc_stair_outer
 )
 
+stairs.register_stair_and_slab( -- this function also registers inner and outer stairs
+	"nether_brick_deep",                                    -- subname
+	"nether:brick_deep",                                    -- recipeitem
+	{cracky = 2, level = 2},                                -- groups
+	{"nether_brick_deep.png"},                              -- images
+	S("Deep Nether Stair"),                                 -- desc_stair
+	S("Deep Nether Slab"),                                  -- desc_slab
+	minetest.registered_nodes["nether:brick_deep"].sounds,  -- sounds
+	false,                                                  -- worldaligntex
+	S("Inner Deep Nether Stair"),                           -- desc_stair_inner
+	S("Outer Deep Nether Stair")                            -- desc_stair_outer
+)
+
+-- Netherrack can be shaped into stairs, slabs and walls
+
 stairs.register_stair(
 	"netherrack",
 	"nether:rack",
 	{cracky = 2, level = 2},
 	{"nether_rack.png"},
 	S("Netherrack stair"),
-	default.node_sound_stone_defaults()
+	minetest.registered_nodes["nether:rack"].sounds
 )
+stairs.register_slab( -- register a slab without adding inner and outer stairs
+	"netherrack",
+	"nether:rack",
+	{cracky = 2, level = 2},
+	{"nether_rack.png"},
+	S("Deep Netherrack slab"),
+	minetest.registered_nodes["nether:rack"].sounds
+)
+
+stairs.register_stair(
+	"netherrack_deep",
+	"nether:rack_deep",
+	{cracky = 2, level = 2},
+	{"nether_rack_deep.png"},
+	S("Deep Netherrack stair"),
+	minetest.registered_nodes["nether:rack_deep"].sounds
+)
+stairs.register_slab( -- register a slab without adding inner and outer stairs
+	"netherrack_deep",
+	"nether:rack_deep",
+	{cracky = 2, level = 2},
+	{"nether_rack_deep.png"},
+	S("Deep Netherrack slab"),
+	minetest.registered_nodes["nether:rack_deep"].sounds
+)
+
+-- Connecting walls
+if minetest.get_modpath("walls") and minetest.global_exists("walls") and walls.register ~= nil then
+	walls.register("nether:rack_wall",      "A Netherrack wall",      "nether_rack.png",      "nether:rack",      minetest.registered_nodes["nether:rack"].sounds)
+	walls.register("nether:rack_deep_wall", "A Deep Netherrack wall", "nether_rack_deep.png", "nether:rack_deep", minetest.registered_nodes["nether:rack_deep"].sounds)
+end
 
 -- StairsPlus
 
 if minetest.get_modpath("moreblocks") then
+	-- Registers about 49 different shapes of nether brick, replacing the stairs & slabs registered above.
+	-- (This could also be done for deep nether brick, but I've left that out to avoid a precedent of 49 new
+	-- nodes every time the nether gets a new material. Nether structures won't be able to use them because
+	-- they can't depend on moreblocks)
 	stairsplus:register_all(
 		"nether", "brick", "nether:brick", {
 			description = S("Nether Brick"),
 			groups = {cracky = 2, level = 2},
 			tiles = {"nether_brick.png"},
-			sounds = default.node_sound_stone_defaults(),
+			sounds = minetest.registered_nodes["nether:brick"].sounds,
 	})
 end
 
@@ -330,7 +501,7 @@ nether.cool_lava = function(pos, node)
 	-- Evaporate water sitting above lava, if it's in the Nether.
 	-- (we don't want Nether mod to affect overworld lava mechanics)
 	if minetest.get_item_group(node_above.name, "water") > 0 and
-		pos.y < nether.DEPTH_CEILING and pos.y > nether.DEPTH_FLOOR then
+		pos.y < nether.DEPTH_CEILING and pos.y > nether.DEPTH_FLOOR_LAYERS then
 		-- cools_lava might be a better group to check for, but perhaps there's
 		-- something in that group that isn't a liquid and shouldn't be evaporated?
 		minetest.swap_node(pos_above, {name="air"})
@@ -529,7 +700,7 @@ minetest.register_node("nether:lava_crust", {
 	paramtype = "light",
 	light_source = default.LIGHT_MAX - 3,
 	buildable_to = false,
-	walkable_to = true,
+	walkable = true,
 	is_ground_content = true,
 	drop = {
 		items = {{
@@ -597,7 +768,7 @@ local function fumarole_onTimer(pos, elapsed)
 
 	-- Fumaroles in the Nether can catch fire.
 	-- (if taken to the surface and used as cottage chimneys, they don't catch fire)
-	local inNether = pos.y <= nether.DEPTH and pos.y >= nether.DEPTH_FLOOR
+	local inNether = pos.y <= nether.DEPTH and pos.y >= nether.DEPTH_FLOOR_LAYERS
 	local canCatchFire = inNether and minetest.registered_nodes["fire:permanent_flame"] ~= nil
 	local smoke_offset   = 0
 	local timeout_factor = 1

portal_api.lua

@@ -2007,7 +2007,8 @@ local wormhole_nodedef_default = {
 		a = 160, r = 128, g = 0, b = 80
 	},
 	sunlight_propagates = true,
-	use_texture_alpha = true,
+	use_texture_alpha = minetest.features.use_texture_alpha_string_modes
+		and "blend" or true,
 	walkable = false,
 	diggable = false,
 	pointable = false,
@@ -2015,7 +2016,6 @@ local wormhole_nodedef_default = {
 	is_ground_content = false,
 	drop = "",
 	light_source = 5,
-	alpha = 192,
 	node_box = {
 		type = "fixed",
 		fixed = {
@@ -2073,7 +2073,7 @@ function nether.register_portal(name, portaldef)
 	end
 
 	portaldef.name     = name
-	portaldef.mod_name = minetest.get_current_modname()
+	portaldef.mod_name = minetest.get_current_modname() or "<mod name not recorded>"
 
 	-- use portaldef_default for any values missing from portaldef or portaldef.sounds
 	if portaldef.sounds ~= nil then setmetatable(portaldef.sounds, {__index = portaldef_default.sounds}) end
@@ -2211,7 +2211,7 @@ function nether.volume_is_natural_and_unprotected(minp, maxp, player_name)
 			if id ~= c_air and id ~= c_ignore and id ~= nil then -- checked for common natural or not emerged
 				local name = minetest.get_name_from_content_id(id)
 				local nodedef = minetest.registered_nodes[name]
-				if not nodedef.is_ground_content then
+				if nodedef and not nodedef.is_ground_content then
 					-- trees are natural but not "ground content"
 					local node_groups = nodedef.groups
 					if node_groups == nil or (node_groups.tree == nil and node_groups.leaves == nil and node_groups.leafdecay == nil) then

portal_api.txt

@@ -250,16 +250,16 @@ Used by `nether.register_portal`.
         -- player_name may be "", e.g. if the portal was ignited by a mesecon,
         -- and is provided for use with volume_is_natural_and_unprotected() etc.
 
-        on_run_wormhole      = function(portalDef, anochorPos, orientation),
+        on_run_wormhole      = function(portalDef, anchorPos, orientation),
         -- invoked once per second per portal
-        on_extinguish        = function(portalDef, anochorPos, orientation),
+        on_extinguish        = function(portalDef, anchorPos, orientation),
         -- invoked when a portal is extinguished, including when the portal
         -- it connected to was extinguished.
         on_player_teleported = function(portalDef, player, oldPos, newPos),
         -- invoked immediately after a player is teleported
-        on_ignite            = function(portalDef, anochorPos, orientation)
+        on_ignite            = function(portalDef, anchorPos, orientation)
         -- invoked when a player or mesecon ignites a portal
-        on_created           = function(portalDef, anochorPos, orientation)
+        on_created           = function(portalDef, anchorPos, orientation)
         -- invoked when a portal creates a remote twin, this is usually when
         -- a player travels through a portal for the first time.
     }

portal_examples.lua

@@ -106,7 +106,7 @@ end
 -- Surface-travel portal, playable code example --
 --==============================================--
 
--- These Moore Curve functions requred by surface_portal's find_surface_anchorPos() will
+-- These Moore Curve functions required by surface_portal's find_surface_anchorPos() will
 -- be assigned later in this file.
 local get_moore_distance -- will be function get_moore_distance(cell_count, x, y): integer
 local get_moore_coords   -- will be function get_moore_coords(cell_count, distance): pos2d

tools.lua

@@ -20,18 +20,33 @@
 local S = nether.get_translator
 
 minetest.register_tool("nether:pick_nether", {
-	description = S("Nether Pickaxe"),
+	description = S("Nether Pickaxe\nWell suited for mining netherrack"),
+	_doc_items_longdesc = S("Uniquely suited for mining netherrack, with minimal wear when doing so. Blunts quickly on other materials."),
 	inventory_image = "nether_tool_netherpick.png",
 	tool_capabilities = {
 		full_punch_interval = 0.8,
 		max_drop_level=3,
 		groupcaps={
-			cracky = {times={[1]=1.90, [2]=0.9, [3]=0.4}, uses=35, maxlevel=3},
+			cracky = {times={[1]=1.90, [2]=0.9, [3]=0.3}, uses=35, maxlevel=2},
 		},
 		damage_groups = {fleshy=4},
 	},
 	sound = {breaks = "default_tool_breaks"},
-	groups = {pickaxe = 1}
+	groups = {pickaxe = 1},
+
+	after_use = function(itemstack, user, node, digparams)
+		local wearDivisor = 1
+		local nodeDef = minetest.registered_nodes[node.name]
+		if nodeDef ~= nil and nodeDef.groups ~= nil then
+			-- The nether pick hardly wears out when mining netherrack
+			local workable = nodeDef.groups.workable_with_nether_tools or 0
+			wearDivisor =  1 + (3 * workable) -- 10 for netherrack, 1 otherwise. Making it able to mine 350 netherrack nodes, instead of 35.
+		end
+
+		local wear = math.floor(digparams.wear / wearDivisor)
+		itemstack:add_wear(wear)  -- apply the adjusted wear as usual
+		return itemstack
+	end
 })
 
 minetest.register_tool("nether:shovel_nether", {
@@ -136,3 +151,212 @@ minetest.register_craft({
 		{"group:stick"}
 	}
 })
+
+
+
+
+--===========================--
+--== Nether Staff of Light ==--
+--===========================--
+
+nether.lightstaff_recipes = {
+	["nether:rack"]                 = "nether:glowstone",
+	["nether:brick"]                = "nether:glowstone",
+	["nether:brick_cracked"]        = "nether:glowstone",
+	["nether:brick_compressed"]     = "nether:glowstone",
+	["stairs:slab_netherrack"]      = "nether:glowstone",
+	["nether:rack_deep"]            = "nether:glowstone_deep",
+	["nether:brick_deep"]           = "nether:glowstone_deep",
+	["stairs:slab_netherrack_deep"] = "nether:glowstone_deep"
+}
+nether.lightstaff_range    = 100
+nether.lightstaff_velocity = 60
+nether.lightstaff_gravity  = 0  -- using 0 instead of 10 because projectile arcs look less magical - magic isn't affected by gravity ;) (but set this to 10 if you're making a crossbow etc.)
+nether.lightstaff_uses     = 60 -- number of times the Eternal Lightstaff can be used before wearing out
+nether.lightstaff_duration = 40 -- lifespan of glowstone created by the termporay Lightstaff
+
+-- 'serverLag' is a rough amount to reduce the projected impact-time the server must wait before initiating the
+-- impact events (i.e. node changing to glowstone with explosion particle effect).
+-- In tests using https://github.com/jagt/clumsy to simulate network lag I've found this value to not noticeably
+-- matter. A large network lag is noticeable in the time between clicking fire and when the shooting-particleEffect
+-- begins, as well as the time between when the impact sound/particleEffect start and when the netherrack turns
+-- into glowstone. The synchronization that 'serverLag' adjusts seems to already tolerate network lag well enough (at
+-- least when lag is consistent, as I have not simulated random lag)
+local serverLag = 0.05 -- in seconds. Larger values makes impact events more premature/early.
+
+-- returns a pointed_thing, or nil if no solid node intersected the ray
+local function raycastForSolidNode(rayStartPos, rayEndPos)
+
+	local raycast = minetest.raycast(
+		rayStartPos,
+		rayEndPos,
+		false, -- objects - if false, only nodes will be returned. Default is `true`
+		true   -- liquids - if false, liquid nodes won't be returned. Default is `false`
+	)
+	local next_pointed = raycast:next()
+	while next_pointed do
+		local under_node = minetest.get_node(next_pointed.under)
+		local under_def = minetest.registered_nodes[under_node.name]
+
+		if (under_def and not under_def.buildable_to) or not under_def then
+			return next_pointed
+		end
+
+		next_pointed  = raycast:next(next_pointed)
+	end
+	return nil
+end
+
+-- Turns a node into a light source
+-- `lightDuration` 0 is considered permanent, lightDuration is in seconds
+-- returns true if a node is transmogrified into a glowstone
+local function light_node(pos, playerName, lightDuration)
+
+	local result = false
+	if minetest.is_protected(pos, playerName) then
+		minetest.record_protection_violation(pos, playerName)
+		return false
+	end
+
+	local oldNode = minetest.get_node(pos)
+	local litNodeName = nether.lightstaff_recipes[oldNode.name]
+
+	if litNodeName ~= nil then
+		result = nether.magicallyTransmogrify_node(
+			pos,
+			playerName,
+			{name=litNodeName},
+			{name = "nether_rack_destroy", gain = 0.8},
+			lightDuration == 0 -- isPermanent
+		)
+
+		if lightDuration > 0 then
+			minetest.after(lightDuration,
+				function()
+					-- Restore the node to its original type.
+					--
+					-- If the server crashes or shuts down before this is invoked, the node
+					-- will remain in its transmogrified state. These could be cleaned up
+					-- with an LBM, but I don't think that's necessary: if this functionality
+					-- is only being used for the Nether Lightstaff then I don't think it
+					-- matters if there's occasionally an extra glowstone left in the
+					-- netherrack.
+					nether.magicallyTransmogrify_node(pos, playerName)
+				end
+			)
+		end
+	end
+	return result
+end
+
+-- a lightDuration of 0 is considered permanent, lightDuration is in seconds
+-- returns true if a node is transmogrified into a glowstone
+local function lightstaff_on_use(user, boltColorString, lightDuration)
+
+	if not user then return false end
+	local playerName    = user:get_player_name()
+	local playerlookDir = user:get_look_dir()
+	local playerPos     = user:get_pos()
+	local playerEyePos  = vector.add(playerPos, {x = 0, y = 1.5, z = 0}) -- not always the cameraPos, e.g. 3rd person mode.
+	local target        = vector.add(playerEyePos, vector.multiply(playerlookDir, nether.lightstaff_range))
+
+	local targetHitPos  = nil
+	local targetNodePos = nil
+	local target_pointed = raycastForSolidNode(playerEyePos, target)
+	if target_pointed then
+		targetNodePos = target_pointed.under
+		targetHitPos = vector.divide(vector.add(target_pointed.under, target_pointed.above), 2)
+	end
+
+	local wieldOffset = {x= 0.5, y = -0.2, z= 0.8}
+	local lookRotation =  ({x = -user:get_look_vertical(), y = user:get_look_horizontal(), z = 0})
+	local wieldPos = vector.add(playerEyePos, vector.rotate(wieldOffset, lookRotation))
+	local aimPos = targetHitPos or target
+	local distance = math.abs(vector.length(vector.subtract(aimPos, wieldPos)))
+	local flightTime = distance / nether.lightstaff_velocity
+	local dropDistance = nether.lightstaff_gravity * 0.5 * (flightTime * flightTime)
+	aimPos.y = aimPos.y + dropDistance
+	local boltDir = vector.normalize(vector.subtract(aimPos, wieldPos))
+
+	minetest.sound_play("nether_lightstaff", {to_player = playerName, gain = 0.8}, true)
+
+	-- animate a "magic bolt" from wieldPos to aimPos
+	local particleSpawnDef = {
+		amount = 20,
+		time = 0.4,
+		minpos = vector.add(wieldPos, -0.13),
+		maxpos = vector.add(wieldPos,  0.13),
+		minvel = vector.multiply(boltDir, nether.lightstaff_velocity - 0.3),
+		maxvel = vector.multiply(boltDir, nether.lightstaff_velocity + 0.3),
+		minacc = {x=0, y=-nether.lightstaff_gravity, z=0},
+		maxacc = {x=0, y=-nether.lightstaff_gravity, z=0},
+		minexptime = 1,
+		maxexptime = 2,
+		minsize = 4,
+		maxsize = 5,
+		collisiondetection = true,
+		collision_removal = true,
+		texture = "nether_particle_anim3.png",
+		animation = { type = "vertical_frames", aspect_w = 7, aspect_h = 7, length = 0.8 },
+		glow = 15
+	}
+	minetest.add_particlespawner(particleSpawnDef)
+	particleSpawnDef.texture = "nether_particle_anim3.png^[colorize:" .. boltColorString .. ":alpha"
+	particleSpawnDef.amount  = 12
+	particleSpawnDef.time    = 0.2
+	particleSpawnDef.minsize = 6
+	particleSpawnDef.maxsize = 7
+	particleSpawnDef.minpos  = vector.add(wieldPos, -0.35)
+	particleSpawnDef.maxpos  = vector.add(wieldPos,  0.35)
+	minetest.add_particlespawner(particleSpawnDef)
+
+	local result = false
+	if targetNodePos then
+		-- delay the impact until roughly when the particle effects will have reached the target
+		minetest.after(
+			math.max(0, (distance / nether.lightstaff_velocity) - serverLag),
+			function()
+				light_node(targetNodePos, playerName, lightDuration)
+			end
+		)
+
+		if lightDuration ~= 0 then
+			-- we don't need to care whether the transmogrify will be successful
+			result = true
+		else
+			-- check whether the transmogrify will be successful
+			local targetNode = minetest.get_node(targetNodePos)
+			result = nether.lightstaff_recipes[targetNode.name] ~= nil
+		end
+	end
+	return result
+end
+
+-- Inspired by FaceDeer's torch crossbow and Xanthin's Staff of Light
+minetest.register_tool("nether:lightstaff", {
+	description = S("Nether staff of Light\nTemporarily transforms the netherrack into glowstone"),
+	inventory_image = "nether_lightstaff.png",
+	wield_image     = "nether_lightstaff.png",
+	light_source = 11, -- used by wielded_light mod etc.
+	stack_max = 1,
+	on_use = function(itemstack, user, pointed_thing)
+		lightstaff_on_use(user, "#F70", nether.lightstaff_duration)
+	end
+})
+
+minetest.register_tool("nether:lightstaff_eternal", {
+	description = S("Nether staff of Eternal Light\nCreates glowstone from netherrack"),
+	inventory_image = "nether_lightstaff.png^[colorize:#55F:90",
+	wield_image     = "nether_lightstaff.png^[colorize:#55F:90",
+	light_source = 11, -- used by wielded_light mod etc.
+	sound = {breaks = "default_tool_breaks"},
+	stack_max = 1,
+	on_use = function(itemstack, user, pointed_thing)
+		if lightstaff_on_use(user, "#23F", 0) then -- was "#8088FF" or "#13F"
+			-- The staff of Eternal Light wears out, to limit how much
+			-- a player can alter the nether with it.
+			itemstack:add_wear(65535 / (nether.lightstaff_uses - 1))
+		end
+		return itemstack
+	end
+})