README.md

   1 # DRAGONBLOCKS BEDROCK EDITION
   2 An Open Source Project by Elias Fleckenstein
   3 ## General
   4 ### What this is about
   5 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.
   6 ### Version
   7 This is the Dragonblocks Bedrock Edition 3.1.
   8 ### Bugs
   9 Please Report Bugs to eliasfleckenstein@web.de.
  10 ### License
  11                 Copyright 2020 Elias Fleckenstein <eliasfleckenstein@web.de>
  12
  13                 This program is free software; you can redistribute it and/or modify
  14                 it under the terms of the GNU General Public License as published by
  15                 the Free Software Foundation; either version 3 of the License, or
  16                 (at your option) any later version.
  17
  18                 This program is distributed in the hope that it will be useful,
  19                 but WITHOUT ANY WARRANTY; without even the implied warranty of
  20                 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21                 GNU General Public License for more details.
  22
  23                 You should have received a copy of the GNU General Public License
  24                 along with this program; if not, write to the Free Software
  25                 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  26                 MA 02110-1301, USA.
  27 ## Starting the Game
  28 ### Platform Compability
  29 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.
  30 ### Download
  31 You can download the game using git:
  32 `$ git clone https://github.com/EliasFleckenstein03/dragonblocks.git`
  33 ### Dependencies:
  34 You need Freeglut, OpenGl, Cmake, Liblua and Libpng. If you are on Debian/Ubuntu You can install them over apt:
  35 `$ sudo apt install liblua5.3-dev freeglut3-dev libgl1-mesa-dev cmake libpng-dev`
  36 ### Building
  37 to Build dragonblocks run:
  38 `$ cmake .`
  39 `$ make`
  40 ### Exectute
  41 #### Run-In-Place
  42 Invoke dragonblocks by typing:
  43 `$ bin/dragonblocks --worldname <your_worldname>`
  44 To see a list of worlds do:
  45 `$ bin/dragonblocks --worldlist`
  46 You can select a world from this list or create a new one.
  47 For more info run:
  48 `$ bin/dragonblocks --help`
  49 #### Installation
  50 You can install dragonblocks by doing:
  51 `$ sudo ./install.sh`