README.txt

   1 Minetest
   2 ============
   3
   4 An InfiniMiner/Minecraft inspired game.
   5
   6 Copyright (c) 2010-2013 Perttu Ahola <celeron55@gmail.com>
   7 and contributors (see source file comments and the version control log)
   8
   9 In case you downloaded the source code:
  10 ---------------------------------------
  11 If you downloaded the Minetest Engine source code in which this file is
  12 contained, you probably want to download these projects too:
  13   https://github.com/minetest/common/
  14   https://github.com/minetest/minetest_game/
  15 See the README.txt in them.
  16
  17 Further documentation
  18 ----------------------
  19 - Website: http://minetest.net/
  20 - Wiki: http://wiki.minetest.com/
  21 - Developer wiki: http://dev.minetest.net/
  22 - Forum: http://forum.minetest.net/
  23 - Github: https://github.com/minetest/minetest/
  24 - doc/ directory of source distribution
  25
  26 This game is not finished
  27 --------------------------
  28 - Don't expect it to work as well as a finished game will.
  29 - Please report any bugs. When doing that, debug.txt is useful.
  30
  31 Default Controls
  32 -----------------
  33 - WASD: Move
  34 - Space: Jump
  35 - E: Go down
  36 - Shift: Sneak
  37 - Q: Drop item
  38 - I: Open inventory
  39 - Mouse: Turn/look
  40 - Settable in the configuration file, see the section below.
  41
  42 Paths
  43 ------
  44 $bin   - Compiled binaries
  45 $share - Distributed read-only data
  46 $user  - User-created modifiable data
  47
  48 Windows .zip / RUN_IN_PLACE source:
  49 $bin   = bin
  50 $share = .
  51 $user  = .
  52
  53 Linux installed:
  54 $bin   = /usr/bin
  55 $share = /usr/share/minetest
  56 $user  = ~/.minetest
  57
  58 OS X:
  59 $bin   = ?
  60 $share = ?
  61 $user  = ~/Library/Application Support/minetest
  62
  63 World directory
  64 ----------------
  65 - Worlds can be found as separate folders in:
  66     $user/worlds/
  67
  68 Configuration file:
  69 -------------------
  70 - Default location:
  71     $user/minetest.conf
  72 - It is created by Minetest when it is ran the first time.
  73 - A specific file can be specified on the command line:
  74         --config <path-to-file>
  75
  76 Command-line options:
  77 ---------------------
  78 - Use --help
  79
  80 Compiling on GNU/Linux:
  81 -----------------------
  82
  83 Install dependencies. Here's an example for Debian/Ubuntu:
  84 $ apt-get install build-essential libirrlicht-dev cmake libbz2-dev libpng12-dev libjpeg8-dev libxxf86vm-dev libgl1-mesa-dev libsqlite3-dev libogg-dev libvorbis-dev libopenal-dev libcurl4-gnutls-dev libfreetype6-dev
  85
  86 Download source, extract (this is the URL to the latest of source repository, which might not work at all times):
  87 $ wget https://github.com/minetest/minetest/tarball/master -O master.tar.gz
  88 $ tar xf master.tar.gz
  89 $ cd minetest-minetest-286edd4 (or similar)
  90
  91 Download common (needed for minetest_game and some others)
  92 $ cd games/
  93 $ wget https://github.com/minetest/common/tarball/master -O common.tar.gz
  94 $ tar xf common.tar.gz
  95 $ mv minetest-common-* common
  96 $ cd ..
  97
  98 Download minetest_game (otherwise only the "Minimal development test" game is available)
  99 $ cd games/
 100 $ wget https://github.com/minetest/minetest_game/tarball/master -O minetest_game.tar.gz
 101 $ tar xf minetest_game.tar.gz
 102 $ mv minetest-minetest_game-* minetest_game
 103 $ cd ..
 104
 105 Build a version that runs directly from the source directory:
 106 $ cmake . -DRUN_IN_PLACE=1
 107 $ make -j2
 108
 109 Run it:
 110 $ cd bin
 111 $ ./minetest
 112
 113 - Use cmake . -LH to see all CMake options and their current state
 114 - If you want to install it system-wide (or are making a distribution package), you will want to use -DRUN_IN_PLACE=0
 115 - You can build a bare server or a bare client by specifying -DBUILD_CLIENT=0 or -DBUILD_SERVER=0
 116 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
 117   - Debug build is slower, but gives much more useful output in a debugger
 118 - If you build a bare server, you don't need to have Irrlicht installed. In that case use -DIRRLICHT_SOURCE_DIR=/the/irrlicht/source
 119
 120 Compiling on Windows:
 121 ---------------------
 122 - This section is outdated. In addition to what is described here:
 123   - In addition to minetest, you need to download common and minetest_game.
 124   - If you wish to have sound support, you need libogg, libvorbis and libopenal
 125
 126 - You need:
 127         * CMake:
 128                 http://www.cmake.org/cmake/resources/software.html
 129         * MinGW or Visual Studio
 130                 http://www.mingw.org/
 131                 http://msdn.microsoft.com/en-us/vstudio/default
 132         * Irrlicht SDK 1.7:
 133                 http://irrlicht.sourceforge.net/downloads.html
 134         * Zlib headers (zlib125.zip)
 135                 http://www.winimage.com/zLibDll/index.html
 136         * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
 137                 http://www.winimage.com/zLibDll/index.html
 138         * Optional: gettext library and tools:
 139                 http://gnuwin32.sourceforge.net/downlinks/gettext.php
 140                 - This is used for other UI languages. Feel free to leave it out.
 141         * And, of course, Minetest:
 142                 http://minetest.net/download.php
 143 - Steps:
 144         - Select a directory called DIR hereafter in which you will operate.
 145         - Make sure you have CMake and a compiler installed.
 146         - Download all the other stuff to DIR and extract them into there.
 147           ("extract here", not "extract to packagename/")
 148           NOTE: zlib125dll.zip needs to be extracted into zlib125dll
 149         - All those packages contain a nice base directory in them, which
 150           should end up being the direct subdirectories of DIR.
 151         - You will end up with a directory structure like this (+=dir, -=file):
 152         -----------------
 153         + DIR
 154                 - zlib-1.2.5.tar.gz
 155                 - zlib125dll.zip
 156                 - irrlicht-1.7.1.zip
 157                 - 110214175330.zip (or whatever, this is the minetest source)
 158                 + zlib-1.2.5
 159                         - zlib.h
 160                         + win32
 161                         ...
 162                 + zlib125dll
 163                         - readme.txt
 164                         + dll32
 165                         ...
 166                 + irrlicht-1.7.1
 167                         + lib
 168                         + include
 169                         ...
 170                 + gettext (optional)
 171                         +bin
 172                         +include
 173                         +lib
 174                 + minetest
 175                         + src
 176                         + doc
 177                         - CMakeLists.txt
 178                         ...
 179         -----------------
 180         - Start up the CMake GUI
 181         - Select "Browse Source..." and select DIR/minetest
 182         - Now, if using MSVC:
 183                 - Select "Browse Build..." and select DIR/minetest-build
 184         - Else if using MinGW:
 185                 - Select "Browse Build..." and select DIR/minetest
 186         - Select "Configure"
 187         - Select your compiler
 188         - It will warn about missing stuff, ignore that at this point. (later don't)
 189         - Make sure the configuration is as follows
 190           (note that the versions may differ for you):
 191         -----------------
 192         BUILD_CLIENT             [X]
 193         BUILD_SERVER             [ ]
 194         CMAKE_BUILD_TYPE         Release
 195         CMAKE_INSTALL_PREFIX     DIR/minetest-install
 196         IRRLICHT_SOURCE_DIR      DIR/irrlicht-1.7.1
 197         RUN_IN_PLACE             [X]
 198         WARN_ALL                 [ ]
 199         ZLIB_DLL                 DIR/zlib125dll/dll32/zlibwapi.dll
 200         ZLIB_INCLUDE_DIR         DIR/zlib-1.2.5
 201         ZLIB_LIBRARIES           DIR/zlib125dll/dll32/zlibwapi.lib
 202         GETTEXT_BIN_DIR          DIR/gettext/bin
 203         GETTEXT_INCLUDE_DIR      DIR/gettext/include
 204         GETTEXT_LIBRARIES        DIR/gettext/lib/intl.lib
 205         GETTEXT_MSGFMT           DIR/gettext/bin/msgfmt
 206         -----------------
 207         - Hit "Configure"
 208         - Hit "Configure" once again 8)
 209         - If something is still coloured red, you have a problem.
 210         - Hit "Generate"
 211         If using MSVC:
 212                 - Open the generated minetest.sln
 213                 - The project defaults to the "Debug" configuration. Make very sure to
 214                   select "Release", unless you want to debug some stuff (it's slower
 215                   and might not even work at all)
 216                 - Build the ALL_BUILD project
 217                 - Build the INSTALL project
 218                 - You should now have a working game with the executable in
 219                         DIR/minetest-install/bin/minetest.exe
 220                 - Additionally you may create a zip package by building the PACKAGE
 221                   project.
 222         If using MinGW:
 223                 - Using the command line, browse to the build directory and run 'make'
 224                   (or mingw32-make or whatever it happens to be)
 225                 - You may need to copy some of the downloaded DLLs into bin/, see what
 226                   running the produced executable tells you it doesn't have.
 227                 - You should now have a working game with the executable in
 228                         DIR/minetest/bin/minetest.exe
 229
 230 Windows releases of minetest are built using a bat script like this:
 231 --------------------------------------------------------------------
 232
 233 set sourcedir=%CD%
 234 set installpath="C:\tmp\minetest_install"
 235 set irrlichtpath="C:\tmp\irrlicht-1.7.2"
 236
 237 set builddir=%sourcedir%\bvc10
 238 mkdir %builddir%
 239 pushd %builddir%
 240 cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=1 -DCMAKE_INSTALL_PREFIX=%installpath%
 241 if %errorlevel% neq 0 goto fail
 242 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
 243 if %errorlevel% neq 0 goto fail
 244 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
 245 if %errorlevel% neq 0 goto fail
 246 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
 247 if %errorlevel% neq 0 goto fail
 248 popd
 249 echo Finished.
 250 exit /b 0
 251
 252 :fail
 253 popd
 254 echo Failed.
 255 exit /b 1
 256
 257 License of Minetest textures and sounds
 258 ---------------------------------------
 259
 260 This applies to textures and sounds contained in the main Minetest
 261 distribution.
 262
 263 Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
 264 http://creativecommons.org/licenses/by-sa/3.0/
 265
 266 License of Minetest source code
 267 -------------------------------
 268
 269 Minetest
 270 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 271
 272 This program is free software; you can redistribute it and/or modify
 273 it under the terms of the GNU Lesser General Public License as published by
 274 the Free Software Foundation; either version 2.1 of the License, or
 275 (at your option) any later version.
 276
 277 This program is distributed in the hope that it will be useful,
 278 but WITHOUT ANY WARRANTY; without even the implied warranty of
 279 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 280 GNU General Public License for more details.
 281
 282 You should have received a copy of the GNU Lesser General Public License along
 283 with this program; if not, write to the Free Software Foundation, Inc.,
 284 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 285
 286 Irrlicht
 287 ---------------
 288
 289 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
 290
 291  The Irrlicht Engine License
 292
 293 Copyright © 2002-2005 Nikolaus Gebhardt
 294
 295 This software is provided 'as-is', without any express or implied
 296 warranty. In no event will the authors be held liable for any damages
 297 arising from the use of this software.
 298
 299 Permission is granted to anyone to use this software for any purpose,
 300 including commercial applications, and to alter it and redistribute
 301 it freely, subject to the following restrictions:
 302
 303    1. The origin of this software must not be misrepresented; you
 304       must not claim that you wrote the original software. If you use
 305           this software in a product, an acknowledgment in the product
 306           documentation would be appreciated but is not required.
 307    2. Altered source versions must be plainly marked as such, and must
 308       not be misrepresented as being the original software.
 309    3. This notice may not be removed or altered from any source
 310       distribution.
 311
 312
 313 JThread
 314 ---------------
 315
 316 This program uses the JThread library. License for JThread follows:
 317
 318 Copyright (c) 2000-2006  Jori Liesenborgs (jori.liesenborgs@gmail.com)
 319
 320 Permission is hereby granted, free of charge, to any person obtaining a
 321 copy of this software and associated documentation files (the "Software"),
 322 to deal in the Software without restriction, including without limitation
 323 the rights to use, copy, modify, merge, publish, distribute, sublicense,
 324 and/or sell copies of the Software, and to permit persons to whom the
 325 Software is furnished to do so, subject to the following conditions:
 326
 327 The above copyright notice and this permission notice shall be included
 328 in all copies or substantial portions of the Software.
 329
 330 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 331 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 332 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 333 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 334 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 335 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 336 IN THE SOFTWARE.
 337
 338 Lua
 339 ---------------
 340
 341 Lua is licensed under the terms of the MIT license reproduced below.
 342 This means that Lua is free software and can be used for both academic
 343 and commercial purposes at absolutely no cost.
 344
 345 For details and rationale, see http://www.lua.org/license.html .
 346
 347 Copyright (C) 1994-2008 Lua.org, PUC-Rio.
 348
 349 Permission is hereby granted, free of charge, to any person obtaining a copy
 350 of this software and associated documentation files (the "Software"), to deal
 351 in the Software without restriction, including without limitation the rights
 352 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 353 copies of the Software, and to permit persons to whom the Software is
 354 furnished to do so, subject to the following conditions:
 355
 356 The above copyright notice and this permission notice shall be included in
 357 all copies or substantial portions of the Software.
 358
 359 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 360 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 361 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
 362 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 363 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 364 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 365 THE SOFTWARE.
 366
 367 Fonts
 368 ---------------
 369
 370 DejaVu Sans Mono:
 371
 372   Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
 373   Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
 374
 375   Bitstream Vera Fonts Copyright:
 376
 377   Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
 378   a trademark of Bitstream, Inc.
 379
 380   Arev Fonts Copyright:
 381
 382   Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
 383
 384   Liberation Fonts Copyright:
 385
 386   Copyright (c) 2007 Red Hat, Inc. All rights reserved. LIBERATION is a trademark of Red Hat, Inc.
 387
 388