README.md

   1 # MineClone 2
   2 An unofficial Minecraft-like game for Minetest. Forked from MineClone by daredevils.
   3 Developed by Wuzzy and contributors. Not developed or endorsed by Mojang AB.
   4
   5 Version: 0.26.0
   6
   7 ### Gameplay
   8 You start in a randomly-generated world made entirely of cubes. You can explore
   9 the world and dig and build almost every block in the world to create new
  10 structures. You can choose to play in a “survival mode” in which you have to
  11 fight monsters and hunger for survival and slowly progress through the
  12 various other aspects of the game, such as mining, farming, building machines, and so on
  13 Or you can play in “creative mode” in which you can build almost anything instantly.
  14
  15 #### Gameplay summary
  16
  17 * Sandbox-style gameplay, no goals (for now)
  18 * Survive: Fight against hostile monsters and hunger
  19 * Mine for ores and other treasures
  20 * Use the collected blocks to create great buildings, your imagination is the limit
  21 * Collect flowers (and other dye sources) and colorize your world
  22 * Find some seeds and start farming
  23 * Find or craft one of hundreds of items
  24 * Build a railway system and have fun with minecarts
  25 * Build complex machines with redstone circuits
  26 * In creative mode you can build almost anything for free and without limits
  27
  28 ## How to play (quick start)
  29 ### Getting started
  30 * **Use the world generator “v6”!**
  31 * **Punch a tree** trunk until it breaks and collect wood
  32 * Place the **wood into the 2×2 grid** (your “crafting grid” in your inventory menu and craft 4 wood planks
  33 * Place the 4 wood planks in a 2×2 shape in the crafting grid to **make a crafting table**
  34 * **Rightclick the crafting table** for a 3×3 crafting grid to craft more complex things
  35 * Use the **crafting guide** (book icon) to learn all the possible crafting recipes
  36 * **Craft a wooden pickaxe** so you can dig stone
  37 * Different tools break different kinds of blocks. Try them out!
  38 * Continue playing as you wish. Have fun!
  39
  40 ### Farming
  41 * Find seeds
  42 * Craft hoe
  43 * Rightclick dirt or similar block with hoe to create farmland
  44 * Place seeds on farmland and watch them grow
  45 * Collect plant when fully grown
  46 * If near water, farmland becomes wet and speeds up growth
  47
  48 ### Furnace
  49 * Craft furnace
  50 * Furnace allows you to obtain more items
  51 * Upper slot must contain a smeltable item (example: iron ore)
  52 * Lower slot must contain a fuel item (example: coal)
  53 * See tooltips in crafting guide to learn about fuels and smeltable items
  54
  55 ### Additional help
  56 More help about the gameplay, blocks items and much more can be found from inside
  57 the game. You can access the help from your inventory menu.
  58
  59 ### Special blocks
  60 The following blocks are interesting for Creative Mode and for adventure
  61 map builders. They can not be obtained in-game or in the creative inventory.
  62
  63 * Barrier: `mcl_core:barrier`
  64 * Command Block: `mesecons_commandblock:commandblock_off`
  65 * Monster Spawner (WIP): `mcl_mobspawners:spawner`
  66 * Huge mushroom blocks: See `mods/ITEMS/mcl_mushrooms/README.md`
  67
  68 Use the `/giveme` chat command to obtain them. See the in-game help for
  69 an explanation.
  70
  71 ## Installation
  72 This game requires [Minetest](http://minetest.net) 0.4.16 (or later) to run,
  73 so you need to install Minetest first. Only stable versions of Minetest are
  74 officially supported. There is no support whatsoever for running MineClone 2
  75 in development versions of Minetest.
  76 To install MineClone 2, move this directory into the “games” directory of
  77 your Minetest data directory. Consult the help of Minetest to learn more.
  78
  79 ## Project description
  80 The main goal of **MineClone 2** is to be a clone of Minecraft and to be released as free software.
  81
  82 * **Target of development: Minecraft, PC Edition, version 1.11** (later known as “Java Edition”)
  83 * Features of later Minecraft versions might sneak in, but they have a low priority
  84 * In general, Minecraft is aimed to be cloned as good as Minetest currently permits (no hacks)
  85 * Cloning the gameplay has highest priority
  86 * MineClone 2 will use different graphics and sounds, but with a similar style
  87 * Cloning the interface has no priority. It will only be roughly imitated
  88 * Limitations found in Minetest will be written down and reported in the course of development
  89
  90 ## Completion status
  91 This game is currently in **alpha** stage.
  92 It is playable, but very unfinished, many bugs are to be expected.
  93 Backwards-compability is *not* guaranteed, updating your world might cause small and
  94 big bugs (such as “missing node” errors or even crashes).
  95
  96 The following main features are available:
  97
  98 * Tools, weapons and armor
  99 * Crafting system: 2×2 grid, crafting table (3×3 grid), furnace, including a crafting guide
 100 * Chests, large chests, ender chests, shulker boxes
 101 * Hunger
 102 * Most monsters and animals
 103 * All ores from Minecraft
 104 * Most blocks in the overworld
 105 * Water and lava
 106 * Weather
 107 * Redstone circuits (partially): Redstone ore, redstone, redstone repeater, levers, buttons, redstone blocks, redstone lamps
 108 * Minecarts (partial)
 109 * Boats
 110 * Fire
 111 * Buidling blocks: Stairs, slabs, doors, trapdoors, fences, fence gates, walls
 112 * Clock
 113 * Compass
 114 * Sponge
 115 * Slime block (does not interact with redstone)
 116 * Small plants and saplings
 117 * Dyes
 118 * Banners
 119 * Deco blocks: Glass, stained glass, glass panes, iron bars, hardened clay (and colors), heads and more
 120 * Item frames
 121 * Jukeboxes
 122 * Beds
 123 * Inventory menu
 124 * Creative inventory
 125 * Farming
 126 * Bookshelves (deco only)
 127 * Writable books
 128 * A few server commands
 129 * And more!
 130
 131 The following features are incomplete:
 132
 133 * Trees, biomes, generated structures
 134 * NPCs
 135 * Some monsters and animals
 136 * Some redstone-related things
 137 * The Nether
 138 * The End
 139 * Enchanting
 140 * Experience
 141 * Status effects
 142 * Brewing, potions, tipped arrows
 143 * Anvil
 144 * A couple of non-trivial blocks and items
 145
 146 Bonus features (not found in Minecraft 1.11):
 147
 148 * Built-in crafting guide which shows you crafting and smelting recipes
 149 * In-game help system containing extensive help about gameplay basics, blocks, items and more
 150 * 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
 151
 152 Technical differences from Minecraft:
 153
 154 * Height limit of ca. 31000 blocks (much higher than in Minecraft)
 155 * Horizontal world size is ca. 62000×62000 blocks (much smaller than in Minecraft, but it is still very large)
 156 * Still very, very incomplete and buggy
 157 * Blocks, items, enemies and other features are missing
 158 * A few items have slightly different names to make them easier to distinguish
 159 * Different music for jukebox
 160 * Different textures (Pixel Perfection)
 161 * Different sounds (various sources)
 162 * Different engine (Minetest)
 163 * Free software (“free” as in freedom *and* free beer)
 164
 165 ## Reporting bugs
 166 Please report all bugs and missing Minecraft features here:
 167
 168 <https://github.com/Wuzzy2/MineClone2-Bugs>
 169
 170 ## Other readme files
 171
 172 * `LICENSE.txt`: The LGPLv2.1 license text
 173 * `CONTRIBUTING.md`: Information for those who want to contribute
 174 * `MISSING_ENGINE_FEATURES.md`: List of missing features in Minetest which MineClone 2 would need for improvement
 175 * `API.md`: For Minetest modders who want to mod this game
 176
 177 ## Credits
 178 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.
 179
 180 ### Coding
 181 * [Wuzzy](https://forum.minetest.net/memberlist.php?mode=viewprofile&u=3082): Main programmer of most mods
 182 * daredevils: Creator of MineClone on which MineClone 2 is based on
 183 * Lots of other people: TO BE WRITTEN (see mod directories for details)
 184
 185 ### Textures
 186 * [XSSheep](http://www.minecraftforum.net/members/XSSheep): Main author; creator of the Pixel Perfection resource pack of Minecraft 1.11
 187 * [Wuzzy](https://forum.minetest.net/memberlist.php?mode=viewprofile&u=3082): Main menu imagery and various edits and additions of texture pack
 188 * [kingoscargames](https://github.com/kingoscargames): Various edits and additions of existing textures
 189 * [leorockway](https://github.com/leorockway): Some edits of mob textures
 190 * [xMrVizzy](https://minecraft.curseforge.com/members/xMrVizzy): Glazed terracotta (textures are subject to be replaced later)
 191 * Other authors: GUI images,
 192
 193 ### Models
 194 * [22i](https://github.com/22i): Creator of all models
 195 * [tobyplowy](https://github.com/tobyplowy): UV-mapping fixes to said models
 196
 197 ### Sounds and music
 198 Various sources. See the respective mod directories for details.
 199
 200 ### Special thanks
 201
 202 * daredevils for starting MineClone, the original version of this game
 203 * celeron55 for creating Minetest
 204 * Minetest's modding community for providing a huge selection of mods, some of which ended up in MineClone 2
 205 * Jordach for the jukebox music compilation from Big Freaking Dig
 206 * The workaholics who spent way too much time writing for the Minecraft Wiki. It's an invaluable resource for creating this game
 207 * Notch and Jeb for being the major forces behind Minecraft
 208 * XSSheep for creating the Pixel Perfection resource pack
 209 * [22i](https://github.com/22i) for providing great models and support
 210
 211 ## Info for programmers
 212 You find interesting and useful infos in `API.md`.
 213 This project is currently mostly a one-person project.
 214
 215 ## Legal information
 216 This is a fan game, not developed or endorsed by Mojang AB.
 217
 218 Copying is an act of love. Please copy and share! <3
 219 But, oh well, if you insist, here is the legalese for you:
 220
 221 ### License of source code
 222 MineClone 2 is a clean-room implementation of Minecraft
 223 and licensed under the
 224 GNU LGPL v2.1 (Wuzzy, daredevils and countless others) (see `LICENSE.txt`).
 225
 226 MineClone 2 is a direct continuation of the discontinued MineClone
 227 project by daredevils which fell under the same license.
 228
 229 Mods credit:
 230 See `README.txt` or `README.md` in each mod directory for information about other authors.
 231
 232 ### License of media (textures and sounds)
 233 No non-free licenses are used anywhere.
 234
 235 The textures, unless otherwise noted, are based on the Pixel Perfection resource pack for Minecraft 1.11,
 236 authored by XSSheep. Most textures are verbatim copies, while some textures have been changed or redone
 237 from scratch.
 238 Source: <https://www.planetminecraft.com/texture_pack/131pixel-perfection/>
 239 License: [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/)
 240
 241 MineClone 2 is currently in the processs of changing all the textures.
 242 The textures for the glazed terracotta come from Faithful Vanilla.
 243 (authored by Vattic, xMrVizzy and many others).
 244 Source: <https://minecraft.curseforge.com/projects/faithful-vanilla>
 245
 246 License of all main menu images: WTFPL
 247
 248 All other files, unless mentioned otherwise, fall under:
 249 Attribution-ShareAlike 3.0 Unported (CC BY-SA 4.0)
 250 http://creativecommons.org/licenses/by-sa/4.0/
 251
 252 See README.txt in each mod directory for detailed information about other authors.