summaryrefslogtreecommitdiff
path: root/maptools
diff options
context:
space:
mode:
authorVanessa Ezekowitz <vanessaezekowitz@gmail.com>2017-10-27 15:13:31 -0400
committerVanessa Ezekowitz <vanessaezekowitz@gmail.com>2017-10-27 15:13:31 -0400
commit6281dc744dc3951234931a9f44c3bdd353f79df7 (patch)
tree0ead0d0d18be58bed7480cb9a5ea1495230c568f /maptools
parent2e6082ccdbd121cd5fc0f82a931ac01ac00dcb76 (diff)
downloaddreambuilder_modpack-6281dc744dc3951234931a9f44c3bdd353f79df7.tar
dreambuilder_modpack-6281dc744dc3951234931a9f44c3bdd353f79df7.tar.gz
dreambuilder_modpack-6281dc744dc3951234931a9f44c3bdd353f79df7.tar.bz2
dreambuilder_modpack-6281dc744dc3951234931a9f44c3bdd353f79df7.tar.xz
dreambuilder_modpack-6281dc744dc3951234931a9f44c3bdd353f79df7.zip
updated boost cart, homedecor modpack, castles modpack, currency, farming-redo,
maptools, mesecons, moreblocks, moreores, pipeworks, quartz
Diffstat (limited to 'maptools')
-rw-r--r--maptools/CHANGELOG.md12
-rw-r--r--maptools/CONTRIBUTING.md14
-rw-r--r--maptools/NODES.md61
-rw-r--r--maptools/README.md74
4 files changed, 104 insertions, 57 deletions
diff --git a/maptools/CHANGELOG.md b/maptools/CHANGELOG.md
index e3c422f..882b5e9 100644
--- a/maptools/CHANGELOG.md
+++ b/maptools/CHANGELOG.md
@@ -1,10 +1,14 @@
-# Change Log
+# Changelog
All notable changes to this project will be documented in this file.
-The format is based on [Keep a Changelog](http://keepachangelog.com/)
-and this project adheres to [Semantic Versioning](http://semver.org/).
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
## [1.0.0] - 2017-02-19
-- Initial versioned release. \ No newline at end of file
+- Initial versioned release.
+
+[Unreleased]: https://github.com/minetest-mods/maptools/compare/v1.0.0...HEAD
diff --git a/maptools/CONTRIBUTING.md b/maptools/CONTRIBUTING.md
index 56fb504..f656b22 100644
--- a/maptools/CONTRIBUTING.md
+++ b/maptools/CONTRIBUTING.md
@@ -1,10 +1,10 @@
-# Contribution Guide
+# Contributing to Map Tools
-Thank you for your interest in this mod! Before contributing, be sure to know
-about these few guidelines:
+Thank you for your interest in Map Tools! Before contributing,
+be sure to know about these few guidelines:
-- Contributions have to be under the zlib license (or compatible) for code,
- and CC BY-SA 3.0 license (or compatible) for assets.
-- Make sure to update the change log, keeping the
- [change log format](http://keepachangelog.com/) we use.
+- Contributions have to be licensed under the zlib license (or compatible)
+ for code, and CC BY-SA 3.0 (or compatible) for assets.
+- Make sure to update the changelog, keeping the
+ [changelog format](http://keepachangelog.com/en/1.0.0/) we use.
- Don't bump the version yourself. Maintainers will do this when necessary.
diff --git a/maptools/NODES.md b/maptools/NODES.md
index f5ce3cc..5e0c079 100644
--- a/maptools/NODES.md
+++ b/maptools/NODES.md
@@ -1,45 +1,26 @@
-Item names for spawning the items using /give or /giveme
-========================================================
+# Item names for spawning the items using /give or /giveme
-Items
------
+## Items
-* `admin_pick:` magenta pickaxe, infinite durability, mines everything including unbreakable blocks instantly. No drops. Don't put this pickaxe in the hands of a griefer, of course.
+- `admin_pick`: magenta pickaxe, infinite durability, mines everything including unbreakable blocks instantly. No drops. Don't put this pickaxe in the hands of a griefer, of course.
+- `admin_pick_with_drops`: same as admin pickaxe, but drops stuff.
+- `infinite_fuel`: fuel lasting for a (near)-infinite time. Don't worry about the "near" * it lasts for about 50 in-real-life years.
+- `super_apple`: a yellow apple which heals 20 HP.
+- `copper_coin`,
+- `silver_coin`,
+- `gold_coin`: these have nothing to do with the More Ores mod; they can be used as a currency for trading, or as an universal currency for mods that add shops.
-* `admin_pick_with_drops:` same as admin pickaxe, but drops stuff.
-
-* `infinite_fuel:` fuel lasting for a (near)-infinite time. Don't worry about the "near" * it lasts for about 50 in-real-life years.
-
-* `super_apple:` a yellow apple which heals 20 HP.
-
-* `copper_coin,`
-* `silver_coin,`
-* `gold_coin:` these have nothing to do with the More Ores mod; they can be used as a currency for trading, or as an universal currency for mods that add shops.
-
-Blocks
-------
+## Blocks
**[!]** denotes an unpointable, unbreakable block; be very careful with them, they cannot be removed by hand (they can only be removed with WorldEdit or similar).
-
-
-* `(block)_u` : unbreakable, non-flammable, non-falling, non-decaying blocks, most common blocks have their unbreakable form (examples: maptools:stone or maptools:wood for unbreakable stone/wood). Examples: `stone_u`, `wood_u`, `glass_u`, …
-
-* `full_grass:` unbreakable block with the grass texture on all sides.
-
-* `player_clip:` **[!]** invisible block, not pointable.
-
-* `full_clip:` invisible block, pointable. Also available as a thin face: full_clip_face.
-
-* `smoke_block:` some smoke (does not harm players or entities).
-
-* `no_build:` **[!]** very basic building prevention.
-
-* `no_interact:` prevents interacting through the block (opening chests, furnaces, attacking entities, …).
-
-* `damage_(1…5):` **[!]** damaging blocks. The damage is in half hearts and ranges from 1 to 5 (0.5 to 2.5 hearts damage every second).
-
-* `kill:` **[!]** instant kill (deals 10 heart damage) blocks.
-
-* `light_block:` **[!]** invisible non-solid block, prevents light from passing through.
-
-* `light_bulb:` **[!]** invisible non-solid block, emitting a good amount of light.
+- `(block)_u` : unbreakable, non-flammable, non-falling, non-decaying blocks, most common blocks have their unbreakable form (examples: maptools:stone or maptools:wood for unbreakable stone/wood). Examples: `stone_u`, `wood_u`, `glass_u`, …
+- `full_grass`: unbreakable block with the grass texture on all sides.
+- `player_clip`: **[!]** invisible block, not pointable.
+- `full_clip`: invisible block, pointable. Also available as a thin face: full_clip_face.
+- `smoke_block`: some smoke (does not harm players or entities).
+- `no_build`: **[!]** very basic building prevention.
+- `no_interact`: prevents interacting through the block (opening chests, furnaces, attacking entities, …).
+- `damage_(1…5)`: **[!]** damaging blocks. The damage is in half hearts and ranges from 1 to 5 (0.5 to 2.5 hearts damage every second).
+- `kill`: **[!]** instant kill (deals 10 heart damage) blocks.
+- `light_block`: **[!]** invisible non-solid block, prevents light from passing through.
+- `light_bulb`: **[!]** invisible non-solid block, emitting a good amount of light.
diff --git a/maptools/README.md b/maptools/README.md
index bd65652..7a14122 100644
--- a/maptools/README.md
+++ b/maptools/README.md
@@ -1,11 +1,73 @@
-Map Tools
-=========
+# Map Tools
-Map Tools for [Minetest](http://minetest.net), a free and open source infinite
+Map Tools for [Minetest](https://www.minetest.net/), a free and open source infinite
world block sandbox game.
-To install, just clone this repository into your "mods" directory.
+[**Forum topic**](https://forum.minetest.net/viewtopic.php?f=11&t=1882)
-Map Tools code is licensed under the zlib license, textures are by Calinou and are licensed under CC BY-SA 3.0 Unported.
+## Installation
-**Forum topic:** <https://forum.minetest.net/viewtopic.php?f=11&t=1882>
+### Download the mod
+
+To install Map Tools, clone this Git repository into your Minetest's `mods/`
+directory:
+
+```
+git clone https://github.com/minetest-mods/maptools.git
+```
+
+You can also
+[download a ZIP archive](https://github.com/minetest-mods/maptools/archive/master.zip)
+of Map Tools. If you do so, you will need to extract the archive, then rename
+the resulting folder from `maptools-master` to `maptools` – this is
+**absolutely** necessary to do, else, it won't work!
+
+### Enable the mod
+
+Once you have installed Map Tools, you need to enable it in Minetest.
+The procedure is as follows:
+
+#### Using the client's main menu
+
+This is the easiest way to enable Map Tools when playing in singleplayer
+(or on a server hosted from a client).
+
+1. Start Minetest and switch to the **Local Game** tab.
+2. Select the world you want to enable Map Tools in.
+3. Click **Configure**, then enable `maptools` by double-clicking it
+ (or ticking the **Enabled** checkbox).
+4. Save the changes, then start a game on the world you enabled Map Tools on.
+5. Map Tools should now be running on your world.
+
+#### Using a text editor
+
+This is the recommended way to enable the mod on a server without using a GUI.
+
+1. Make sure Minetest is not currently running (else, it will overwrite
+ the changes when exiting).
+2. Open the world's `world.mt` file using a text editor.
+3. Add the following line at the end of the file:
+
+```
+load_mod_maptools = true
+```
+
+If the line is already present in the file, then replace `false` with `true` on that line.
+
+4. Save the file, then start a game on the world you enabled Map Tools on.
+5. Map Tools should now be running on your world.
+
+## Version compatibility
+
+Map Tools is currently primarily tested with Minetest 0.4.16.
+It may or may not work with newer or older versions. Issues arising in older
+versions than 0.4.16 will generally not be fixed.
+
+## License
+
+Copyright © 2012-2017 Hugo Locurcio and contributors
+
+- Map Tools code is licensed under the zlib license, see
+ [`LICENSE.md`](LICENSE.md) for details.
+- Unless otherwise specified, Map Tools textures are licensed under
+ [CC BY-SA 3.0 Unported](https://creativecommons.org/licenses/by-sa/3.0/).