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