From 16ae14f458321ccb0e93eed34bc7ade941b31026 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Wed, 4 Oct 2017 20:43:50 +0200 Subject: Prepare for v1.1.0 release - Rewrite the README entirely with new installation instructions - Tweak the styling in CONTRIBUTING.md and CHANGELOG.md --- README.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 69 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 767cb7c..6c37b74 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,76 @@ # More Blocks -More Blocks for [Minetest](http://minetest.net), a free and open source infinite +More Blocks 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=509) -More Blocks code is licensed under the zlib license, textures are by Calinou and are licensed under CC BY-SA 3.0 Unported. +## Installation -moreblocks_copperpatina.png is by pithydon licensed under CC0 1.0 +### Download the mod -**Forum topic:** +To install More Blocks, clone this Git repository into your Minetest's `mods/` +directory: + +``` +git clone https://github.com/minetest-mods/moreblocks.git +``` + +You can also +[download a ZIP archive](https://github.com/minetest-mods/moreblocks/archive/master.zip) +of More Blocks. If you do so, you will need to extract the archive, then rename +the resulting folder from `moreblocks-master` to `moreblocks` – this is +**absolutely** necessary to do, else, it won't work! + +### Enable the mod + +Once you have installed More Blocks, 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 Blocks 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 Blocks in. +3. Click **Configure**, then enable `moreblocks` by double-clicking it + (or ticking the **Enabled** checkbox). +4. Save the changes, then start a game on the world you enabled More Blocks on. +5. More Blocks 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_moreblocks = 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 Blocks on. +5. More Blocks should now be running on your world. + +## Version compatibility + +More Blocks 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 Blocks code is licensed under the zlib license, see + [`LICENSE.md`](LICENSE.md) for details. +- Unless otherwise specified, More Blocks textures are licensed under + [CC BY-SA 3.0 Unported](https://creativecommons.org/licenses/by-sa/3.0/). + +`moreblocks_copperpatina.png` was created by pithydon, and is licensed under +[CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/). -- cgit v1.2.3