doc/README.txt

   1 Minetest-c55
   2 ---------------
   3 An InfiniMiner/Minecraft inspired game.
   4 Copyright (c) 2010-2011 Perttu Ahola <celeron55@gmail.com>
   5
   6 This is a development version:
   7 ------------------------------
   8 - Don't expect it to work as well as a finished game will.
   9 - Please report any bugs to me. That way I can fix them to the next release.
  10         - debug.txt is useful when the game crashes.
  11
  12 Controls:
  13 ---------
  14 - See the in-game pause menu
  15
  16 Map directory:
  17 --------------
  18 - Map is stored in a directory, which can be removed to generate a new map.
  19 - There is a command-line option for it: --map-dir
  20 - For a RUN_IN_PLACE build, it is located in:
  21                 ../map
  22 - Otherwise something like this:
  23         Windows: C:\Documents and Settings\user\Application Data\minetest\map
  24         Linux: ~/.minetest/map
  25         OS X: ~/Library/Application Support/minetest/map
  26
  27 Configuration file:
  28 -------------------
  29 - An optional configuration file can be used. See minetest.conf.example.
  30 - Path to file can be passed as a parameter to the executable:
  31         --config <path-to-file>
  32 - Defaults:
  33         - If built with -DRUN_IN_PLACE=1:
  34                 ../minetest.conf
  35                 ../../minetest.conf
  36         - Otherwise something like this:
  37                 Windows: C:\Documents and Settings\user\Application Data\minetest\minetest.conf
  38                 Linux: ~/.minetest/minetest.conf
  39                 OS X: ~/Library/Application Support/minetest.conf
  40
  41 Command-line options:
  42 ---------------------
  43 - Use --help
  44
  45 Compiling on GNU/Linux:
  46 -----------------------
  47
  48 Install dependencies. Here's an example for Debian/Ubuntu:
  49 $ apt-get install build-essential libirrlicht-dev cmake libbz2-dev libpng12-dev libjpeg8-dev libxxf86vm-dev libgl1-mesa-dev
  50
  51 Download source, extract (this is the URL to the latest of source repository, which might not work at all times):
  52 $ wget https://bitbucket.org/celeron55/minetest/get/tip.tar.gz
  53 $ tar xf tip.tar.gz
  54 $ cd minetest
  55
  56 Build a version that runs directly from the source directory:
  57 $ cmake . -DRUN_IN_PLACE=1
  58 $ make -j2
  59
  60 Run it:
  61 $ cd bin
  62 $ ./minetest
  63
  64 - Use cmake . -LH to see all CMake options and their current state
  65 - If you want to install it system-wide (or are making a distribution package), you will want to use -DRUN_IN_PLACE=0
  66 - You can build a bare server or a bare client by specifying -DBUILD_CLIENT=0 or -DBUILD_SERVER=0
  67 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
  68   - Note that the Debug build is considerably slower
  69
  70 Compiling on Windows:
  71 ---------------------
  72
  73 - You need:
  74         * CMake:
  75                 http://www.cmake.org/cmake/resources/software.html
  76         * MinGW or Visual Studio
  77                 http://www.mingw.org/
  78                 http://msdn.microsoft.com/en-us/vstudio/default
  79         * Irrlicht SDK 1.7:
  80                 http://irrlicht.sourceforge.net/downloads.html
  81         * Zlib headers (zlib125.zip)
  82                 http://www.winimage.com/zLibDll/index.html
  83         * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
  84                 http://www.winimage.com/zLibDll/index.html
  85         * And, of course, Minetest-c55:
  86                 http://celeron.55.lt/~celeron55/minetest/download
  87 - Steps:
  88         - Select a directory called DIR hereafter in which you will operate.
  89         - Make sure you have CMake and a compiler installed.
  90         - Download all the other stuff to DIR and extract them into there. All those
  91           packages contain a nice base directory in them, which should end up being
  92           the direct subdirectories of DIR.
  93         - You will end up with a directory structure like this (+=dir, -=file):
  94         -----------------
  95         + DIR
  96                 - zlib-1.2.5.tar.gz
  97                 - zlib125dll.zip
  98                 - irrlicht-1.7.1.zip
  99                 - 110214175330.zip (or whatever, this is the minetest source)
 100                 + zlib-1.2.5
 101                         - zlib.h
 102                         + win32
 103                         ...
 104                 + zlib125dll
 105                         - readme.txt
 106                         + dll32
 107                         ...
 108                 + irrlicht-1.7.1
 109                         + lib
 110                         + include
 111                         ...
 112                 + minetest
 113                         + src
 114                         + doc
 115                         - CMakeLists.txt
 116                         ...
 117         -----------------
 118         - Start up the CMake GUI
 119         - Select "Browse Source..." and select DIR/minetest
 120         - Now, if using MSVC:
 121                 - Select "Browse Build..." and select DIR/minetest-build
 122         - Else if using MinGW:
 123                 - Select "Browse Build..." and select DIR/minetest
 124         - Select "Configure"
 125         - Select your compiler
 126         - It will warn about missing stuff, ignore that at this point. (later don't)
 127         - Make sure the configuration is as follows
 128           (note that the versions may differ for you):
 129         -----------------
 130         BUILD_CLIENT             [X]
 131         BUILD_SERVER             [ ]
 132         CMAKE_BUILD_TYPE         Release
 133         CMAKE_INSTALL_PREFIX     DIR/minetest-install
 134         IRRLICHT_SOURCE_DIR      DIR/irrlicht-1.7.1
 135         RUN_IN_PLACE             [X]
 136         WARN_ALL                 [ ]
 137         ZLIB_DLL                 DIR/zlib125dll/dll32/zlibwapi.dll
 138         ZLIB_INCLUDE_DIR         DIR/zlib-1.2.5
 139         ZLIB_LIBRARIES           DIR/zlib125dll/dll32/zlibwapi.lib
 140         -----------------
 141         - Hit "Configure"
 142         - Hit "Generate"
 143         If using MSVC:
 144                 - Open the generated minetest.sln
 145                 - The project defaults to the "Debug" configuration. Make very sure to
 146                   select "Release", unless you like to have a very glitchy gaming
 147                   experience.
 148                 - Build the ALL_BUILD project
 149                 - Build the INSTALL project
 150                 - You should now have a working game with the executable in
 151                         DIR/minetest-install/bin/minetest.exe
 152                 - Additionally you may create a zip package by building the PACKAGE
 153                   project.
 154         If using MinGW:
 155                 - Using the command line, browse to the build directory and run 'make'
 156                 - You should now have a working game with the executable in
 157                         DIR/minetest/bin/minetest.exe
 158
 159 License of Minetest-c55
 160 -----------------------
 161
 162 Minetest-c55
 163 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
 164
 165 This program is free software; you can redistribute it and/or modify
 166 it under the terms of the GNU General Public License as published by
 167 the Free Software Foundation; either version 2 of the License, or
 168 (at your option) any later version.
 169
 170 This program is distributed in the hope that it will be useful,
 171 but WITHOUT ANY WARRANTY; without even the implied warranty of
 172 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 173 GNU General Public License for more details.
 174
 175 You should have received a copy of the GNU General Public License along
 176 with this program; if not, write to the Free Software Foundation, Inc.,
 177 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 178
 179 Irrlicht
 180 ---------------
 181
 182 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
 183
 184  The Irrlicht Engine License
 185
 186 Copyright © 2002-2005 Nikolaus Gebhardt
 187
 188 This software is provided 'as-is', without any express or implied
 189 warranty. In no event will the authors be held liable for any damages
 190 arising from the use of this software.
 191
 192 Permission is granted to anyone to use this software for any purpose,
 193 including commercial applications, and to alter it and redistribute
 194 it freely, subject to the following restrictions:
 195
 196    1. The origin of this software must not be misrepresented; you
 197       must not claim that you wrote the original software. If you use
 198           this software in a product, an acknowledgment in the product
 199           documentation would be appreciated but is not required.
 200    2. Altered source versions must be plainly marked as such, and must
 201       not be misrepresented as being the original software.
 202    3. This notice may not be removed or altered from any source
 203       distribution.
 204
 205
 206 JThread
 207 ---------------
 208
 209 This program uses the JThread library. License for JThread follows:
 210
 211 Copyright (c) 2000-2006  Jori Liesenborgs (jori.liesenborgs@gmail.com)
 212
 213 Permission is hereby granted, free of charge, to any person obtaining a
 214 copy of this software and associated documentation files (the "Software"),
 215 to deal in the Software without restriction, including without limitation
 216 the rights to use, copy, modify, merge, publish, distribute, sublicense,
 217 and/or sell copies of the Software, and to permit persons to whom the
 218 Software is furnished to do so, subject to the following conditions:
 219
 220 The above copyright notice and this permission notice shall be included
 221 in all copies or substantial portions of the Software.
 222
 223 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 224 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 225 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 226 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 227 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 228 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 229 IN THE SOFTWARE.
 230
 231