diff options
Diffstat (limited to 'moreores/README.md')
| -rw-r--r-- | moreores/README.md | 71 |
1 files changed, 67 insertions, 4 deletions
diff --git a/moreores/README.md b/moreores/README.md index bf702fc..5b4877e 100644 --- a/moreores/README.md +++ b/moreores/README.md @@ -1,10 +1,73 @@ # More Ores -More Ores for [Minetest](http://minetest.net), a free and open source infinite +More Ores 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=549) -More Ores 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=549> +### Download the mod + +To install More Ores, clone this Git repository into your Minetest's `mods/` +directory: + +``` +git clone https://github.com/minetest-mods/moreores.git +``` + +You can also +[download a ZIP archive](https://github.com/minetest-mods/moreores/archive/master.zip) +of More Ores. If you do so, you will need to extract the archive, then rename +the resulting folder from `moreores-master` to `moreores` – this is +**absolutely** necessary to do, else, it won't work! + +### Enable the mod + +Once you have installed More Ores, 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 More Ores 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 More Ores in. +3. Click **Configure**, then enable `moreores` by double-clicking it + (or ticking the **Enabled** checkbox). +4. Save the changes, then start a game on the world you enabled More Ores on. +5. More Ores 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_moreores = 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 More Ores on. +5. More Ores should now be running on your world. + +## Version compatibility + +More Ores 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 © 2011-2017 Hugo Locurcio and contributors + +- More Ores code is licensed under the zlib license, see + [`LICENSE.md`](LICENSE.md) for details. +- Unless otherwise specified, More Ores textures are licensed under + [CC BY-SA 3.0 Unported](https://creativecommons.org/licenses/by-sa/3.0/). |