maptools/README.md

75 lines
2.4 KiB
Markdown
Raw Normal View History

# Map Tools
2015-01-06 20:34:57 +01:00
Map Tools for [Minetest](https://www.minetest.net/), a free and open source infinite
2015-01-06 20:34:57 +01:00
world block sandbox game.
[**Forum topic**](https://forum.minetest.net/viewtopic.php?f=11&t=1882)
2015-01-06 20:34:57 +01:00
## Installation
2015-01-06 20:34:57 +01:00
### Download the mod
To install Map Tools, clone this Git repository into your Minetest's `mods/`
directory:
2019-03-02 18:18:12 +01:00
```bash
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)
2019-03-02 18:18:12 +01:00
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
2019-03-02 18:18:12 +01:00
**absolutely** required, as the mod won't work otherwise.
### 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.
2019-03-02 18:18:12 +01:00
1. Make sure Minetest is not currently running (otherwise, 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:
2019-03-02 18:18:12 +01:00
```text
load_mod_maptools = true
```
2019-03-02 18:18:12 +01:00
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
2019-03-23 15:19:47 +01:00
Map Tools is currently primarily tested with Minetest 0.4.17.
It may or may not work with newer or older versions. Issues arising in older
2019-03-23 15:19:47 +01:00
versions than 0.4.17 will generally not be fixed.
## License
2019-03-23 15:19:47 +01:00
Copyright © 2012-2019 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/).