README.txt

   1 Minetest-c55
   2 ---------------
   3 An InfiniMiner/Minecraft inspired game.
   4 Copyright (c) 2010-2012 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 libsqlite3-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://github.com/celeron55/minetest/tarball/master -O master.tar.gz
  61 $ tar xf master.tar.gz
  62 $ cd celeron55-minetest-286edd4 (or similar)
  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   - Debug build is slower, but gives much more useful output in a debugger
  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         * Optional: gettext bibrary and tools:
  94                 http://gnuwin32.sourceforge.net/downlinks/gettext.php
  95                 - This is used for other UI languages. Feel free to leave it out.
  96         * And, of course, Minetest-c55:
  97                 http://celeron.55.lt/~celeron55/minetest/download
  98 - Steps:
  99         - Select a directory called DIR hereafter in which you will operate.
 100         - Make sure you have CMake and a compiler installed.
 101         - Download all the other stuff to DIR and extract them into there.
 102           ("extract here", not "extract to packagename/")
 103           NOTE: zlib125dll.zip needs to be extracted into zlib125dll
 104         - All those packages contain a nice base directory in them, which
 105           should end up being the direct subdirectories of DIR.
 106         - You will end up with a directory structure like this (+=dir, -=file):
 107         -----------------
 108         + DIR
 109                 - zlib-1.2.5.tar.gz
 110                 - zlib125dll.zip
 111                 - irrlicht-1.7.1.zip
 112                 - 110214175330.zip (or whatever, this is the minetest source)
 113                 + zlib-1.2.5
 114                         - zlib.h
 115                         + win32
 116                         ...
 117                 + zlib125dll
 118                         - readme.txt
 119                         + dll32
 120                         ...
 121                 + irrlicht-1.7.1
 122                         + lib
 123                         + include
 124                         ...
 125                 + gettext (optional)
 126                         +bin
 127                         +include
 128                         +lib
 129                 + minetest
 130                         + src
 131                         + doc
 132                         - CMakeLists.txt
 133                         ...
 134         -----------------
 135         - Start up the CMake GUI
 136         - Select "Browse Source..." and select DIR/minetest
 137         - Now, if using MSVC:
 138                 - Select "Browse Build..." and select DIR/minetest-build
 139         - Else if using MinGW:
 140                 - Select "Browse Build..." and select DIR/minetest
 141         - Select "Configure"
 142         - Select your compiler
 143         - It will warn about missing stuff, ignore that at this point. (later don't)
 144         - Make sure the configuration is as follows
 145           (note that the versions may differ for you):
 146         -----------------
 147         BUILD_CLIENT             [X]
 148         BUILD_SERVER             [ ]
 149         CMAKE_BUILD_TYPE         Release
 150         CMAKE_INSTALL_PREFIX     DIR/minetest-install
 151         IRRLICHT_SOURCE_DIR      DIR/irrlicht-1.7.1
 152         RUN_IN_PLACE             [X]
 153         WARN_ALL                 [ ]
 154         ZLIB_DLL                 DIR/zlib125dll/dll32/zlibwapi.dll
 155         ZLIB_INCLUDE_DIR         DIR/zlib-1.2.5
 156         ZLIB_LIBRARIES           DIR/zlib125dll/dll32/zlibwapi.lib
 157         GETTEXT_BIN_DIR          DIR/gettext/bin
 158         GETTEXT_INCLUDE_DIR      DIR/gettext/include
 159         GETTEXT_LIBRARIES        DIR/gettext/lib/intl.lib
 160         GETTEXT_MSGFMT           DIR/gettext/bin/msgfmt
 161         -----------------
 162         - Hit "Configure"
 163         - Hit "Configure" once again 8)
 164         - If something is still coloured red, you have a problem.
 165         - Hit "Generate"
 166         If using MSVC:
 167                 - Open the generated minetest.sln
 168                 - The project defaults to the "Debug" configuration. Make very sure to
 169                   select "Release", unless you want to debug some stuff (it's slower
 170                   and might not even work at all)
 171                 - Build the ALL_BUILD project
 172                 - Build the INSTALL project
 173                 - You should now have a working game with the executable in
 174                         DIR/minetest-install/bin/minetest.exe
 175                 - Additionally you may create a zip package by building the PACKAGE
 176                   project.
 177         If using MinGW:
 178                 - Using the command line, browse to the build directory and run 'make'
 179                   (or mingw32-make or whatever it happens to be)
 180                 - You may need to copy some of the downloaded DLLs into bin/, see what
 181                   running the produced executable tells you it doesn't have.
 182                 - You should now have a working game with the executable in
 183                         DIR/minetest/bin/minetest.exe
 184
 185 Windows releases of minetest are built using a bat script like this:
 186 --------------------------------------------------------------------
 187
 188 set sourcedir=%CD%
 189 set installpath="C:\tmp\minetest_install"
 190 set irrlichtpath="C:\tmp\irrlicht-1.7.2"
 191
 192 set builddir=%sourcedir%\bvc10
 193 mkdir %builddir%
 194 pushd %builddir%
 195 cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=1 -DCMAKE_INSTALL_PREFIX=%installpath%
 196 if %errorlevel% neq 0 goto fail
 197 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
 198 if %errorlevel% neq 0 goto fail
 199 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
 200 if %errorlevel% neq 0 goto fail
 201 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
 202 if %errorlevel% neq 0 goto fail
 203 popd
 204 echo Finished.
 205 exit /b 0
 206
 207 :fail
 208 popd
 209 echo Failed.
 210 exit /b 1
 211
 212 License of Minetest-c55 textures and sounds
 213 -------------------------------------------
 214
 215 This applies to textures and sounds contained in the main Minetest
 216 distribution.
 217
 218 Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
 219 http://creativecommons.org/licenses/by-sa/3.0/
 220
 221 License of Minetest-c55 source code
 222 -----------------------------------
 223
 224 Minetest-c55
 225 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
 226
 227 This program is free software; you can redistribute it and/or modify
 228 it under the terms of the GNU General Public License as published by
 229 the Free Software Foundation; either version 2 of the License, or
 230 (at your option) any later version.
 231
 232 This program is distributed in the hope that it will be useful,
 233 but WITHOUT ANY WARRANTY; without even the implied warranty of
 234 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 235 GNU General Public License for more details.
 236
 237 You should have received a copy of the GNU General Public License along
 238 with this program; if not, write to the Free Software Foundation, Inc.,
 239 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 240
 241 Irrlicht
 242 ---------------
 243
 244 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
 245
 246  The Irrlicht Engine License
 247
 248 Copyright © 2002-2005 Nikolaus Gebhardt
 249
 250 This software is provided 'as-is', without any express or implied
 251 warranty. In no event will the authors be held liable for any damages
 252 arising from the use of this software.
 253
 254 Permission is granted to anyone to use this software for any purpose,
 255 including commercial applications, and to alter it and redistribute
 256 it freely, subject to the following restrictions:
 257
 258    1. The origin of this software must not be misrepresented; you
 259       must not claim that you wrote the original software. If you use
 260           this software in a product, an acknowledgment in the product
 261           documentation would be appreciated but is not required.
 262    2. Altered source versions must be plainly marked as such, and must
 263       not be misrepresented as being the original software.
 264    3. This notice may not be removed or altered from any source
 265       distribution.
 266
 267
 268 JThread
 269 ---------------
 270
 271 This program uses the JThread library. License for JThread follows:
 272
 273 Copyright (c) 2000-2006  Jori Liesenborgs (jori.liesenborgs@gmail.com)
 274
 275 Permission is hereby granted, free of charge, to any person obtaining a
 276 copy of this software and associated documentation files (the "Software"),
 277 to deal in the Software without restriction, including without limitation
 278 the rights to use, copy, modify, merge, publish, distribute, sublicense,
 279 and/or sell copies of the Software, and to permit persons to whom the
 280 Software is furnished to do so, subject to the following conditions:
 281
 282 The above copyright notice and this permission notice shall be included
 283 in all copies or substantial portions of the Software.
 284
 285 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 286 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 287 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 288 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 289 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 290 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 291 IN THE SOFTWARE.
 292
 293
 294 Fonts
 295 ---------------
 296
 297 DejaVu Sans Mono:
 298
 299   Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
 300   Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
 301
 302   Bitstream Vera Fonts Copyright:
 303
 304   Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
 305   a trademark of Bitstream, Inc.
 306
 307   Arev Fonts Copyright:
 308
 309   Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
 310
 311