Mineclonia/mineclonia-cd2025
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Elias Åström 2023-03-29 19:14:28 +02:00
parent 5eabb3f4df
commit 70d43c7e13
1 changed files with 48 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
README.md
View File

@ -1,6 +1,5 @@
# MineClone2 # Mineclonia
An unofficial Minecraft-like game for Minetest. Forked from MineClone by davedevils. An unofficial Minecraft-like game for Minetest. Forked from MineClone2.
Developed by many people. Not developed or endorsed by Mojang AB.
Version: 0.81 Version: 0.81
@ -8,9 +7,10 @@ Version: 0.81
You start in a randomly-generated world made entirely of cubes. You can explore You start in a randomly-generated world made entirely of cubes. You can explore
the world and dig and build almost every block in the world to create new the world and dig and build almost every block in the world to create new
structures. You can choose to play in a “survival mode” in which you have to structures. You can choose to play in a “survival mode” in which you have to
fight monsters and hunger for survival and slowly progress through the fight monsters and hunger for survival and slowly progress through the various
various other aspects of the game, such as mining, farming, building machines, and so on other aspects of the game, such as mining, farming, building machines, and so on
Or you can play in “creative mode” in which you can build almost anything instantly. Or you can play in “creative mode” in which you can build almost anything
instantly.
#### Gameplay summary #### Gameplay summary
@ -18,7 +18,8 @@ Or you can play in “creative mode” in which you can build almost anything in
* Survive: Fight against hostile monsters and hunger * Survive: Fight against hostile monsters and hunger
* Mine for ores and other treasures * Mine for ores and other treasures
* Magic: Gain experience and enchant your tools * Magic: Gain experience and enchant your tools
* Use the collected blocks to create great buildings, your imagination is the limit * Use the collected blocks to create great buildings, your imagination is the
limit
* Collect flowers (and other dye sources) and colorize your world * Collect flowers (and other dye sources) and colorize your world
* Find some seeds and start farming * Find some seeds and start farming
* Find or craft one of hundreds of items * Find or craft one of hundreds of items
@ -29,10 +30,14 @@ Or you can play in “creative mode” in which you can build almost anything in
## How to play (quick start) ## How to play (quick start)
### Getting started ### Getting started
* **Punch a tree** trunk until it breaks and collect wood * **Punch a tree** trunk until it breaks and collect wood
* Place the **wood into the 2×2 grid** (your “crafting grid” in your inventory menu and craft 4 wood planks * Place the **wood into the 2×2 grid** (your “crafting grid” in your inventory
* Place the 4 wood planks in a 2×2 shape in the crafting grid to **make a crafting table** menu and craft 4 wood planks
* **Rightclick the crafting table** for a 3×3 crafting grid to craft more complex things * Place the 4 wood planks in a 2×2 shape in the crafting grid to **make a
* Use the **crafting guide** (book icon) to learn all the possible crafting recipes crafting table**
* **Rightclick the crafting table** for a 3×3 crafting grid to craft more
complex things
* Use the **crafting guide** (book icon) to learn all the possible crafting
recipes
* **Craft a wooden pickaxe** so you can dig stone * **Craft a wooden pickaxe** so you can dig stone
* Different tools break different kinds of blocks. Try them out! * Different tools break different kinds of blocks. Try them out!
* Continue playing as you wish. Have fun! * Continue playing as you wish. Have fun!
@ -53,8 +58,8 @@ Or you can play in “creative mode” in which you can build almost anything in
* See tooltips in crafting guide to learn about fuels and smeltable items * See tooltips in crafting guide to learn about fuels and smeltable items
### Additional help ### Additional help
More help about the gameplay, blocks items and much more can be found from inside More help about the gameplay, blocks items and much more can be found from
the game. You can access the help from your inventory menu. inside the game. You can access the help from your inventory menu.
### Special items ### Special items
The following items are interesting for Creative Mode and for adventure The following items are interesting for Creative Mode and for adventure
@ -69,52 +74,36 @@ an explanation.
This game requires [Minetest](http://minetest.net) to run (version 5.4.1 or This game requires [Minetest](http://minetest.net) to run (version 5.4.1 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 MineClone2 in development versions of Minetest. There is no support for running Mineclonia in development versions of Minetest.
To install MineClone2 (if you haven't already), move this directory into the To install Mineclonia (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.
## Useful links ## Project description
The MineClone2 repository is hosted at Mesehub. To contribute or report issues, head there. The main goal of **Mineclonia** is to be a stable and performant clone of
Minecraft released as free software.
* Mesehub: <https://git.minetest.land/MineClone2/MineClone2> * Minecraft is aimed to be cloned as well as Minetest currently permits without
* Discord: <https://discord.gg/xE4z8EEpDC> resorting to hacks which are too heavyweight and complicated to maintain
* YouTube <https://www.youtube.com/channel/UClI_YcsXMF3KNeJtoBfnk9A> * Cloning the gameplay has highest priority
* IRC: <https://web.libera.chat/#mineclone2> * Cloning the interface has low priority. It will only be roughly imitated
* Matrix: <https://app.element.io/#/room/#mc2:matrix.org> * Mineclonia will use different graphics and sounds, but with a similar style
* Reddit: <https://www.reddit.com/r/MineClone2/> * Limitations found in Minetest will be written down and documented in the
* Minetest forums: <https://forum.minetest.net/viewtopic.php?f=50&t=16407> course of development
* ContentDB: <https://content.minetest.net/packages/wuzzy/mineclone2/>
* OpenCollective: <https://opencollective.com/mineclone2>
## Target
- Crucially, create a stable, moddable, free/libre clone of Minecraft
based on the Minetest engine with polished features, usable in both
singleplayer and multiplayer. Currently, a lot of **Minecraft Java
Edition** features are already implemented and polishing existing
features are prioritized over new feature requests.
- With lessened priority yet strictly, implement features targetting
**Current Minecraft versions + OptiFine** (OptiFine only as far as supported
by the Minetest Engine). This means features in parity with the listed
Minecraft experiences are prioritized over those that don't fulfill this
scope.
- Optionally, create a performant experience that will run relatively
well on really low spec computers. Unfortunately, due to Minecraft's
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.
It is playable, but not yet feature-complete. It is playable, but not yet feature-complete.
Backwards-compability is not entirely guaranteed, updating your world might cause small bugs. Backwards-compatibility is not guaranteed, updating your world might cause bugs
If you want to use the development version of MineClone2 in production, the master branch is usually relatively stable. The testing branch often features some experimental PRs and should be considered less stable. and things to behave differently.
The following main features are available: The following main features are available:
* Tools, weapons * Tools, weapons
* Armor * Armor
* Crafting system: 2×2 grid, crafting table (3×3 grid), furnace, including a crafting guide * Crafting system: 2×2 grid, crafting table (3×3 grid), furnace, including a
crafting guide
* Chests, large chests, ender chests, shulker boxes * Chests, large chests, ender chests, shulker boxes
* Furnaces, hoppers * Furnaces, hoppers
* Hunger * Hunger
@ -141,7 +130,8 @@ The following main features are available:
* Small plants and saplings * Small plants and saplings
* Dyes * Dyes
* Banners * Banners
* Deco blocks: Glass, stained glass, glass panes, iron bars, hardened clay (and colors), heads and more * Deco blocks: Glass, stained glass, glass panes, iron bars, hardened clay (and
colors), heads and more
* Item frames * Item frames
* Jukeboxes * Jukeboxes
* Beds * Beds
@ -154,7 +144,7 @@ The following main features are available:
* The End * The End
* And more! * And more!
The following features are incomplete: The following features are incomplete and might change in the future:
* Some monsters and animals * Some monsters and animals
* Redstone-related things * Redstone-related things
@ -164,8 +154,11 @@ The following features are incomplete:
Bonus features (not found in Minecraft): Bonus features (not found in Minecraft):
* Built-in crafting guide which shows you crafting and smelting recipes * 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 * In-game help system containing extensive help about gameplay basics, blocks,
* Temporary crafting recipes. They only exist to make some otherwise unaccessible items available when you're not in creative mode. These recipes will be removed as development goes on an more features become available items and more
* Temporary crafting recipes. They only exist to make some otherwise
inaccessible items available when you're not in creative mode. These recipes
will be removed as development goes on an more features become available
* Saplings in chests in mapgen v6 * Saplings in chests in mapgen v6
* Fully moddable (thanks to Minetest's powerful Lua API) * Fully moddable (thanks to Minetest's powerful Lua API)
* New blocks and items: * New blocks and items:
@ -174,14 +167,17 @@ Bonus features (not found in Minecraft):
* Nether Brick Fence Gate * Nether Brick Fence Gate
* Red Nether Brick Fence * Red Nether Brick Fence
* Red Nether Brick Fence Gate * Red Nether Brick Fence Gate
* Structure replacements - these small variants of Minecraft structures serve as replacements until we can get large structures working: * Ability to store books in bookshelves
* Structure replacements - these small variants of Minecraft structures serve as
replacements until we can get large structures working:
* Woodland Cabin (Mansions) * Woodland Cabin (Mansions)
* Nether Outpost (Fortress) * Nether Outpost (Fortress)
Technical differences from Minecraft: Technical differences from Minecraft:
* Height limit of ca. 31000 blocks (much higher than in Minecraft) * Height limit of ca. 31000 blocks (much higher than in Minecraft)
* Horizontal world size is ca. 62000×62000 blocks (much smaller than in Minecraft, but it is still very large) * Horizontal world size is ca. 62000×62000 blocks (much smaller than in
Minecraft, but it is still very large)
* Still very incomplete and buggy * Still very incomplete and buggy
* Blocks, items, enemies and other features are missing * Blocks, items, enemies and other features are missing
* A few items have slightly different names to make them easier to distinguish * A few items have slightly different names to make them easier to distinguish
@ -191,7 +187,7 @@ Technical differences from Minecraft:
* Different engine (Minetest) * Different engine (Minetest)
* Different easter eggs * Different easter eggs
… and finally, MineClone2 is free software (“free” as in “freedom”)! … and finally, Mineclonia is free software (“free” as in “freedom”)!
## Other readme files ## Other readme files