MineClone2, a voxel-based sandbox game for Minetest
Go to file
cora d1d2b03635 Merge pull request 'Add mangrove swamps' (#2503) from mangrove_swamps into master
Reviewed-on: MineClone2/MineClone2#2503
Reviewed-by: MysticTempest <mystictempest@noreply.git.minetest.land>
2022-08-03 10:39:20 +00:00
README_locale add translate of README.md 2022-02-23 23:58:04 +01:00
menu obtimize icons again 2022-02-23 16:30:08 +01:00
mods Fix mangrove (trap)door, stair and slab recipes 2022-08-03 11:57:17 +02:00
tools Fix create_luacheck 2022-07-15 13:24:45 -06:00
.gitignore add `.blend2` and `.blend3` files to gitignore 2022-02-24 10:16:48 +01:00
.luacheckrc [mcl_mobs] fix some warnings (131 remaining!) 2021-05-25 00:37:02 +02:00
API.md Fix header depth 2022-06-16 19:43:17 -06:00
CODE_OF_CONDUCT.md Update contribution guidelines 2021-10-24 20:13:34 +02:00
CONTRIBUTING.md The project's name is Minestom, not Minestorm 2022-01-18 23:33:27 -05:00
CREDITS.md Some more additions to CREDITS.md 2022-07-16 16:41:58 +02:00
GROUPS.md Add soul_group to s.soil&sand, torch fix recpipe 2022-05-24 13:25:59 +02:00
LEGAL.md Update README files 2021-04-12 14:03:51 +02:00
LICENSE.txt Move project overall license to GNU GPLv3 2020-05-30 19:34:36 +02:00
README.md Set version to 0.78 (indev) 2022-07-16 17:49:31 +02:00
description.txt Use mod.conf in all mods, part 1 2021-03-04 15:22:14 +01:00
game.conf name -> title in game.conf 2022-06-07 03:17:32 +02:00
minetest.conf Minor update to home directory warning in minetest.conf 2021-04-03 05:26:08 +00:00
screenshot.png #41 Remove proprietary textures, update game screenshot 2022-06-19 00:24:33 +02:00
settingtypes.txt Fix nether dust particles using wrong setting 2022-07-18 05:30:37 +02:00

README.md

MineClone2

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.78 (in development)

Gameplay

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 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 various 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.

Gameplay summary

  • Sandbox-style gameplay, no goals
  • Survive: Fight against hostile monsters and hunger
  • Mine for ores and other treasures
  • Magic: Gain experience and enchant your tools
  • Use the collected blocks to create great buildings, your imagination is the limit
  • Collect flowers (and other dye sources) and colorize your world
  • Find some seeds and start farming
  • Find or craft one of hundreds of items
  • Build a railway system and have fun with minecarts
  • Build complex machines with redstone circuits
  • In creative mode you can build almost anything for free and without limits

How to play (quick start)

Getting started

  • 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 4 wood planks in a 2×2 shape in the crafting grid to make a 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
  • Different tools break different kinds of blocks. Try them out!
  • Continue playing as you wish. Have fun!

Farming

  • Find seeds
  • Craft hoe
  • Rightclick dirt or similar block with hoe to create farmland
  • Place seeds on farmland and watch them grow
  • Collect plant when fully grown
  • If near water, farmland becomes wet and speeds up growth

Furnace

  • Craft furnace
  • Furnace allows you to obtain more items
  • Upper slot must contain a smeltable item (example: iron ore)
  • Lower slot must contain a fuel item (example: coal)
  • See tooltips in crafting guide to learn about fuels and smeltable items

Additional help

More help about the gameplay, blocks items and much more can be found from inside the game. You can access the help from your inventory menu.

Special items

The following items are interesting for Creative Mode and for adventure map builders. They can not be obtained in-game or in the creative inventory.

  • Barrier: mcl_core:barrier

Use the /giveme chat command to obtain them. See the in-game help for an explanation.

Installation

This game requires Minetest to run (version 5.4.1 or later). So you need to install Minetest first. Only stable versions of Minetest are officially supported. There is no support for running MineClone2 in development versions of Minetest.

To install MineClone2 (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.

The MineClone2 repository is hosted at Mesehub. To contribute or report issues, head there.

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

This game is currently in beta stage. It is playable, but not yet feature-complete. Backwards-compability is not entirely guaranteed, updating your world might cause small 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.

The following main features are available:

  • Tools, weapons
  • Armor
  • Crafting system: 2×2 grid, crafting table (3×3 grid), furnace, including a crafting guide
  • Chests, large chests, ender chests, shulker boxes
  • Furnaces, hoppers
  • Hunger
  • Most monsters and animals
  • All ores from Minecraft
  • Most blocks in the overworld
  • Water and lava
  • Weather
  • 28 biomes + 5 Nether Biomes
  • The Nether, a fiery underworld in another dimension
  • Redstone circuits (partially)
  • Minecarts (partial)
  • Status effects (partial)
  • Experience
  • Enchanting
  • Brewing, potions, tipped arrow (partial)
  • Boats
  • Fire
  • Buidling blocks: Stairs, slabs, doors, trapdoors, fences, fence gates, walls
  • Clock
  • Compass
  • Sponge
  • Slime block
  • Small plants and saplings
  • Dyes
  • Banners
  • Deco blocks: Glass, stained glass, glass panes, iron bars, hardened clay (and colors), heads and more
  • Item frames
  • Jukeboxes
  • Beds
  • Inventory menu
  • Creative inventory
  • Farming
  • Writable books
  • Commands
  • Villages
  • The End
  • And more!

The following features are incomplete:

  • Some monsters and animals
  • Redstone-related things
  • Special minecarts
  • A couple of non-trivial blocks and items

Bonus features (not found in Minecraft):

  • 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
  • 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
  • Saplings in chests in mapgen v6
  • Fully moddable (thanks to Minetest's powerful Lua API)
  • New blocks and items:
    • Lookup tool, shows you the help for whatever it touches
    • More slabs and stairs
    • Nether Brick Fence Gate
    • Red Nether Brick Fence
    • Red Nether Brick Fence Gate
  • Structure replacements - these small variants of Minecraft structures serve as replacements until we can get large structures working:
    • Woodland Cabin (Mansions)
    • Nether Outpost (Fortress)

Technical differences from 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)
  • Still very incomplete and buggy
  • Blocks, items, enemies and other features are missing
  • A few items have slightly different names to make them easier to distinguish
  • Different music for jukebox
  • Different textures (Pixel Perfection)
  • Different sounds (various sources)
  • Different engine (Minetest)
  • Different easter eggs

… and finally, MineClone2 is free software (“free” as in “freedom”)!

Other readme files

  • LICENSE.txt: The GPLv3 license text
  • CONTRIBUTING.md: Information for those who want to contribute
  • API.md: For Minetest modders who want to mod this game
  • LEGAL.md: Legal information
  • CREDITS.md: List of everyone who contributed