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.28.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 * Command Block: `mesecons_commandblock:commandblock_off`
  64 * Monster Spawner: `mcl_mobspawners:spawner`
  65 * Huge mushroom blocks: See `mods/ITEMS/mcl_mushrooms/README.md`
  66 * Minecart with Command Block: `mcl_minecarts:command_block_minecart`
  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 * A few biomes
 108 * The Nether
 109 * Redstone circuits (partially): Redstone ore, redstone, redstone repeater, levers, buttons, redstone blocks, redstone lamps
 110 * Minecarts (partial)
 111 * Boats
 112 * Fire
 113 * Buidling blocks: Stairs, slabs, doors, trapdoors, fences, fence gates, walls
 114 * Clock
 115 * Compass
 116 * Sponge
 117 * Slime block (does not interact with redstone)
 118 * Small plants and saplings
 119 * Dyes
 120 * Banners
 121 * Deco blocks: Glass, stained glass, glass panes, iron bars, hardened clay (and colors), heads and more
 122 * Item frames
 123 * Jukeboxes
 124 * Beds
 125 * Inventory menu
 126 * Creative inventory
 127 * Farming
 128 * Bookshelves (deco only)
 129 * Writable books
 130 * A few server commands
 131 * And more!
 132
 133 The following features are incomplete:
 134
 135 * Trees, biomes, generated structures
 136 * NPCs
 137 * Some monsters and animals
 138 * Some redstone-related things
 139 * The End
 140 * Enchanting
 141 * Experience
 142 * Status effects
 143 * Brewing, potions, tipped arrows
 144 * Anvil
 145 * A couple of non-trivial blocks and items
 146
 147 Bonus features (not found in Minecraft 1.11):
 148
 149 * Built-in crafting guide which shows you crafting and smelting recipes
 150 * In-game help system containing extensive help about gameplay basics, blocks, items and more
 151 * 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
 152
 153 Technical differences from Minecraft:
 154
 155 * Height limit of ca. 31000 blocks (much higher than in Minecraft)
 156 * Horizontal world size is ca. 62000×62000 blocks (much smaller than in Minecraft, but it is still very large)
 157 * Still very, very incomplete and buggy
 158 * Blocks, items, enemies and other features are missing
 159 * A few items have slightly different names to make them easier to distinguish
 160 * Different music for jukebox
 161 * Different textures (Pixel Perfection)
 162 * Different sounds (various sources)
 163 * Different engine (Minetest)
 164 * Free software (“free” as in freedom *and* free beer)
 165
 166 ## Reporting bugs
 167 Please report all bugs and missing Minecraft features here:
 168
 169 <https://github.com/Wuzzy2/MineClone2-Bugs>
 170
 171 ## Other readme files
 172
 173 * `LICENSE.txt`: The LGPLv2.1 license text
 174 * `CONTRIBUTING.md`: Information for those who want to contribute
 175 * `MISSING_ENGINE_FEATURES.md`: List of missing features in Minetest which MineClone 2 would need for improvement
 176 * `API.md`: For Minetest modders who want to mod this game
 177
 178 ## Credits
 179 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.
 180
 181 ### Coding
 182 * [Wuzzy](https://forum.minetest.net/memberlist.php?mode=viewprofile&u=3082): Main programmer of most mods
 183 * daredevils: Creator of MineClone on which MineClone 2 is based on
 184 * [ex-bart](https://github.com/ex-bart): Redstone comparators
 185 * Lots of other people: TO BE WRITTEN (see mod directories for details)
 186
 187 ### Textures
 188 * [XSSheep](http://www.minecraftforum.net/members/XSSheep): Main author; creator of the Pixel Perfection resource pack of Minecraft 1.11
 189 * [Wuzzy](https://forum.minetest.net/memberlist.php?mode=viewprofile&u=3082): Main menu imagery and various edits and additions of texture pack
 190 * [kingoscargames](https://github.com/kingoscargames): Various edits and additions of existing textures
 191 * [leorockway](https://github.com/leorockway): Some edits of mob textures
 192 * [xMrVizzy](https://minecraft.curseforge.com/members/xMrVizzy): Glazed terracotta (textures are subject to be replaced later)
 193 * Other authors: GUI images,
 194
 195 ### Models
 196 * [22i](https://github.com/22i): Creator of all models
 197 * [tobyplowy](https://github.com/tobyplowy): UV-mapping fixes to said models
 198
 199 ### Sounds and music
 200 Various sources. See the respective mod directories for details.
 201
 202 ### Special thanks
 203
 204 * daredevils for starting MineClone, the original version of this game
 205 * celeron55 for creating Minetest
 206 * Minetest's modding community for providing a huge selection of mods, some of which ended up in MineClone 2
 207 * Jordach for the jukebox music compilation from Big Freaking Dig
 208 * The workaholics who spent way too much time writing for the Minecraft Wiki. It's an invaluable resource for creating this game
 209 * Notch and Jeb for being the major forces behind Minecraft
 210 * XSSheep for creating the Pixel Perfection resource pack
 211 * [22i](https://github.com/22i) for providing great models and support
 212 * [maikerumine](http://github.com/maikerumine) for kicking off mobs and biomes
 213
 214 ## Info for programmers
 215 You find interesting and useful infos in `API.md`.
 216 This project is currently mostly a one-person project.
 217
 218 ## Legal information
 219 This is a fan game, not developed or endorsed by Mojang AB.
 220
 221 Copying is an act of love. Please copy and share! <3
 222 But, oh well, if you insist, here is the legalese for you:
 223
 224 ### License of source code
 225 MineClone 2 is a clean-room implementation of Minecraft
 226 and licensed under the
 227 GNU LGPL v2.1 (Wuzzy, daredevils and countless others) (see `LICENSE.txt`).
 228
 229 MineClone 2 is a direct continuation of the discontinued MineClone
 230 project by daredevils which fell under the same license.
 231
 232 Mods credit:
 233 See `README.txt` or `README.md` in each mod directory for information about other authors.
 234
 235 ### License of media (textures and sounds)
 236 No non-free licenses are used anywhere.
 237
 238 The textures, unless otherwise noted, are based on the Pixel Perfection resource pack for Minecraft 1.11,
 239 authored by XSSheep. Most textures are verbatim copies, while some textures have been changed or redone
 240 from scratch.
 241 Source: <https://www.planetminecraft.com/texture_pack/131pixel-perfection/>
 242 License: [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/)
 243
 244 MineClone 2 is currently in the processs of changing all the textures.
 245 The textures for the glazed terracotta come from Faithful Vanilla.
 246 (authored by Vattic, xMrVizzy and many others).
 247 Source: <https://minecraft.curseforge.com/projects/faithful-vanilla>
 248
 249 License of all main menu images: WTFPL
 250
 251 All other files, unless mentioned otherwise, fall under:
 252 Attribution-ShareAlike 3.0 Unported (CC BY-SA 4.0)
 253 http://creativecommons.org/licenses/by-sa/4.0/
 254
 255 See README.txt in each mod directory for detailed information about other authors.