Update README.md to reflect new contribution guidelines

This commit is contained in:
Elias Fleckenstein 2021-11-04 13:14:35 +01:00
parent f4803a35c4
commit be86b603f8
No known key found for this signature in database
GPG Key ID: 06927A5199D6C9B2

View File

@ -1,4 +1,4 @@
# MineClone 2 # MineClone2
An unofficial Minecraft-like game for Minetest. Forked from MineClone by davedevils. An unofficial Minecraft-like game for Minetest. Forked from MineClone by davedevils.
Developed by many people. Not developed or endorsed by Mojang AB. Developed by many people. Not developed or endorsed by Mojang AB.
@ -69,9 +69,9 @@ an explanation.
This game requires [Minetest](http://minetest.net) to run (version 5.3.0 or 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 later). So you need to install Minetest first. Only stable versions of Minetest
are officially supported. are officially supported.
There is no support for running MineClone 2 in development versions of Minetest. There is no support for running MineClone2 in development versions of Minetest.
To install MineClone 2 (if you haven't already), move this directory into the To install MineClone2 (if you haven't already), move this directory into the
“games” directory of your Minetest data directory. Consult the help of “games” directory of your Minetest data directory. Consult the help of
Minetest to learn more. Minetest to learn more.
@ -86,20 +86,21 @@ The MineClone2 repository is hosted at Mesehub. To contribute or report issues,
* Reddit: <https://www.reddit.com/r/MineClone2/> * Reddit: <https://www.reddit.com/r/MineClone2/>
* Minetest forums: <https://forum.minetest.net/viewtopic.php?f=50&t=16407> * Minetest forums: <https://forum.minetest.net/viewtopic.php?f=50&t=16407>
## Project description ## Target
The main goal of **MineClone 2** is to be a clone of Minecraft and to be released as free software. - Crucially, create a stable, moddable, free/libre clone of Minecraft
based on the Minetest engine with polished features, usable in both
* **Target of development: Minecraft, PC Edition, version 1.12** (later known as “Java Edition”) singleplayer and multiplayer. Currently, most of **Minecraft Java
* MineClone2 also includes Optifine features supported by the Minetest Edition 1.12.2** features are already implemented and polishing existing
* In general, Minecraft is aimed to be cloned as good as possible features are prioritized over new feature requests.
* Cloning the gameplay has highest priority - With lessened priority yet strictly, implement features targetting
* MineClone 2 will use different assets, but with a similar style **Minecraft version 1.17 + OptiFine** (OptiFine only as far as supported
* Limitations found in Minetest will be documented in the course of development by the Minetest Engine). This means features in parity with the listed
* Features of later Minecraft versions are collected in the mineclone5 branch Minecraft experiences are prioritized over those that don't fulfill this
scope.
## Using features from newer versions of Minecraft - Optionally, create a performant experience that will run relatively
For > 1.12 features, checkout MineClone5. It includes features from newer Minecraft versions. well on really low spec computers. Unfortunately, due to Minecraft's
Download it here: https://git.minetest.land/MineClone2/MineClone2/src/branch/mineclone5 mechanisms and Minetest engine's limitations along with a very small
playerbase on low spec computers, optimizations are hard to investigate.
## Completion status ## Completion status
This game is currently in **beta** stage. This game is currently in **beta** stage.
@ -186,7 +187,7 @@ Technical differences from Minecraft:
* Different engine (Minetest) * Different engine (Minetest)
* Different easter eggs * Different easter eggs
… and finally, MineClone 2 is free software (“free” as in “freedom”)! … and finally, MineClone2 is free software (“free” as in “freedom”)!
## Other readme files ## Other readme files