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.34.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 * **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 * Minecart with Command Block (does not work yet): `mcl_minecarts:command_block_minecart`
  64
  65 Use the `/giveme` chat command to obtain them. See the in-game help for
  66 an explanation.
  67
  68 ## Installation
  69 This game requires [Minetest](http://minetest.net) 0.4.16 (or later) to run,
  70 so you need to install Minetest first. Only stable versions of Minetest are
  71 officially supported. There is no support whatsoever for running MineClone 2
  72 in development versions of Minetest.
  73 To install MineClone 2, move this directory into the “games” directory of
  74 your Minetest data directory. Consult the help of Minetest to learn more.
  75
  76 ## Project description
  77 The main goal of **MineClone 2** is to be a clone of Minecraft and to be released as free software.
  78
  79 * **Target of development: Minecraft, PC Edition, version 1.11** (later known as “Java Edition”)
  80 * Features of later Minecraft versions might sneak in, but they have a low priority
  81 * In general, Minecraft is aimed to be cloned as good as Minetest currently permits (no hacks)
  82 * Cloning the gameplay has highest priority
  83 * MineClone 2 will use different graphics and sounds, but with a similar style
  84 * Cloning the interface has no priority. It will only be roughly imitated
  85 * Limitations found in Minetest will be written down and reported in the course of development
  86
  87 ## Completion status
  88 This game is currently in **alpha** stage.
  89 It is playable, but very unfinished, many bugs are to be expected.
  90 Backwards-compability is *not* guaranteed, updating your world might cause small and
  91 big bugs (such as “missing node” errors or even crashes).
  92
  93 The following main features are available:
  94
  95 * Tools, weapons and armor
  96 * Crafting system: 2×2 grid, crafting table (3×3 grid), furnace, including a crafting guide
  97 * Chests, large chests, ender chests, shulker boxes
  98 * Hunger
  99 * Most monsters and animals
 100 * All ores from Minecraft
 101 * Most blocks in the overworld
 102 * Water and lava
 103 * Weather
 104 * 28 biomes
 105 * The Nether, a fiery underworld in another dimension
 106 * Redstone circuits (partially): Redstone ore, redstone, redstone repeater, levers, buttons, redstone blocks, redstone lamps
 107 * Minecarts (partial)
 108 * Boats
 109 * Fire
 110 * Buidling blocks: Stairs, slabs, doors, trapdoors, fences, fence gates, walls
 111 * Clock
 112 * Compass
 113 * Sponge
 114 * Slime block (does not interact with redstone)
 115 * Small plants and saplings
 116 * Dyes
 117 * Banners
 118 * Deco blocks: Glass, stained glass, glass panes, iron bars, hardened clay (and colors), heads and more
 119 * Item frames
 120 * Jukeboxes
 121 * Beds
 122 * Inventory menu
 123 * Creative inventory
 124 * Farming
 125 * Bookshelves (deco only)
 126 * Writable books
 127 * A few server commands
 128 * And more!
 129
 130 The following features are incomplete:
 131
 132 * Generated structures
 133 * NPCs
 134 * Some monsters and animals
 135 * Redstone-related things
 136 * The End
 137 * Enchanting
 138 * Experience
 139 * Status effects
 140 * Brewing, potions, tipped arrows
 141 * Anvil
 142 * A couple of non-trivial blocks and items
 143
 144 Bonus features (not found in Minecraft 1.11):
 145
 146 * Built-in crafting guide which shows you crafting and smelting recipes
 147 * In-game help system containing extensive help about gameplay basics, blocks, items and more
 148 * 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
 149 * Saplings in chests (only in mapgen v6, because only 3 out of 6 tree species grow here)
 150 * New blocks:
 151     * Nether Brick Fence Gate
 152     * Red Nether Brick Fence
 153     * Red Nether Brick Fence Gate
 154     * More slabs and stairs
 155
 156 Technical differences from Minecraft:
 157
 158 * Height limit of ca. 31000 blocks (much higher than in Minecraft)
 159 * Horizontal world size is ca. 62000×62000 blocks (much smaller than in Minecraft, but it is still very large)
 160 * Still very, very incomplete and buggy
 161 * Blocks, items, enemies and other features are missing
 162 * A few items have slightly different names to make them easier to distinguish
 163 * Different music for jukebox
 164 * Different textures (Pixel Perfection)
 165 * Different sounds (various sources)
 166 * Different engine (Minetest)
 167 * Free software (“free” as in freedom)
 168
 169 ## Reporting bugs
 170 Please report all bugs and missing Minecraft features here:
 171
 172 <https://github.com/Wuzzy2/MineClone2-Bugs>
 173
 174 ## Other readme files
 175
 176 * `LICENSE.txt`: The LGPLv2.1 license text
 177 * `CONTRIBUTING.md`: Information for those who want to contribute
 178 * `MISSING_ENGINE_FEATURES.md`: List of missing features in Minetest which MineClone 2 would need for improvement
 179 * `API.md`: For Minetest modders who want to mod this game
 180
 181 ## Credits
 182 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.
 183
 184 ### Coding
 185 * [Wuzzy](https://forum.minetest.net/memberlist.php?mode=viewprofile&u=3082): Main programmer of most mods
 186 * daredevils: Creator of MineClone on which MineClone 2 is based on
 187 * [ex-bart](https://github.com/ex-bart): Redstone comparators
 188 * Lots of other people: TO BE WRITTEN (see mod directories for details)
 189
 190 ### Textures
 191 * [XSSheep](http://www.minecraftforum.net/members/XSSheep): Main author; creator of the Pixel Perfection resource pack of Minecraft 1.11
 192 * [Wuzzy](https://forum.minetest.net/memberlist.php?mode=viewprofile&u=3082): Main menu imagery and various edits and additions of texture pack
 193 * [kingoscargames](https://github.com/kingoscargames): Various edits and additions of existing textures
 194 * [leorockway](https://github.com/leorockway): Some edits of mob textures
 195 * [xMrVizzy](https://minecraft.curseforge.com/members/xMrVizzy): Glazed terracotta (textures are subject to be replaced later)
 196 * Other authors: GUI images,
 197
 198 ### Models
 199 * [22i](https://github.com/22i): Creator of all models
 200 * [tobyplowy](https://github.com/tobyplowy): UV-mapping fixes to said models
 201
 202 ### Sounds and music
 203 Various sources. See the respective mod directories for details.
 204
 205 ### Special thanks
 206
 207 * daredevils for starting MineClone, the original version of this game
 208 * celeron55 for creating Minetest
 209 * Minetest's modding community for providing a huge selection of mods, some of which ended up in MineClone 2
 210 * Jordach for the jukebox music compilation from Big Freaking Dig
 211 * The workaholics who spent way too much time writing for the Minecraft Wiki. It's an invaluable resource for creating this game
 212 * Notch and Jeb for being the major forces behind Minecraft
 213 * XSSheep for creating the Pixel Perfection resource pack
 214 * [22i](https://github.com/22i) for providing great models and support
 215 * [maikerumine](http://github.com/maikerumine) for kicking off mobs and biomes
 216
 217 ## Info for programmers
 218 You find interesting and useful infos in `API.md`.
 219 This project is currently mostly a one-person project.
 220
 221 ## Legal information
 222 This is a fan game, not developed or endorsed by Mojang AB.
 223
 224 Copying is an act of love. Please copy and share! <3
 225 But, oh well, if you insist, here is the legalese for you:
 226
 227 ### License of source code
 228 MineClone 2 is a clean-room implementation of Minecraft
 229 and licensed under the
 230 GNU LGPL v2.1 (Wuzzy, daredevils and countless others) (see `LICENSE.txt`).
 231
 232 MineClone 2 is a direct continuation of the discontinued MineClone
 233 project by daredevils which fell under the same license.
 234
 235 Mods credit:
 236 See `README.txt` or `README.md` in each mod directory for information about other authors.
 237
 238 ### License of media (textures and sounds)
 239 No non-free licenses are used anywhere.
 240
 241 The textures, unless otherwise noted, are based on the Pixel Perfection resource pack for Minecraft 1.11,
 242 authored by XSSheep. Most textures are verbatim copies, while some textures have been changed or redone
 243 from scratch.
 244 The glazed terracotta textures have been created by (MysticTempest)[https://github.com/MysticTempest].
 245 Source: <https://www.planetminecraft.com/texture_pack/131pixel-perfection/>
 246 License: [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/)
 247
 248 The main menu images are release under: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
 249
 250 All other files, unless mentioned otherwise, fall under:
 251 Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 4.0)
 252 http://creativecommons.org/licenses/by-sa/4.0/
 253
 254 See README.txt in each mod directory for detailed information about other authors.