From c2218f810dff942c2c1f47e25a316691a685824b Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Thu, 5 Oct 2017 20:37:32 +0200 Subject: [PATCH] Rewrite the README, update the changelog and tweak CONTRIBUTING.md Also optimize a few textures a tiny bit. --- CHANGELOG.md | 21 ++++-- CONTRIBUTING.md | 14 ++-- README.md | 71 +++++++++++++++++-- textures/moreores_copper_rail.png | Bin 269 -> 267 bytes textures/moreores_copper_rail_curved.png | Bin 267 -> 263 bytes textures/moreores_copper_rail_t_junction.png | Bin 337 -> 333 bytes textures/moreores_mithril_block.png | Bin 228 -> 225 bytes textures/moreores_tin_block.png | Bin 274 -> 267 bytes 8 files changed, 91 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e3c422f..15f9276 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,23 @@ -# 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] + +### Added + +- Brazilian translation. + +### Fixed + +- Handle tin which is now included in [Minetest Game](https://github.com/minetest/minetest_game). + If it is detected, then the tin nodes and items from More Ores won't be registered. ## [1.0.0] - 2017-02-19 -- Initial versioned release. \ No newline at end of file +- Initial versioned release. + +[Unreleased]: https://github.com/minetest-mods/moreblocks/compare/v1.0.0...HEAD diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 56fb504..e2a55fa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,10 @@ -# Contribution Guide +# Contributing to More Ores -Thank you for your interest in this mod! Before contributing, be sure to know -about these few guidelines: +Thank you for your interest in More Ores! 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/README.md b/README.md index bf702fc..5b4877e 100644 --- a/README.md +++ b/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:** +### 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/). diff --git a/textures/moreores_copper_rail.png b/textures/moreores_copper_rail.png index 91fb8246c96c4bd4833d4a357d5ca3374cf5a57a..31f2999a7112070bea7c87fa53483b6115ba88ef 100644 GIT binary patch delta 142 zcmV;90CE3~0*eBWg@18LL_t(|0ga9~5(6<1!$@kC;|1IQ|EUYRQ*$gi0}KFA_)i3Y zOf?rmaq%rW0E-%Tn&z#G9@vrX2vn>`j>Vl~2GFUrQkr&ou|IWG*J7^j_3JRor*-vd wCay=0NFBkQrL-zG0F$y|V|agypB?!E&(;HmMCY?v00000Ne4wvM6N<$g1z`XH2?qr delta 144 zcmV;B0B`?`0*wNYg@1ENL_t&-(~XWf4#O}I14ZtxZpreISNJU=%9|~F= yXWLYX@yHRt-OG`4EkvDQ1GQ`KW*6~UCtuIj1BNYOKp_AC00{s|MNUMnLSTYWC_X6w diff --git a/textures/moreores_copper_rail_curved.png b/textures/moreores_copper_rail_curved.png index 47ba6e084dfaed061e3b04aafc156c901ef8f683..e766793da74209defd3b3b912876558921132b44 100644 GIT binary patch delta 141 zcmV;80CN9}0*3;Sf`4#HL_t(|0R_N^al$|V1i-y}B|r(V-G8Yb0002+SpfiZk^mrS zTL4KrCV=aamhAy>r*KUG>9N510#frnVg3P9?&HarKnmaU#n?HI6pVefy|~k5eZ%-n vEz)sq%lpB%2~uo-^YUzdSERr^nx}sQxB|0IB#W>B0000 delta 145 zcmV;C0B-+>0*eBWf`4>LL_t&-(|wIg4#O}AL>X-SOWZW+=l(}6AR#qbWH#1&c!2J5 z)Qb>k{up4*2~!T*I&9W@h$q;64gsFU-p3M5vf5PMA+$9IQOd!Zm;Fzx_NEJiN^S8A zrS5Ky%`_hFc1Un$tHcL4+{MMpK?egkjftR zU}@};WON;tq`}OolreQLoFr|gp8Xm*7HsQ_*cc>T-_SaWVcHGpz=Nd47_-JB<3+9G zs%gkAC=D5=^lTns=r=W0D&YO_GX#S`SgbS<6s_Slyr4Td@h;qTh2~idFBRG-)k_gLq#UB^LVunQ8+U TDx}dp00000NkvXXu0mjfa(Yd! diff --git a/textures/moreores_mithril_block.png b/textures/moreores_mithril_block.png index 133a93b478ddf8c88211a72764e3c02bb47de1b3..dd7a246da75fad8bacce52b20b83e1e428d32dea 100644 GIT binary patch delta 155 zcmV;M0A&B<0pS6VPJez$L_t(|0R@1u3W87+hQCvg>-n!PZFxm-6fO~MK|!>&*lgs| z=GH3M132}(!S`|=hTA)FATz<56CVT{+HuS<3a$WH&SVa@da&SNp`k^Xl{r1;Sx~`q zhfLPcI~F`Nw78^DF}Xrr$BMgRw=ZMGBGp|ix6Elyuir8K0ThaW5uBryEO-C_002ov JPDHLkV1iEZMBV@Z delta 158 zcmV;P0Ac^(0ptOYPJe+(L_t&t*B#2S3W87=hT-=w$n|_jm$p<6I0}b|wxA%|T5L9Q zX>)58>;jy+-mL8z9^R*8*Ik~G9f=8+9C#sEQTKg>00000NkvXXu0mjfz2rm* delta 180 zcmV;l089Ui0+IrdW`CDSL_t&-(?W#ZgfT