Merge pull request 'Update README files' (#1544) from beta into master

Reviewed-on: MineClone2/MineClone2#1544

CONTRIBUTING.md

@@ -7,13 +7,11 @@ But first, some things to note:
 MineClone 2's development target is to make a free software clone of Minecraft,
 ***version 1.12***, ***PC edition***, *** + Optifine features supported by the Minetest Engine ***.
 
-MineClone 2 is maintained by two persons. Namely, kay27 and EliasFleckenstein. You can find us
+MineClone 2 is maintained by three persons. Namely, kay27, EliasFleckenstein and jordan4ibanez. You can find us
-in the Minetest forums (forums.minetest.net), in IRC in the #minetest
+in the Minetest forums (forums.minetest.net), in IRC in the #mineclone2
 channel on irc.freenode.net. And finally, you can send e-mails to
 <eliasfleckenstein@web.de> or <kay27@bk.ru>.
 
-There is **no** guarantee we will accept anything from anybody.
-
 By sending us patches or asking us to include your changes in this game,
 you agree that they fall under the terms of the LGPLv2.1, which basically
 means they will become part of a free software.
@@ -26,8 +24,7 @@ For small and medium changes:
 
 * Fork the repository
 * Do your change in a new branch
-* Upload the repository somewhere where it can be accessed from the Internet and
+* Create a pull request to get your changes merged into master
-  notify us
 
 For small changes, sending us a patch is also good.
 
@@ -41,40 +38,30 @@ reserve the right to revert everything that we don't like.
 For bigger changes, we strongly recommend to use feature branches and
 discuss with me first.
 
-Contributors will be credited in `README.md`.
+If your code causes bugs and crashes, it is your responsibility to fix them as soon as possible.
 
-## Quality remarks
+We mostly use plain merging rather than rebasing or squash merging.
-Again: There is ***no*** guarantee we will accept anything from anybody.
-But we will gladly take in code from others when we feel it saves us work
-in the long run.
 
-### Inclusion criteria
+Your commit names should be relatively descriptive, e.g. when saying "Fix #issueid", the commit message should also contain the title of the issue.
-Depending on what you add, the chances for inclusion vary:
 
-### High chance for inclusion
+Contributors will be credited in `CREDITS.md`.
-* Gameplay features in Minecraft which are missing in MineClone 2
 
-### Medium chance for inclusion (discuss first)
+## Features > 1.12
-* Features which don't a impact on gameplay
-* GUI improvement
-* Features from pocket or console edition
 
-### Low chance for inclusion (discuss/optimize first)
+If you want to make a feature that was added in a Minecraft version later than 1.12, you should fork MineClone5 (mineclone5 branch in the repository) and add your changes to this.
-* Overhaul of architecture / mod structure
-* Mass-itemstring changes all over the place
-* Added files have a unusual high file size
-* Indentation looks like crazy
-* Single commits which add several unrelated things
-* Gameplay features which don't exist in Minecraft
 
-### Instant rejection
+## What we accept
-* Proprietary **anything**
-* Code contains `minetest.env` anywhere
 
-## Coding style guide
+* Every MC features up to version 1.12 JE.
-* Indentations should reflect the code flow
+* Every already finished and working good features from versions above (only when making a MineClone5 PR / Contribution).
-* Use tabs, not spaces for indentation (tab size = 8)
+* Except features which couldn't be done easily and bugfree because of Minetest engine limitations. Eg. we CAN extend world boundaries by playing with map chunks, just teleporting player onto next layer after 31000 , but it would cost too much (time, code, bugs, performance, stability, etc).
-* Never use `minetest.env`
+* Some features, approved by the rest of the community, I mean maybe some voting and really missing any negative feedback.
+
+## What we reject
+
+* Any features which cause critical bugs, sending them to rework/fix or trying to fix immediately.
+* Some small portions of big entirely missing features which just definitely break gamplay balance give nothing useful
+* Controversial features, which some people support while others do not should be discussed well, with publishing forum announcements, at least during the week. In case if there are still doubts - send them into the mod.
 
 ## Reporting bugs
 Report all bugs and missing Minecraft features here:

CREDITS.md

@@ -0,0 +1,116 @@
+# Credits
+
+## Creator of MineClone
+* davedevils
+
+## Creator of MineClone2
+* Wuzzy
+
+## Maintainers
+* Fleckenstein
+* kay27
+* oilboi
+
+## Developers
+* bzoss
+* AFCMS
+* epCode
+* ryvnf
+* iliekprogrammar
+* MysticTempest
+* Rootyjr
+* Nicu
+* aligator
+* Code-Sploit
+
+## Contributors
+* Laurent Rocher
+* HimbeerserverDE
+* TechDudie
+* Alexander Minges
+* ArTee3
+* ZeDique la Ruleta
+* pitchum
+* wuniversales
+* Bu-Gee
+* David McMackins II
+* Nicholas Niro
+* Wouters Dorian
+* Blue Blancmange
+* Jared Moody
+* Li0n
+* Midgard
+* NO11
+* Saku Laesvuori
+* Yukitty
+* ZedekThePD
+* aldum
+* dBeans
+* nickolas360
+* yutyo
+* ztianyang
+
+## MineClone5
+* kay27
+* Debiankaios
+* epCode
+* NO11
+* j45
+
+## Original Mod Authors
+* Wuzzy
+* Fleckenstein
+* BlockMen
+* TenPlus1
+* PilzAdam
+* ryvnf
+* stujones11
+* Arcelmi
+* celeron55
+* maikerumine
+* GunshipPenguin
+* Qwertymine3
+* Rochambeau
+* rubenwardy
+* stu
+* oilboi
+* 4aiman
+* Kahrl
+* Krock
+* UgnilJoZ
+* lordfingle
+* 22i
+* bzoss
+* kilbith
+* xeranas
+* kddekadenz
+* sofar
+* 4Evergreen4
+* jordan4ibanez
+* paramat
+
+## 3D Models
+* 22i
+* tobyplowy
+* epCode
+
+## Textures
+* XSSheep
+* Wuzzy
+* kingoscargames
+* leorockway
+* xMrVizzy
+* yutyo
+
+## Translations
+* Wuzzy
+* Rocher Laurent
+* wuniversales
+* kay27
+* pitchum
+
+## Special thanks
+* celeron55 for creating Minetest
+* Jordach for the jukebox music compilation from Big Freaking Dig
+* The workaholics who spent way too much time writing for the Minecraft Wiki. It's an invaluable resource for creating this game
+* Notch and Jeb for being the major forces behind Minecraft

LEGAL.md

@@ -0,0 +1,52 @@
+# Legal information
+This is a fan game, not developed or endorsed by Mojang AB.
+
+Copying is an act of love. Please copy and share! <3
+Here's the detailed legalese for those who need it:
+
+## License of source code
+MineClone 2 (by kay27, EliasFleckenstein, Wuzzy, davedevils and countless others)
+is an imitation of Minecraft.
+
+MineClone 2 is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License (in the LICENSE.txt file) for more
+details.
+
+In the mods you might find in the read-me or license
+text files a different license. This counts as dual-licensing.
+You can choose which license applies to you: Either the
+license of MineClone 2 (GNU GPLv3) or the mod's license.
+
+MineClone 2 is a direct continuation of the discontinued MineClone
+project by davedevils.
+
+Mod credits:
+See `README.txt` or `README.md` in each mod directory for information about other authors.
+For mods that do not have such a file, the license is the source code license
+of MineClone 2 and the author is Wuzzy.
+
+## License of media (textures and sounds)
+No non-free licenses are used anywhere.
+
+The textures, unless otherwise noted, are based on the Pixel Perfection resource pack for Minecraft 1.11,
+authored by XSSheep. Most textures are verbatim copies, while some textures have been changed or redone
+from scratch.
+The glazed terracotta textures have been created by (MysticTempest)[https://github.com/MysticTempest].
+Source: <https://www.planetminecraft.com/texture_pack/131pixel-perfection/>
+License: [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/)
+
+The main menu images are release under: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
+
+All other files, unless mentioned otherwise, fall under:
+Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
+http://creativecommons.org/licenses/by-sa/3.0/
+
+See README.txt in each mod directory for detailed information about other authors.
+

MISSING_ENGINE_FEATURES.md

@@ -1,40 +0,0 @@
-# Missing features in Minetest to recreate Minecraft features
-
-A side goal of the MineClone 2 project is to find any shortcomings of Minetest which make it impossible to recreate a Minecraft feature exactly.
-This file lists some of the missing features in Minetest which MineClone 2 would require.
-
-## No workaround possible
-For these features, no easy Lua workaround could be found.
-
-### Lua API
-#### Tools/wielded item
-- “Lock” hotbar for a brief time after using an item, making it impossible to switch item or to attach/mine/build until the delay is over (For eating with delay)
-- Tool charging: Holding down the mouse and releasing it, applying a “power level” (For bow and arrows, more charge = higher arrow range) ([issue 5212](https://github.com/minetest/minetest/issues/5212))
-- [Dual Wielding](http://minecraft.gamepedia.com/Dual_wield)
-- Eating/drinking animation ([issue 2811](https://github.com/minetest/minetest/issues/2811))
-
-#### Nodes
-- Light level 15 for nodes (not sunlight)
-- Nodes makes light level drop by 2 or or more per node ([issue 5209](https://github.com/minetest/minetest/issues/5209))
-
-## Interface
-- Inventory: Hold down right mouse button while holding an item stack to drop items into the slots as you move the mouse. Makes crafting MUCH faster
-- Sneak+Leftclick on crafting output crafts as many items as possible and immediately puts it into the player inventory ([issue 5211](https://github.com/minetest/minetest/issues/5211))
-- Sneak+click puts items in different inventories depending on the item type (maybe group-based)? Required for sneak-clicking to armor slots
-
-## Workaround theoretically possible
-For these features, a workaround (or hack ;-)) by using Lua is theoretically possible. But engine support would be clearly better, more performant, more reliable, etc.
-
-### Lua API
-#### Nodes
-- Change walking speed on block (soul sand)
-- Change jumping height on block (soul sand), 
-- Change object movement speed *through* a block, but for non-liquids (for cobweb)
-- Add `on_walk_over` event
-- Set frequency in which players lose breath. 2 seconds are hardcoded in Minetest, in Minecraft it's 1 second
-- Set damage frequency of `damage_per_second`. In Minecraft many things damage players every half-second rather than every second
-- Possible to damage players directly when they are with the head inside. This allows to add Minecraft-like suffocation
-- Sneak+click on inventory slot should be able to put items into additional “fallback inventories” if the first inventory is full. Useful for large chests
-
-#### Nice-to-haye
-- Utility function to rotate pillar-like nodes, requiring only 3 possible orientations (X, Y, Z). Basically this is `minetest.rotate_node` but with less orientations; the purpur pillar would mess up if a mirrored rotation would be possible. This is already implemented in MCL2, See `mcl_util` for more infos

README.md

@@ -2,7 +2,7 @@
 An unofficial Minecraft-like game for Minetest. Forked from MineClone by davedevils.
 Developed by many people. Not developed or endorsed by Mojang AB.
 
-Version: 0.71.0
+Version: 0.72.0 (in development)
 
 ### Gameplay
 You start in a randomly-generated world made entirely of cubes. You can explore
@@ -65,14 +65,6 @@ map builders. They can not be obtained in-game or in the creative inventory.
 Use the `/giveme` chat command to obtain them. See the in-game help for
 an explanation.
 
-#### Incomplete items
-These items do not work yet, but you can get them with `/giveme` for testing:
-
-* Minecart with Chest: `mcl_minecarts:chest_minecart`
-* Minecart with Furnace: `mcl_minecarts:furnace_minecart`
-* Minecart with Hopper: `mcl_minecarts:hopper_minecart`
-* Minecart with Command Block: `mcl_minecarts:command_block_minecart`
-
 ## Installation
 This game requires [Minetest](http://minetest.net) to run (version 5.3.0 or
 later). So you need to install Minetest first. Only stable versions of Minetest
@@ -83,23 +75,37 @@ To install MineClone 2 (if you haven't already), move this directory into the
 “games” directory of your Minetest data directory. Consult the help of
 Minetest to learn more.
 
+## Reporting bugs
+Please report all bugs and missing Minecraft features here:
+
+<https://git.minetest.land/MineClone2/MineClone2/issues>
+
+## Chating with the community
+Join our discord server at:
+
+<https://discord.gg/84GKcxczG3>
+
 ## Project description
 The main goal of **MineClone 2** is to be a clone of Minecraft and to be released as free software.
 
 * **Target of development: Minecraft, PC Edition, version 1.12** (later known as “Java Edition”)
 * MineClone2 also includes Optifine features supported by the Minetest
-* Features of later Minecraft versions might sneak in, but they have a low priority
+* In general, Minecraft is aimed to be cloned as good as possible
-* In general, Minecraft is aimed to be cloned as good as Minetest currently permits (no hacks)
 * Cloning the gameplay has highest priority
-* MineClone 2 will use different graphics and sounds, but with a similar style
+* MineClone 2 will use different assets, but with a similar style
-* Cloning the interface has no priority. It will only be roughly imitated
+* Limitations found in Minetest will be documented in the course of development
-* Limitations found in Minetest will be written down and reported in the course of development
+* Features of later Minecraft versions are collected in the mineclone5 branch
+
+## Using features from newer versions of Minecraft
+For > 1.12 features, checkout MineClone5. It includes features from newer Minecraft versions.
+Download it here: https://git.minetest.land/MineClone2/MineClone2/src/branch/mineclone5
 
 ## Completion status
-This game is currently in **alpha** stage.
+This game is currently in **beta** stage.
-It is playable, but unfinished, many bugs are to be expected.
+It is playable, but not yet feature-complete.
-Backwards-compability is *not* guaranteed, updating your world might cause small and
+Backwards-compability is not entirely guaranteed, updating your world might cause small bugs.
-big bugs (such as “missing node” errors or even crashes).
+If you want to use the git version of MineClone2 in production, consider using the production branch.
+It is updated weekly and contains relatively stable code for servers.
 
 The following main features are available:
 
@@ -128,7 +134,7 @@ The following main features are available:
 * Clock
 * Compass
 * Sponge
-* Slime block (does not interact with redstone)
+* Slime block
 * Small plants and saplings
 * Dyes
 * Banners
@@ -140,19 +146,19 @@ The following main features are available:
 * Creative inventory
 * Farming
 * Writable books
-* A few server commands
+* Commands
+* Villages
+* The End
 * And more!
 
 The following features are incomplete:
 
-* Generated structures (especially villages)
 * Some monsters and animals
 * Redstone-related things
-* The End
 * Special minecarts
 * A couple of non-trivial blocks and items
 
-Bonus features (not found in Minecraft 1.11):
+Bonus features (not found in Minecraft 1.12):
 
 * Built-in crafting guide which shows you crafting and smelting recipes
 * In-game help system containing extensive help about gameplay basics, blocks, items and more
@@ -177,148 +183,14 @@ Technical differences from Minecraft:
 * Different textures (Pixel Perfection)
 * Different sounds (various sources)
 * Different engine (Minetest)
+* Different easter eggs
 
 … and finally, MineClone 2 is free software (“free” as in “freedom”)!
 
-## Reporting bugs
-Please report all bugs and missing Minecraft features here:
-
-<https://git.minetest.land/MineClone2/MineClone2/issues>
-
-## Chating with the community
-Join our discord server at:
-
-<https://discord.gg/84GKcxczG3>
-
 ## Other readme files
 
 * `LICENSE.txt`: The GPLv3 license text
 * `CONTRIBUTING.md`: Information for those who want to contribute
-* `MISSING_ENGINE_FEATURES.md`: List of missing features in Minetest which MineClone 2 would need for improvement
 * `API.md`: For Minetest modders who want to mod this game
-
+* `LEGAL.md`: Legal information
-## Credits
+* `CREDITS.md`: List of everyone who contributed
-There are so many people to list (sorry). Check out the respective mod directories for details. This section is only a rough overview of the core authors of this game.
-
-### Coding
-* [Wuzzy](https://forum.minetest.net/memberlist.php?mode=viewprofile&u=3082): Main programmer of most mods (retired)
-* davedevils: Creator of MineClone on which MineClone 2 is based on
-* [ex-bart](https://github.com/ex-bart): Redstone comparators
-* [Rootyjr](https://github.com/Rootyjr): Fishing rod and bugfixes
-* [aligator](https://github.com/aligator): Improvement of doors
-* [ryvnf](https://github.com/ryvnf): Explosion mechanics
-* MysticTempest: Bugfixes
-* [bzoss](https://github.com/bzoss): Status effects, potions, brewing stand
-* kay27 <kay27@bk.ru>: Experience system, bugfixes, optimizations (Current maintainer)
-* [EliasFleckenstein03](https://github.com/EliasFleckenstein03): End crystals, enchanting, burning mobs / players, animated chests, bugfixes (Current maintainer)
-* epCode: Better player animations, new logo
-* 2mac: Fix bug with powered rail
-* Lots of other people: TO BE WRITTEN (see mod directories for details)
-
-#### Mod credits (summary)
-
-* `controls`: Arcelmi
-* `flowlib`: Qwertymine13
-* `walkover`: lordfingle
-* `drippingwater`: kddekadenz
-* `mobs_mc`: maikerumine, 22i and others
-* `awards`: rubenwardy
-* `screwdriver`: RealBadAngel, Maciej Kastakin, Minetest contributors
-* `xpanes`: Minetest contributors
-* `mesecons` mods: Jeija and contributors
-* `wieldview`: Stuart Jones
-* `mcl_meshhand`: Based on `newhand` by jordan4ibanez
-* `mcl_mobs`: Based on Mobs Redo [`mobs`] by TenPlus1 and contributors
-* Most other mods: Wuzzy
-
-Detailed credits for each mod can be found in the individual mod directories.
-
-### Graphics
-* [XSSheep](http://www.minecraftforum.net/members/XSSheep): Main author; creator of the Pixel Perfection resource pack of Minecraft 1.11
-* [Wuzzy](https://forum.minetest.net/memberlist.php?mode=viewprofile&u=3082): Main menu imagery and various edits and additions of texture pack
-* [kingoscargames](https://github.com/kingoscargames): Various edits and additions of existing textures
-* [leorockway](https://github.com/leorockway): Some edits of mob textures
-* [xMrVizzy](https://minecraft.curseforge.com/members/xMrVizzy): Glazed terracotta (textures are subject to be replaced later)
-* yutyo <tanakinci2002@gmail.com>: MineClone 2 logo
-* Other authors: GUI images
-
-### Translations
-* Wuzzy: German
-* Rocher Laurent <rocherl@club-internet.fr>: French
-* wuniversales: Spanish
-* kay27 <kay27@bk.ru>: Russian
-
-### Models
-* [22i](https://github.com/22i): Creator of all models
-* [tobyplowy](https://github.com/tobyplowy): UV-mapping fixes to said models
-
-### Sounds and music
-Various sources. See the respective mod directories for details.
-
-### Special thanks
-
-* davedevils for starting MineClone, the original version of this game
-* Wuzzy for starting and maintaining MineClone2 for several years
-* celeron55 for creating Minetest
-* Minetest's modding community for providing a huge selection of mods, some of which ended up in MineClone 2
-* Jordach for the jukebox music compilation from Big Freaking Dig
-* The workaholics who spent way too much time writing for the Minecraft Wiki. It's an invaluable resource for creating this game
-* Notch and Jeb for being the major forces behind Minecraft
-* XSSheep for creating the Pixel Perfection resource pack
-* [22i](https://github.com/22i) for providing great models and support
-* [maikerumine](http://github.com/maikerumine) for kicking off mobs and biomes
-
-## Info for programmers
-You find interesting and useful infos in `API.md`.
-
-## Legal information
-This is a fan game, not developed or endorsed by Mojang AB.
-
-Copying is an act of love. Please copy and share! <3
-Here's the detailed legalese for those who need it:
-
-### License of source code
-MineClone 2 (by kay27, EliasFleckenstein, Wuzzy, davedevils and countless others)
-is an imitation of Minecraft.
-
-MineClone 2 is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License (in the LICENSE.txt file) for more
-details.
-
-In the mods you might find in the read-me or license
-text files a different license. This counts as dual-licensing.
-You can choose which license applies to you: Either the
-license of MineClone 2 (GNU GPLv3) or the mod's license.
-
-MineClone 2 is a direct continuation of the discontinued MineClone
-project by davedevils.
-
-Mod credits:
-See `README.txt` or `README.md` in each mod directory for information about other authors.
-For mods that do not have such a file, the license is the source code license
-of MineClone 2 and the author is Wuzzy.
-
-### License of media (textures and sounds)
-No non-free licenses are used anywhere.
-
-The textures, unless otherwise noted, are based on the Pixel Perfection resource pack for Minecraft 1.11,
-authored by XSSheep. Most textures are verbatim copies, while some textures have been changed or redone
-from scratch.
-The glazed terracotta textures have been created by (MysticTempest)[https://github.com/MysticTempest].
-Source: <https://www.planetminecraft.com/texture_pack/131pixel-perfection/>
-License: [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/)
-
-The main menu images are release under: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
-
-All other files, unless mentioned otherwise, fall under:
-Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
-http://creativecommons.org/licenses/by-sa/3.0/
-
-See README.txt in each mod directory for detailed information about other authors.

mods/HUD/mcl_credits/init.lua

@@ -27,9 +27,9 @@ mcl_credits.people = {
 		"Rootyjr",
 		"Nicu",
 		"aligator",
+		"Code-Sploit",
 	}},
 	{"Contributors", 0x52FF00, {
-		"Code-Sploit",
 		"Laurent Rocher",
 		"HimbeerserverDE",
 		"TechDudie",
@@ -63,6 +63,38 @@ mcl_credits.people = {
 		"NO11",
 		"j45",
 	}},
+	{"Original Mod Authors", 0x343434, {
+		"Wuzzy",
+		"Fleckenstein",
+		"BlockMen",
+		"TenPlus1",
+		"PilzAdam",
+		"ryvnf",
+		"stujones11",
+		"Arcelmi",
+		"celeron55",
+		"maikerumine",
+		"GunshipPenguin",
+		"Qwertymine3",
+		"Rochambeau",
+		"rubenwardy",
+		"stu",
+		"oilboi",
+		"4aiman",
+		"Kahrl",
+		"Krock",
+		"UgnilJoZ",
+		"lordfingle",
+		"22i",
+		"bzoss",
+		"kilbith",
+		"xeranas",
+		"kddekadenz",
+		"sofar",
+		"4Evergreen4",
+		"jordan4ibanez",
+		"paramat",
+	}},
 	{"3D Models", 0x0019FF, {
 		"22i",
 		"tobyplowy",