README.md

   1 # MineClone 2
   2 An unofficial Minecraft-like game for Minetest. Forked from MineClone by davedevils.
   3 Developed by Wuzzy and contributors. Not developed or endorsed by Mojang AB.
   4
   5 Version: 0.67.2
   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 * **Punch a tree** trunk until it breaks and collect wood
  31 * Place the **wood into the 2×2 grid** (your “crafting grid” in your inventory menu and craft 4 wood planks
  32 * Place the 4 wood planks in a 2×2 shape in the crafting grid to **make a crafting table**
  33 * **Rightclick the crafting table** for a 3×3 crafting grid to craft more complex things
  34 * Use the **crafting guide** (book icon) to learn all the possible crafting recipes
  35 * **Craft a wooden pickaxe** so you can dig stone
  36 * Different tools break different kinds of blocks. Try them out!
  37 * Continue playing as you wish. Have fun!
  38
  39 ### Farming
  40 * Find seeds
  41 * Craft hoe
  42 * Rightclick dirt or similar block with hoe to create farmland
  43 * Place seeds on farmland and watch them grow
  44 * Collect plant when fully grown
  45 * If near water, farmland becomes wet and speeds up growth
  46
  47 ### Furnace
  48 * Craft furnace
  49 * Furnace allows you to obtain more items
  50 * Upper slot must contain a smeltable item (example: iron ore)
  51 * Lower slot must contain a fuel item (example: coal)
  52 * See tooltips in crafting guide to learn about fuels and smeltable items
  53
  54 ### Additional help
  55 More help about the gameplay, blocks items and much more can be found from inside
  56 the game. You can access the help from your inventory menu.
  57
  58 ### Special items
  59 The following items are interesting for Creative Mode and for adventure
  60 map builders. They can not be obtained in-game or in the creative inventory.
  61
  62 * Barrier: `mcl_core:barrier`
  63
  64 Use the `/giveme` chat command to obtain them. See the in-game help for
  65 an explanation.
  66
  67 #### Incomplete items
  68 These items do not work yet, but you can get them with `/giveme` for testing:
  69
  70 * Minecart with Chest: `mcl_minecarts:chest_minecart`
  71 * Minecart with Furnace: `mcl_minecarts:furnace_minecart`
  72 * Minecart with Hopper: `mcl_minecarts:hopper_minecart`
  73 * Minecart with Command Block: `mcl_minecarts:command_block_minecart`
  74
  75 ## Installation
  76 This game requires [Minetest](http://minetest.net) to run (version 5.0.0 or
  77 later). So you need to install Minetest first. Only stable versions of Minetest
  78 are officially supported.
  79 There is no support for running MineClone 2 in development versions of Minetest.
  80
  81 To install MineClone 2 (if you haven't already), move this directory into the
  82 “games” directory of your Minetest data directory. Consult the help of
  83 Minetest to learn more.
  84
  85 ## Project description
  86 The main goal of **MineClone 2** is to be a clone of Minecraft and to be released as free software.
  87
  88 * **Target of development: Minecraft, PC Edition, version 1.11** (later known as “Java Edition”)
  89 * Features of later Minecraft versions might sneak in, but they have a low priority
  90 * In general, Minecraft is aimed to be cloned as good as Minetest currently permits (no hacks)
  91 * Cloning the gameplay has highest priority
  92 * MineClone 2 will use different graphics and sounds, but with a similar style
  93 * Cloning the interface has no priority. It will only be roughly imitated
  94 * Limitations found in Minetest will be written down and reported in the course of development
  95
  96 ## Completion status
  97 This game is currently in **alpha** stage.
  98 It is playable, but unfinished, many bugs are to be expected.
  99 Backwards-compability is *not* guaranteed, updating your world might cause small and
 100 big bugs (such as “missing node” errors or even crashes).
 101
 102 The following main features are available:
 103
 104 * Tools, weapons
 105 * Armor (unbalanced)
 106 * Crafting system: 2×2 grid, crafting table (3×3 grid), furnace, including a crafting guide
 107 * Chests, large chests, ender chests, shulker boxes
 108 * Furnaces, hoppers
 109 * Hunger
 110 * Most monsters and animals
 111 * All ores from Minecraft
 112 * Most blocks in the overworld
 113 * Water and lava
 114 * Weather
 115 * 28 biomes
 116 * The Nether, a fiery underworld in another dimension
 117 * Redstone circuits (partially)
 118 * Minecarts (partial)
 119 * Status effects (partial)
 120 * Brewing, potions, tipped arrow (partial)
 121 * Boats
 122 * Fire
 123 * Buidling blocks: Stairs, slabs, doors, trapdoors, fences, fence gates, walls
 124 * Clock
 125 * Compass
 126 * Sponge
 127 * Slime block (does not interact with redstone)
 128 * Small plants and saplings
 129 * Dyes
 130 * Banners
 131 * Deco blocks: Glass, stained glass, glass panes, iron bars, hardened clay (and colors), heads and more
 132 * Item frames
 133 * Jukeboxes
 134 * Beds
 135 * Inventory menu
 136 * Creative inventory
 137 * Farming
 138 * Writable books
 139 * A few server commands
 140 * And more!
 141
 142 The following features are incomplete:
 143
 144 * Generated structures (especially villages)
 145 * NPCs
 146 * Some monsters and animals
 147 * Redstone-related things
 148 * The End
 149 * Enchanting
 150 * Experience
 151 * Special minecarts
 152 * A couple of non-trivial blocks and items
 153
 154 Bonus features (not found in Minecraft 1.11):
 155
 156 * Built-in crafting guide which shows you crafting and smelting recipes
 157 * In-game help system containing extensive help about gameplay basics, blocks, items and more
 158 * 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
 159 * Saplings in chests in mapgen v6
 160 * Fully moddable (thanks to Minetest's powerful Lua API)
 161 * New blocks and items:
 162     * Lookup tool, shows you the help for whatever it touches
 163     * More slabs and stairs
 164     * Nether Brick Fence Gate
 165     * Red Nether Brick Fence
 166     * Red Nether Brick Fence Gate
 167
 168 Technical differences from Minecraft:
 169
 170 * Height limit of ca. 31000 blocks (much higher than in Minecraft)
 171 * Horizontal world size is ca. 62000×62000 blocks (much smaller than in Minecraft, but it is still very large)
 172 * Still very incomplete and buggy
 173 * Blocks, items, enemies and other features are missing
 174 * A few items have slightly different names to make them easier to distinguish
 175 * Different music for jukebox
 176 * Different textures (Pixel Perfection)
 177 * Different sounds (various sources)
 178 * Different engine (Minetest)
 179
 180 … and finally, MineClone 2 is free software (“free” as in “freedom”)!
 181
 182 ## Reporting bugs
 183 Please report all bugs and missing Minecraft features here:
 184
 185 <https://git.minetest.land/Wuzzy/MineClone2/issues>
 186
 187 ## Other readme files
 188
 189 * `LICENSE.txt`: The GPLv3 license text
 190 * `CONTRIBUTING.md`: Information for those who want to contribute
 191 * `MISSING_ENGINE_FEATURES.md`: List of missing features in Minetest which MineClone 2 would need for improvement
 192 * `API.md`: For Minetest modders who want to mod this game
 193
 194 ## Credits
 195 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.
 196
 197 ### Coding
 198 * [Wuzzy](https://forum.minetest.net/memberlist.php?mode=viewprofile&u=3082): Main programmer of most mods
 199 * davedevils: Creator of MineClone on which MineClone 2 is based on
 200 * [ex-bart](https://github.com/ex-bart): Redstone comparators
 201 * [Rootyjr](https://github.com/Rootyjr): Fishing rod and bugfixes
 202 * [aligator](https://github.com/aligator): Improvement of doors
 203 * [ryvnf](https://github.com/ryvnf): Explosion mechanics
 204 * MysticTempest: Bugfixes
 205 * [bzoss](https://github.com/bzoss): Status effects, potions, brewing stand
 206 * kay27 <kay27@bk.ru>: Bugfixes, optimizations
 207 * Lots of other people: TO BE WRITTEN (see mod directories for details)
 208
 209 #### Mod credits (summary)
 210
 211 * `controls`: Arcelmi
 212 * `flowlib`: Qwertymine13
 213 * `walkover`: lordfingle
 214 * `drippingwater`: kddekadenz
 215 * `mobs_mc`: maikerumine, 22i and others
 216 * `awards`: rubenwardy
 217 * `screwdriver`: RealBadAngel, Maciej Kastakin, Minetest contributors
 218 * `xpanes`: Minetest contributors
 219 * `mesecons` mods: Jeija and contributors
 220 * `wieldview`: Stuart Jones
 221 * `mcl_meshhand`: Based on `newhand` by jordan4ibanez
 222 * `mcl_mobs`: Based on Mobs Redo [`mobs`] by TenPlus1 and contributors
 223 * Most other mods: Wuzzy
 224
 225 Detailed credits for each mod can be found in the individual mod directories.
 226
 227 ### Graphics
 228 * [XSSheep](http://www.minecraftforum.net/members/XSSheep): Main author; creator of the Pixel Perfection resource pack of Minecraft 1.11
 229 * [Wuzzy](https://forum.minetest.net/memberlist.php?mode=viewprofile&u=3082): Main menu imagery and various edits and additions of texture pack
 230 * [kingoscargames](https://github.com/kingoscargames): Various edits and additions of existing textures
 231 * [leorockway](https://github.com/leorockway): Some edits of mob textures
 232 * [xMrVizzy](https://minecraft.curseforge.com/members/xMrVizzy): Glazed terracotta (textures are subject to be replaced later)
 233 * yutyo <tanakinci2002@gmail.com>: MineClone 2 logo
 234 * Other authors: GUI images
 235
 236 ### Translations
 237 * Wuzzy: German
 238 * Rocher Laurent <rocherl@club-internet.fr>: French
 239 * wuniversales: Spanish
 240 * kay27 <kay27@bk.ru>: Russian
 241
 242 ### Models
 243 * [22i](https://github.com/22i): Creator of all models
 244 * [tobyplowy](https://github.com/tobyplowy): UV-mapping fixes to said models
 245
 246 ### Sounds and music
 247 Various sources. See the respective mod directories for details.
 248
 249 ### Special thanks
 250
 251 * davedevils for starting MineClone, the original version of this game
 252 * celeron55 for creating Minetest
 253 * Minetest's modding community for providing a huge selection of mods, some of which ended up in MineClone 2
 254 * Jordach for the jukebox music compilation from Big Freaking Dig
 255 * The workaholics who spent way too much time writing for the Minecraft Wiki. It's an invaluable resource for creating this game
 256 * Notch and Jeb for being the major forces behind Minecraft
 257 * XSSheep for creating the Pixel Perfection resource pack
 258 * [22i](https://github.com/22i) for providing great models and support
 259 * [maikerumine](http://github.com/maikerumine) for kicking off mobs and biomes
 260
 261 ## Info for programmers
 262 You find interesting and useful infos in `API.md`.
 263 This project is currently mostly a one-person project.
 264
 265 ## Legal information
 266 This is a fan game, not developed or endorsed by Mojang AB.
 267
 268 Copying is an act of love. Please copy and share! <3
 269 Here's the detailed legalese for those who need it:
 270
 271 ### License of source code
 272 MineClone 2 (by Wuzzy, davedevils and countless others)
 273 is an imitation of Minecraft.
 274
 275 MineClone 2 is free software: you can redistribute it and/or modify
 276 it under the terms of the GNU General Public License as published by
 277 the Free Software Foundation, either version 3 of the License, or
 278 (at your option) any later version.
 279
 280 This program is distributed in the hope that it will be useful,
 281 but WITHOUT ANY WARRANTY; without even the implied warranty of
 282 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 283 GNU General Public License (in the LICENSE.txt file) for more
 284 details.
 285
 286 In the mods you might find in the read-me or license
 287 text files a different license. This counts as dual-licensing.
 288 You can choose which license applies to you: Either the
 289 license of MineClone 2 (GNU GPLv3) or the mod's license.
 290
 291 MineClone 2 is a direct continuation of the discontinued MineClone
 292 project by davedevils.
 293
 294 Mod credits:
 295 See `README.txt` or `README.md` in each mod directory for information about other authors.
 296 For mods that do not have such a file, the license is the source code license
 297 of MineClone 2 and the author is Wuzzy.
 298
 299 ### License of media (textures and sounds)
 300 No non-free licenses are used anywhere.
 301
 302 The textures, unless otherwise noted, are based on the Pixel Perfection resource pack for Minecraft 1.11,
 303 authored by XSSheep. Most textures are verbatim copies, while some textures have been changed or redone
 304 from scratch.
 305 The glazed terracotta textures have been created by (MysticTempest)[https://github.com/MysticTempest].
 306 Source: <https://www.planetminecraft.com/texture_pack/131pixel-perfection/>
 307 License: [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/)
 308
 309 The main menu images are release under: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
 310
 311 All other files, unless mentioned otherwise, fall under:
 312 Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
 313 http://creativecommons.org/licenses/by-sa/3.0/
 314
 315 See README.txt in each mod directory for detailed information about other authors.