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