README.md

   1 # DRAGONBLOCKS BEDROCK EDITION
   2 Written in C++
   3 An Open Source Project by Elias Fleckenstein
   4 ## General
   5 ### What this is about
   6 Dragonblocks originaly was a Browsergame I made that should be some kind of 2D Minetest (Minetest (www.minetest.net) is a game similar to Minecraft, except Minetest is free & open source and is meant to be modded). The JavaScript Edition is hosted at www.elidragon.com/projects/Dragonblocks and further developed then this C++ Version, through the C++ Version has advantages like map saving and lot larger map. I decided to call the C++ Version "Bedrock Edition" as a joke for the Minecraft C++ Version is Called Bedrock or Pocket Edition.
   7 ### Version
   8 This is the Dragonblocks Bedrock Edition 3.1.
   9 ### Bugs
  10 Please Report Bugs to eliasfleckenstein@web.de.
  11 ### License
  12                 Copyright 2020 Elias Fleckenstein <eliasfleckenstein@web.de>
  13
  14                 This program is free software; you can redistribute it and/or modify
  15                 it under the terms of the GNU General Public License as published by
  16                 the Free Software Foundation; either version 3 of the License, or
  17                 (at your option) any later version.
  18
  19                 This program is distributed in the hope that it will be useful,
  20                 but WITHOUT ANY WARRANTY; without even the implied warranty of
  21                 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22                 GNU General Public License for more details.
  23
  24                 You should have received a copy of the GNU General Public License
  25                 along with this program; if not, write to the Free Software
  26                 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  27                 MA 02110-1301, USA.
  28 ## Starting the Game
  29 ### Platform Compability
  30 This Game was developed on linux, therefore following instructions are only for linux users, basically because I have no idea how to port the game to other platforms. Feel free to add building instructions for other systems over github.
  31 ### Download
  32 You can download the game using git:
  33 `$ git clone https://github.com/EliasFleckenstein03/dragonblocks.git`
  34 ### Dependencies:
  35 You need Freeglut, OpenGl, Cmake, Liblua and Libpng.
  36 If you are on Debian/Ubuntu You can install them over apt:
  37 `$ sudo apt install liblua5.3-dev freeglut3-dev libgl1-mesa-dev cmake libpng-dev`
  38 ### Building
  39 to Build dragonblocks run:
  40 `$ cmake .`
  41 `$ make`
  42 ### Exectute
  43 #### Run-In-Place
  44 Invoke dragonblocks by typing:
  45 `$ bin/dragonblocks --worldname <your_worldname>`
  46 To see a list of worlds do:
  47 `$ bin/dragonblocks --worldlist`
  48 You can select a world from this list or create a new one.
  49 For more info run:
  50 `$ bin/dragonblocks --help`
  51 #### Installation
  52 You can install dragonblocks by doing:
  53 `$ sudo ./install.sh`