Prepare for v1.1.0 release
- Rewrite the README entirely with new installation instructions - Tweak the styling in CONTRIBUTING.md and CHANGELOG.md
This commit is contained in:
Hugo Locurcio
parent
59c384dca4
commit
16ae14f458
12
CHANGELOG.md
12
CHANGELOG.md
@ -1,12 +1,14 @@
|
||||
# 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]
|
||||
|
||||
## [1.1.0] - 2017-10-04
|
||||
|
||||
### Added
|
||||
|
||||
- 3 new node shapes in the circular saw (thin slabs, available in
|
||||
@ -23,7 +25,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
|
||||
- Straw
|
||||
- Tin Block
|
||||
- Wool (all colors)
|
||||
- Other mods can now get a list of all the defined Stairs+ shapes
|
||||
|
||||
## [1.0.0] - 2017-02-19
|
||||
|
||||
- Initial versioned release.
|
||||
|
||||
[1.1.0]: https://github.com/minetest-mods/moreblocks/compare/v1.0.0...v1.1.0
|
||||
[Unreleased]: https://github.com/minetest-mods/moreblocks/compare/v1.0.0...HEAD
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
# Contribution Guide
|
||||
# Contributing to More Blocks
|
||||
|
||||
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 Blocks! 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.
|
||||
- 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
|
||||
[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.
|
||||
|
||||
74
README.md
74
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:** <https://forum.minetest.net/viewtopic.php?f=11&t=509>
|
||||
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/).
|
||||
|
||||
Loading…
Reference in New Issue
Block a user