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