Skip to content

Commit 2cc3dfa

Browse files
committed
Format README and update links
1 parent 4b365bd commit 2cc3dfa

2 files changed

Lines changed: 57 additions & 25 deletions

File tree

README.md

Lines changed: 56 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,71 @@
11
# Modular Tunnel Boring Machine
22
## aka The Almighty Digtron
33

4+
![screenshot](screenshot.png)
45

5-
This mod contains a set of blocks that can be used to construct highly customizable and modular tunnel-boring machines, bridge-builders, road-pavers, wall-o-matics, and other such construction/destruction contraptions.
6+
**More examples: [Digtron Luanti Forum Topic](https://forum.luanti.org/viewtopic.php?t=16295)**
67

7-
A digging machine's components must be connected to the control block via a path leading through the faces of the blocks - diagonal connections across edges and corners don't count.
8+
This mod contains a set of blocks that can be used to construct highly customizable and
9+
modular tunnel-boring machines, bridge-builders, road-pavers, wall-o-matics, and other
10+
such construction/destruction contraptions.
811

9-
The basic block types that can be assembled into a functioning digging machine are:
12+
## Basic functionality
1013

11-
* Digger heads, which excavate material in front of them when the machine is triggered
12-
* Builder heads, which build a user-configured node in the direction they're facing
13-
* Inventory modules, which hold material produced by the digger and provide material to the builders
14-
* Fuel modules, which holds flammable materials to feed the beast
15-
* Control block, used to trigger the machine and move it in a particular direction.
14+
A digging machine's components must be connected to the control block via a path leading
15+
through the faces of the blocks - diagonal connections across edges and corners don't count.
1616

17-
Diggers mine out blocks and shunt them into the Digtron's inventory, or drop them on the ground if there isn't room in the inventory to store them.
17+
#### Crucial Digtron blocks
1818

19-
Builder heads can be used to lay down a solid surface as the Digtron moves, useful for situations where a tunnel-borer intersects a cavern. Builder heads can be set to construct their target block "intermittently", allowing for regularly-spaced structures to be constructed. Common uses include building support arches at regular intervals in a tunnel, adding a torch on the wall at regular intervals, laying rails with regularly-spaced powered rails interspersed, and adding stairs to vertical shafts.
19+
* **Digger heads** excavate material in front of them when the machine is triggered.
20+
* The mined blocks are shunt into the inventory module. Excess is dropped to ground.
21+
* **Builder heads** build a user-configured node in the direction they're facing.
22+
* Useful for situations where a tunnel-borer intersects a cavern.
23+
* **Inventory modules** hold material produced by the digger and provide material to the builders.
24+
* **Fuel modules** hold flammable materials to feed the beast.
25+
* **Control blocks** trigger the machine and move it in a particular direction.
26+
* The auto-controller triggers automatically for a custom number of cycles.
2027

21-
The auto-controller block is able to trigger automatically for a user-selected number of cycles. A player can ride their Digtron as it goes.
28+
Builder heads can be set to construct their target block "intermittently", allowing
29+
for regularly-spaced structures to be constructed. Common uses include building support
30+
arches at regular intervals in a tunnel, adding a torch on the wall at regular
31+
intervals, laying rails with regularly-spaced powered rails interspersed, and adding
32+
stairs to vertical shafts.
2233

23-
Other specialized Digtron blocks include:
34+
A player can ride their Digtron as it goes.
2435

25-
* An "axle" block that allows an assembled Digtron to be rotated into new orientations without needing to be rebuilt block-by-block
26-
* A crate that can store an assembled Digtron and allow the player to transport it to a new location
27-
* A duplicator that can create a copy of an existing Digtron (if provided with enough spare parts)
28-
* An item ejector to clear Digtron's inventory of excavated materials and inject it into pipeworks tubes if that mod is installed.
29-
* A light that can be mounted on a Digtron to illuminate the workspace as it moves
36+
#### Other specialized Digtron blocks
37+
38+
* **"Axle" block**: allows an assembled Digtron to be rotated into new orientations without needing to be rebuilt block-by-block
39+
* **Crate**: stores an assembled Digtron and allows the player to transport it to a new location
40+
* **Duplicator**: creates a copy of an existing Digtron (if provided with enough spare parts)
41+
* **Item ejector**: moves excavated materials from a Digtron's inventory into pipeworks tubes.
42+
* **Light**: can be mounted on a Digtron to illuminate the workspace as it moves
3043
* Structural components to make it look cool
3144

32-
The Digtron mod depends on the default mod and [fakelib](https://content.minetest.net/packages/OgelGames/fakelib/), and includes optional support for several other mods:
45+
## License
46+
47+
* Code: MIT
48+
* Textures: CC-BY-SA 3.0
49+
* Sounds: CC BY 3.0 / CC 1.0 ([sounds/license.txt](sounds/license.txt))
50+
51+
See also: [LICENSE.txt](LICENSE.txt).
52+
53+
## Dependencies
54+
55+
#### Mandatory
56+
57+
* Luanti/Minetest >= 5.5.0
58+
* `default` mod (from Minetest Game or compatible games)
59+
* [fakelib](https://content.luanti.org/packages/OgelGames/fakelib/)
60+
61+
#### Optional
3362

34-
* [doc](https://forum.minetest.net/viewtopic.php?t=15912), an in-game documentation mod. Detailed documentation for all of the Digtron's individual blocks are included as well as pages of general concepts and design tips.
35-
* [pipeworks](https://forum.minetest.net/viewtopic.php?id=2155), a set of pneumatic tubes that allows inventory items to be extracted from or inserted into Digtron inventories.
36-
* [hopper](https://forum.minetest.net/viewtopic.php?&t=12379), a different mod for inserting into and extracting from Digtron inventories. Note that only [the most recent version of hopper is Digtron-capable,](https://github.com/minetest-mods/hopper) earlier versions lack a suitable API.
37-
* [awards](https://forum.minetest.net/viewtopic.php?&t=4870), a mod that adds achievements to the game. Over thirty Digtron-specific achievements are included.
38-
* [technic](https://forum.minetest.net/viewtopic.php?f=11&t=2538), which adds rechargeable batteries and power cables to the game that Digtron can use instead of fuel.
39-
* [TechAge](https://forum.minetest.net/viewtopic.php?f=9&t=24619), a mod that adds technology stages where the player advances from the water mill and steam engine into future technology. It includes a rechargeable Digtron Battery.
63+
* [doc](https://forum.luanti.org/viewtopic.php?t=15912), an in-game documentation mod.
64+
Detailed documentation for all of the Digtron's individual blocks are included as
65+
well as pages of general concepts and design tips.
66+
* Note: The mods `doc` and `doc_items` should be enabled for the best experience.
67+
* [pipeworks](https://forum.luanti.org/viewtopic.php?t=2155) for item transport automation.
68+
* [hopper](https://github.com/minetest-mods/hopper) for item transport automation.
69+
* [awards](https://forum.luanti.org/viewtopic.php?t=4870) to add over 30 Digtron-specific achievements (progression) to the game.
70+
* [technic](https://forum.luanti.org/viewtopic.php?t=2538) to power Digtron with electricity (including batteries!).
71+
* [TechAge](https://forum.luanti.org/viewtopic.php?t=24619), a mod that adds technology stages where the player advances from the water mill and steam engine into future technology. It includes a rechargeable Digtron Battery.

mod.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ description = Adds components for building modular tunnel boring machines.
55
depends = default, fakelib
66
optional_depends = pipeworks, doc, hopper, awards, catacomb, intllib, technic
77
license = MIT, LGPL 2.1 or later
8-
forum = https://forum.minetest.net/viewtopic.php?t=16295
8+
forum = https://forum.luanti.org/viewtopic.php?t=16295
99
version = 0.8
1010
min_minetest_version = 5.5

0 commit comments

Comments
 (0)