README.txt

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