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