minetest-mods/maptools
1
0
Fork 1
mirror of https://github.com/minetest-mods/maptools.git synced 2024-12-24 16:30:21 +01:00
Code Issues Releases Wiki Activity

Update the README, CHANGELOG, NODES and CONTRIBUTING documents

Browse Source
This commit is contained in:
Hugo Locurcio 2017-10-08 00:33:42 +02:00
parent dafff87655
commit 7c45f1d53c
4 changed files with 104 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CHANGELOG.md
View File

@ -1,10 +1,14 @@
# Change Log # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/) 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/). and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [1.0.0] - 2017-02-19 ## [1.0.0] - 2017-02-19
- Initial versioned release. - Initial versioned release.
[Unreleased]: https://github.com/minetest-mods/moreblocks/compare/v1.0.0...HEAD

14
CONTRIBUTING.md
View File

@ -1,10 +1,10 @@
# Contribution Guide # Contributing to Map Tools
Thank you for your interest in this mod! Before contributing, be sure to know Thank you for your interest in Map Tools! Before contributing,
about these few guidelines: be sure to know about these few guidelines:
- Contributions have to be under the zlib license (or compatible) for code, - Contributions have to be licensed under the zlib license (or compatible)
and CC BY-SA 3.0 license (or compatible) for assets. for code, and CC BY-SA 3.0 (or compatible) for assets.
- Make sure to update the change log, keeping the - Make sure to update the changelog, keeping the
[change log format](http://keepachangelog.com/) we use. [changelog format](http://keepachangelog.com/en/1.0.0/) we use.
- Don't bump the version yourself. Maintainers will do this when necessary. - Don't bump the version yourself. Maintainers will do this when necessary.

61
NODES.md
View File

@ -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. ## Blocks
* `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
------
**[!]** 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). **[!]** 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.
* `(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`, … - `player_clip`: **[!]** invisible block, not pointable.
- `full_clip`: invisible block, pointable. Also available as a thin face: full_clip_face.
* `full_grass:` unbreakable block with the grass texture on all sides. - `smoke_block`: some smoke (does not harm players or entities).
- `no_build`: **[!]** very basic building prevention.
* `player_clip:` **[!]** invisible block, not pointable. - `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).
* `full_clip:` invisible block, pointable. Also available as a thin face: full_clip_face. - `kill`: **[!]** instant kill (deals 10 heart damage) blocks.
- `light_block`: **[!]** invisible non-solid block, prevents light from passing through.
* `smoke_block:` some smoke (does not harm players or entities). - `light_bulb`: **[!]** invisible non-solid block, emitting a good amount of light.
* `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.

74
README.md
View File

@ -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. 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/).