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 the minetest_game project too:
  13   https://github.com/minetest/minetest_game/
  14 See the README.txt in it.
  15
  16 Further documentation
  17 ----------------------
  18 - Website: http://minetest.net/
  19 - Wiki: http://wiki.minetest.net/
  20 - Developer wiki: http://dev.minetest.net/
  21 - Forum: http://forum.minetest.net/
  22 - Github: https://github.com/minetest/minetest/
  23 - doc/ directory of source distribution
  24
  25 This game is not finished
  26 --------------------------
  27 - Don't expect it to work as well as a finished game will.
  28 - Please report any bugs. When doing that, debug.txt is useful.
  29
  30 Default Controls
  31 -----------------
  32 - WASD: move
  33 - Space: jump/climb
  34 - Shift: sneak/go down
  35 - Q: drop item
  36 - I: inventory
  37 - Mouse: turn/look
  38 - Mouse left: dig/punch
  39 - Mouse right: place/use
  40 - Mouse wheel: select item
  41 - Esc: pause menu
  42 - T: chat
  43 - Settable in the configuration file, see the section below.
  44
  45 Paths
  46 ------
  47 $bin   - Compiled binaries
  48 $share - Distributed read-only data
  49 $user  - User-created modifiable data
  50
  51 Windows .zip / RUN_IN_PLACE source:
  52 $bin   = bin
  53 $share = .
  54 $user  = .
  55
  56 Linux installed:
  57 $bin   = /usr/bin
  58 $share = /usr/share/minetest
  59 $user  = ~/.minetest
  60
  61 OS X:
  62 $bin   = ?
  63 $share = ?
  64 $user  = ~/Library/Application Support/minetest
  65
  66 World directory
  67 ----------------
  68 - Worlds can be found as separate folders in:
  69     $user/worlds/
  70
  71 Configuration file:
  72 -------------------
  73 - Default location:
  74     $user/minetest.conf
  75 - It is created by Minetest when it is ran the first time.
  76 - A specific file can be specified on the command line:
  77         --config <path-to-file>
  78
  79 Command-line options:
  80 ---------------------
  81 - Use --help
  82
  83 Compiling on GNU/Linux:
  84 -----------------------
  85
  86 Install dependencies. Here's an example for Debian/Ubuntu:
  87 $ 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
  88
  89 Download source, extract (this is the URL to the latest of source repository, which might not work at all times):
  90 $ wget https://github.com/minetest/minetest/tarball/master -O master.tar.gz
  91 $ tar xf master.tar.gz
  92 $ cd minetest-minetest-286edd4 (or similar)
  93
  94 Download minetest_game (otherwise only the "Minimal development test" game is available)
  95 $ cd games/
  96 $ wget https://github.com/minetest/minetest_game/tarball/master -O minetest_game.tar.gz
  97 $ tar xf minetest_game.tar.gz
  98 $ mv minetest-minetest_game-* minetest_game
  99 $ cd ..
 100
 101 Build a version that runs directly from the source directory:
 102 $ cmake . -DRUN_IN_PLACE=1
 103 $ make -j2
 104
 105 Run it:
 106 $ cd bin
 107 $ ./minetest
 108
 109 - Use cmake . -LH to see all CMake options and their current state
 110 - If you want to install it system-wide (or are making a distribution package), you will want to use -DRUN_IN_PLACE=0
 111 - You can build a bare server or a bare client by specifying -DBUILD_CLIENT=0 or -DBUILD_SERVER=0
 112 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
 113   - Debug build is slower, but gives much more useful output in a debugger
 114 - If you build a bare server, you don't need to have Irrlicht installed. In that case use -DIRRLICHT_SOURCE_DIR=/the/irrlicht/source
 115
 116 CMake options
 117 -------------
 118 General options:
 119
 120 BUILD_CLIENT        - Build Minetest client
 121 BUILD_SERVER        - Build Minetest server
 122 CMAKE_BUILD_TYPE    - Type of build (Release vs. Debug)
 123     Release         - Release build
 124     Debug           - Debug build
 125     RelWithDebInfo  - Release build with Debug information
 126     MinSizeRel      - Release build with -Os passed to compiler to make executable as small as possible
 127 ENABLE_CURL         - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
 128 ENABLE_FREETYPE     - Build with Freetype2; Allows using TTF fonts
 129 ENABLE_GETTEXT      - Build with Gettext; Allows using translations
 130 ENABLE_GLES         - Search for Open GLES headers & libraries and use them
 131 ENABLE_LEVELDB      - Build with LevelDB; Enables use of LevelDB, which is much faster than SQLite, as map backend
 132 ENABLE_REDIS        - Build with libhiredis; Enables use of redis map backend
 133 ENABLE_SOUND        - Build with OpenAL, libogg & libvorbis; in-game Sounds
 134 DISABLE_LUAJIT      - Do not search for LuaJIT headers & library
 135 RUN_IN_PLACE        - Create a portable install (worlds, settings etc. in current directory)
 136 USE_GPROF           - Enable profiling using GProf
 137 VERSION_EXTRA       - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
 138
 139 Library specific options:
 140
 141 BZIP2_INCLUDE_DIR               - Linux only; directory where bzlib.h is located
 142 BZIP2_LIBRARY                   - Linux only; path to libbz2.a/libbz2.so
 143 CURL_DLL                        - Only if building with cURL on Windows; path to libcurl.dll
 144 CURL_INCLUDE_DIR                - Only if building with cURL; directory where curl.h is located
 145 CURL_LIBRARY                    - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
 146 EGL_INCLUDE_DIR                 - Only if building with GLES; directory that contains egl.h
 147 EGL_egl_LIBRARY                 - Only if building with GLES; path to libEGL.a/libEGL.so
 148 FREETYPE_INCLUDE_DIR_freetype2  - Only if building with Freetype2; directory that contains an freetype directory with files such as ftimage.h in it
 149 FREETYPE_INCLUDE_DIR_ft2build   - Only if building with Freetype2; directory that contains ft2build.h
 150 FREETYPE_LIBRARY                - Only if building with Freetype2; path to libfreetype.a/libfreetype.so/freetype.lib
 151 GETTEXT_DLL                     - Only when building with Gettext on Windows; path to libintl3.dll
 152 GETTEXT_ICONV_DLL               - Only when building with Gettext on Windows; path to libiconv2.dll
 153 GETTEXT_INCLUDE_DIR             - Only when building with Gettext; directory that contains iconv.h
 154 GETTEXT_LIBRARY                 - Only when building with Gettext on Windows; path to libintl.dll.a
 155 GETTEXT_MSGFMT                  - Only when building with Gettext; path to msgfmt/msgfmt.exe
 156 IRRLICHT_DLL                    - path to Irrlicht.dll
 157 IRRLICHT_INCLUDE_DIR            - directory that contains IrrCompileConfig.h
 158 IRRLICHT_LIBRARY                - path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a
 159 LEVELDB_INCLUDE_DIR             - Only when building with LevelDB; directory that contains db.h
 160 LEVELDB_LIBRARY                 - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll
 161 REDIS_INCLUDE_DIR               - Only when building with redis support; directory that contains hiredis.h
 162 REDIS_LIBRARY                   - Only when building with redis support; path to libhiredis.a/libhiredis.so
 163 LUA_INCLUDE_DIR                 - Only if you want to use LuaJIT; directory where luajit.h is located
 164 LUA_LIBRARY                     - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
 165 MINGWM10_DLL                    - Only if compiling with MinGW; path to mingwm10.dll
 166 OGG_DLL                         - Only if building with sound on Windows; path to libogg.dll
 167 OGG_INCLUDE_DIR                 - Only if building with sound; directory that contains an ogg directory which contains ogg.h
 168 OGG_LIBRARY                     - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
 169 OPENAL_DLL                      - Only if building with sound on Windows; path to OpenAL32.dll
 170 OPENAL_INCLUDE_DIR              - Only if building with sound; directory where al.h is located
 171 OPENAL_LIBRARY                  - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
 172 OPENGLES2_INCLUDE_DIR           - Only if building with GLES; directory that contains gl2.h
 173 OPENGLES2_gl_LIBRARY            - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
 174 SQLITE3_INCLUDE_DIR             - Only if you want to use SQLite from your OS; directory that contains sqlite3.h
 175 SQLITE3_LIBRARY                 - Only if you want to use the SQLite from your OS; path to libsqlite3.a/libsqlite3.so
 176 VORBISFILE_DLL                  - Only if building with sound on Windows; path to libvorbisfile-3.dll
 177 VORBISFILE_LIBRARY              - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
 178 VORBIS_DLL                      - Only if building with sound on Windows; path to libvorbis-0.dll
 179 VORBIS_INCLUDE_DIR              - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
 180 VORBIS_LIBRARY                  - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
 181 XXF86VM_LIBRARY                 - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
 182 ZLIB_DLL                        - Only on Windows; path to zlibwapi.dll
 183 ZLIB_INCLUDE_DIR                - directory where zlib.h is located
 184 ZLIB_LIBRARY                    - path to libz.a/libz.so/zlibwapi.lib
 185
 186 Compiling on Windows:
 187 ---------------------
 188 - This section is outdated. In addition to what is described here:
 189   - In addition to minetest, you need to download minetest_game.
 190   - If you wish to have sound support, you need libogg, libvorbis and libopenal
 191
 192 - You need:
 193         * CMake:
 194                 http://www.cmake.org/cmake/resources/software.html
 195         * MinGW or Visual Studio
 196                 http://www.mingw.org/
 197                 http://msdn.microsoft.com/en-us/vstudio/default
 198         * Irrlicht SDK 1.7:
 199                 http://irrlicht.sourceforge.net/downloads.html
 200         * Zlib headers (zlib125.zip)
 201                 http://www.winimage.com/zLibDll/index.html
 202         * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
 203                 http://www.winimage.com/zLibDll/index.html
 204         * Optional: gettext library and tools:
 205                 http://gnuwin32.sourceforge.net/downlinks/gettext.php
 206                 - This is used for other UI languages. Feel free to leave it out.
 207         * And, of course, Minetest:
 208                 http://minetest.net/download.php
 209 - Steps:
 210         - Select a directory called DIR hereafter in which you will operate.
 211         - Make sure you have CMake and a compiler installed.
 212         - Download all the other stuff to DIR and extract them into there.
 213           ("extract here", not "extract to packagename/")
 214           NOTE: zlib125dll.zip needs to be extracted into zlib125dll
 215         - All those packages contain a nice base directory in them, which
 216           should end up being the direct subdirectories of DIR.
 217         - You will end up with a directory structure like this (+=dir, -=file):
 218         -----------------
 219         + DIR
 220                 - zlib-1.2.5.tar.gz
 221                 - zlib125dll.zip
 222                 - irrlicht-1.7.1.zip
 223                 - 110214175330.zip (or whatever, this is the minetest source)
 224                 + zlib-1.2.5
 225                         - zlib.h
 226                         + win32
 227                         ...
 228                 + zlib125dll
 229                         - readme.txt
 230                         + dll32
 231                         ...
 232                 + irrlicht-1.7.1
 233                         + lib
 234                         + include
 235                         ...
 236                 + gettext (optional)
 237                         +bin
 238                         +include
 239                         +lib
 240                 + minetest
 241                         + src
 242                         + doc
 243                         - CMakeLists.txt
 244                         ...
 245         -----------------
 246         - Start up the CMake GUI
 247         - Select "Browse Source..." and select DIR/minetest
 248         - Now, if using MSVC:
 249                 - Select "Browse Build..." and select DIR/minetest-build
 250         - Else if using MinGW:
 251                 - Select "Browse Build..." and select DIR/minetest
 252         - Select "Configure"
 253         - Select your compiler
 254         - It will warn about missing stuff, ignore that at this point. (later don't)
 255         - Make sure the configuration is as follows
 256           (note that the versions may differ for you):
 257         -----------------
 258         BUILD_CLIENT             [X]
 259         BUILD_SERVER             [ ]
 260         CMAKE_BUILD_TYPE         Release
 261         CMAKE_INSTALL_PREFIX     DIR/minetest-install
 262         IRRLICHT_SOURCE_DIR      DIR/irrlicht-1.7.1
 263         RUN_IN_PLACE             [X]
 264         WARN_ALL                 [ ]
 265         ZLIB_DLL                 DIR/zlib125dll/dll32/zlibwapi.dll
 266         ZLIB_INCLUDE_DIR         DIR/zlib-1.2.5
 267         ZLIB_LIBRARIES           DIR/zlib125dll/dll32/zlibwapi.lib
 268         GETTEXT_BIN_DIR          DIR/gettext/bin
 269         GETTEXT_INCLUDE_DIR      DIR/gettext/include
 270         GETTEXT_LIBRARIES        DIR/gettext/lib/intl.lib
 271         GETTEXT_MSGFMT           DIR/gettext/bin/msgfmt
 272         -----------------
 273         - Hit "Configure"
 274         - Hit "Configure" once again 8)
 275         - If something is still coloured red, you have a problem.
 276         - Hit "Generate"
 277         If using MSVC:
 278                 - Open the generated minetest.sln
 279                 - The project defaults to the "Debug" configuration. Make very sure to
 280                   select "Release", unless you want to debug some stuff (it's slower
 281                   and might not even work at all)
 282                 - Build the ALL_BUILD project
 283                 - Build the INSTALL project
 284                 - You should now have a working game with the executable in
 285                         DIR/minetest-install/bin/minetest.exe
 286                 - Additionally you may create a zip package by building the PACKAGE
 287                   project.
 288         If using MinGW:
 289                 - Using the command line, browse to the build directory and run 'make'
 290                   (or mingw32-make or whatever it happens to be)
 291                 - You may need to copy some of the downloaded DLLs into bin/, see what
 292                   running the produced executable tells you it doesn't have.
 293                 - You should now have a working game with the executable in
 294                         DIR/minetest/bin/minetest.exe
 295
 296 Windows releases of minetest are built using a bat script like this:
 297 --------------------------------------------------------------------
 298
 299 set sourcedir=%CD%
 300 set installpath="C:\tmp\minetest_install"
 301 set irrlichtpath="C:\tmp\irrlicht-1.7.2"
 302
 303 set builddir=%sourcedir%\bvc10
 304 mkdir %builddir%
 305 pushd %builddir%
 306 cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=1 -DCMAKE_INSTALL_PREFIX=%installpath%
 307 if %errorlevel% neq 0 goto fail
 308 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
 309 if %errorlevel% neq 0 goto fail
 310 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
 311 if %errorlevel% neq 0 goto fail
 312 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
 313 if %errorlevel% neq 0 goto fail
 314 popd
 315 echo Finished.
 316 exit /b 0
 317
 318 :fail
 319 popd
 320 echo Failed.
 321 exit /b 1
 322
 323 License of Minetest textures and sounds
 324 ---------------------------------------
 325
 326 This applies to textures and sounds contained in the main Minetest
 327 distribution.
 328
 329 Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
 330 http://creativecommons.org/licenses/by-sa/3.0/
 331
 332 Authors of media files
 333 -----------------------
 334 Everything not listed in here:
 335 Copyright (C) 2010-2012 celeron55, Perttu Ahola <celeron55@gmail.com>
 336
 337 BlockMen:
 338   textures/base/pack/menuheader.png
 339
 340 erlehmann:
 341   misc/minetest-icon-24x24.png
 342   misc/minetest-icon.ico
 343   misc/minetest-icon.svg
 344   textures/base/pack/logo.png
 345
 346 License of Minetest source code
 347 -------------------------------
 348
 349 Minetest
 350 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 351
 352 This program is free software; you can redistribute it and/or modify
 353 it under the terms of the GNU Lesser General Public License as published by
 354 the Free Software Foundation; either version 2.1 of the License, or
 355 (at your option) any later version.
 356
 357 This program is distributed in the hope that it will be useful,
 358 but WITHOUT ANY WARRANTY; without even the implied warranty of
 359 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 360 GNU Lesser General Public License for more details.
 361
 362 You should have received a copy of the GNU Lesser General Public License along
 363 with this program; if not, write to the Free Software Foundation, Inc.,
 364 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 365
 366 Irrlicht
 367 ---------------
 368
 369 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
 370
 371  The Irrlicht Engine License
 372
 373 Copyright © 2002-2005 Nikolaus Gebhardt
 374
 375 This software is provided 'as-is', without any express or implied
 376 warranty. In no event will the authors be held liable for any damages
 377 arising from the use of this software.
 378
 379 Permission is granted to anyone to use this software for any purpose,
 380 including commercial applications, and to alter it and redistribute
 381 it freely, subject to the following restrictions:
 382
 383    1. The origin of this software must not be misrepresented; you
 384       must not claim that you wrote the original software. If you use
 385           this software in a product, an acknowledgment in the product
 386           documentation would be appreciated but is not required.
 387    2. Altered source versions must be plainly marked as such, and must
 388       not be misrepresented as being the original software.
 389    3. This notice may not be removed or altered from any source
 390       distribution.
 391
 392
 393 JThread
 394 ---------------
 395
 396 This program uses the JThread library. License for JThread follows:
 397
 398 Copyright (c) 2000-2006  Jori Liesenborgs (jori.liesenborgs@gmail.com)
 399
 400 Permission is hereby granted, free of charge, to any person obtaining a
 401 copy of this software and associated documentation files (the "Software"),
 402 to deal in the Software without restriction, including without limitation
 403 the rights to use, copy, modify, merge, publish, distribute, sublicense,
 404 and/or sell copies of the Software, and to permit persons to whom the
 405 Software is furnished to do so, subject to the following conditions:
 406
 407 The above copyright notice and this permission notice shall be included
 408 in all copies or substantial portions of the Software.
 409
 410 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 411 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 412 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 413 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 414 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 415 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 416 IN THE SOFTWARE.
 417
 418 Lua
 419 ---------------
 420
 421 Lua is licensed under the terms of the MIT license reproduced below.
 422 This means that Lua is free software and can be used for both academic
 423 and commercial purposes at absolutely no cost.
 424
 425 For details and rationale, see http://www.lua.org/license.html .
 426
 427 Copyright (C) 1994-2008 Lua.org, PUC-Rio.
 428
 429 Permission is hereby granted, free of charge, to any person obtaining a copy
 430 of this software and associated documentation files (the "Software"), to deal
 431 in the Software without restriction, including without limitation the rights
 432 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 433 copies of the Software, and to permit persons to whom the Software is
 434 furnished to do so, subject to the following conditions:
 435
 436 The above copyright notice and this permission notice shall be included in
 437 all copies or substantial portions of the Software.
 438
 439 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 440 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 441 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
 442 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 443 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 444 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 445 THE SOFTWARE.
 446
 447 Fonts
 448 ---------------
 449
 450 DejaVu Sans Mono:
 451
 452   Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
 453   Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
 454
 455 Bitstream Vera Fonts Copyright:
 456
 457   Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
 458   a trademark of Bitstream, Inc.
 459
 460 Arev Fonts Copyright:
 461
 462   Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
 463
 464 Liberation Fonts Copyright:
 465
 466   Copyright (c) 2007 Red Hat, Inc. All rights reserved. LIBERATION is a trademark of Red Hat, Inc.
 467
 468 DroidSansFallback:
 469
 470   Copyright (C) 2008 The Android Open Source Project
 471
 472   Licensed under the Apache License, Version 2.0 (the "License");
 473   you may not use this file except in compliance with the License.
 474   You may obtain a copy of the License at
 475
 476      http://www.apache.org/licenses/LICENSE-2.0
 477
 478   Unless required by applicable law or agreed to in writing, software
 479   distributed under the License is distributed on an "AS IS" BASIS,
 480   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 481   See the License for the specific language governing permissions and
 482   limitations under the License.