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.com/
  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 Compiling on Windows:
 117 ---------------------
 118 - This section is outdated. In addition to what is described here:
 119   - In addition to minetest, you need to download minetest_game.
 120   - If you wish to have sound support, you need libogg, libvorbis and libopenal
 121
 122 - You need:
 123         * CMake:
 124                 http://www.cmake.org/cmake/resources/software.html
 125         * MinGW or Visual Studio
 126                 http://www.mingw.org/
 127                 http://msdn.microsoft.com/en-us/vstudio/default
 128         * Irrlicht SDK 1.7:
 129                 http://irrlicht.sourceforge.net/downloads.html
 130         * Zlib headers (zlib125.zip)
 131                 http://www.winimage.com/zLibDll/index.html
 132         * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
 133                 http://www.winimage.com/zLibDll/index.html
 134         * Optional: gettext library and tools:
 135                 http://gnuwin32.sourceforge.net/downlinks/gettext.php
 136                 - This is used for other UI languages. Feel free to leave it out.
 137         * And, of course, Minetest:
 138                 http://minetest.net/download.php
 139 - Steps:
 140         - Select a directory called DIR hereafter in which you will operate.
 141         - Make sure you have CMake and a compiler installed.
 142         - Download all the other stuff to DIR and extract them into there.
 143           ("extract here", not "extract to packagename/")
 144           NOTE: zlib125dll.zip needs to be extracted into zlib125dll
 145         - All those packages contain a nice base directory in them, which
 146           should end up being the direct subdirectories of DIR.
 147         - You will end up with a directory structure like this (+=dir, -=file):
 148         -----------------
 149         + DIR
 150                 - zlib-1.2.5.tar.gz
 151                 - zlib125dll.zip
 152                 - irrlicht-1.7.1.zip
 153                 - 110214175330.zip (or whatever, this is the minetest source)
 154                 + zlib-1.2.5
 155                         - zlib.h
 156                         + win32
 157                         ...
 158                 + zlib125dll
 159                         - readme.txt
 160                         + dll32
 161                         ...
 162                 + irrlicht-1.7.1
 163                         + lib
 164                         + include
 165                         ...
 166                 + gettext (optional)
 167                         +bin
 168                         +include
 169                         +lib
 170                 + minetest
 171                         + src
 172                         + doc
 173                         - CMakeLists.txt
 174                         ...
 175         -----------------
 176         - Start up the CMake GUI
 177         - Select "Browse Source..." and select DIR/minetest
 178         - Now, if using MSVC:
 179                 - Select "Browse Build..." and select DIR/minetest-build
 180         - Else if using MinGW:
 181                 - Select "Browse Build..." and select DIR/minetest
 182         - Select "Configure"
 183         - Select your compiler
 184         - It will warn about missing stuff, ignore that at this point. (later don't)
 185         - Make sure the configuration is as follows
 186           (note that the versions may differ for you):
 187         -----------------
 188         BUILD_CLIENT             [X]
 189         BUILD_SERVER             [ ]
 190         CMAKE_BUILD_TYPE         Release
 191         CMAKE_INSTALL_PREFIX     DIR/minetest-install
 192         IRRLICHT_SOURCE_DIR      DIR/irrlicht-1.7.1
 193         RUN_IN_PLACE             [X]
 194         WARN_ALL                 [ ]
 195         ZLIB_DLL                 DIR/zlib125dll/dll32/zlibwapi.dll
 196         ZLIB_INCLUDE_DIR         DIR/zlib-1.2.5
 197         ZLIB_LIBRARIES           DIR/zlib125dll/dll32/zlibwapi.lib
 198         GETTEXT_BIN_DIR          DIR/gettext/bin
 199         GETTEXT_INCLUDE_DIR      DIR/gettext/include
 200         GETTEXT_LIBRARIES        DIR/gettext/lib/intl.lib
 201         GETTEXT_MSGFMT           DIR/gettext/bin/msgfmt
 202         -----------------
 203         - Hit "Configure"
 204         - Hit "Configure" once again 8)
 205         - If something is still coloured red, you have a problem.
 206         - Hit "Generate"
 207         If using MSVC:
 208                 - Open the generated minetest.sln
 209                 - The project defaults to the "Debug" configuration. Make very sure to
 210                   select "Release", unless you want to debug some stuff (it's slower
 211                   and might not even work at all)
 212                 - Build the ALL_BUILD project
 213                 - Build the INSTALL project
 214                 - You should now have a working game with the executable in
 215                         DIR/minetest-install/bin/minetest.exe
 216                 - Additionally you may create a zip package by building the PACKAGE
 217                   project.
 218         If using MinGW:
 219                 - Using the command line, browse to the build directory and run 'make'
 220                   (or mingw32-make or whatever it happens to be)
 221                 - You may need to copy some of the downloaded DLLs into bin/, see what
 222                   running the produced executable tells you it doesn't have.
 223                 - You should now have a working game with the executable in
 224                         DIR/minetest/bin/minetest.exe
 225
 226 Windows releases of minetest are built using a bat script like this:
 227 --------------------------------------------------------------------
 228
 229 set sourcedir=%CD%
 230 set installpath="C:\tmp\minetest_install"
 231 set irrlichtpath="C:\tmp\irrlicht-1.7.2"
 232
 233 set builddir=%sourcedir%\bvc10
 234 mkdir %builddir%
 235 pushd %builddir%
 236 cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=1 -DCMAKE_INSTALL_PREFIX=%installpath%
 237 if %errorlevel% neq 0 goto fail
 238 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
 239 if %errorlevel% neq 0 goto fail
 240 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
 241 if %errorlevel% neq 0 goto fail
 242 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
 243 if %errorlevel% neq 0 goto fail
 244 popd
 245 echo Finished.
 246 exit /b 0
 247
 248 :fail
 249 popd
 250 echo Failed.
 251 exit /b 1
 252
 253 License of Minetest textures and sounds
 254 ---------------------------------------
 255
 256 This applies to textures and sounds contained in the main Minetest
 257 distribution.
 258
 259 Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
 260 http://creativecommons.org/licenses/by-sa/3.0/
 261
 262 License of Minetest source code
 263 -------------------------------
 264
 265 Minetest
 266 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 267
 268 This program is free software; you can redistribute it and/or modify
 269 it under the terms of the GNU Lesser General Public License as published by
 270 the Free Software Foundation; either version 2.1 of the License, or
 271 (at your option) any later version.
 272
 273 This program is distributed in the hope that it will be useful,
 274 but WITHOUT ANY WARRANTY; without even the implied warranty of
 275 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 276 GNU Lesser General Public License for more details.
 277
 278 You should have received a copy of the GNU Lesser General Public License along
 279 with this program; if not, write to the Free Software Foundation, Inc.,
 280 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 281
 282 Irrlicht
 283 ---------------
 284
 285 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
 286
 287  The Irrlicht Engine License
 288
 289 Copyright © 2002-2005 Nikolaus Gebhardt
 290
 291 This software is provided 'as-is', without any express or implied
 292 warranty. In no event will the authors be held liable for any damages
 293 arising from the use of this software.
 294
 295 Permission is granted to anyone to use this software for any purpose,
 296 including commercial applications, and to alter it and redistribute
 297 it freely, subject to the following restrictions:
 298
 299    1. The origin of this software must not be misrepresented; you
 300       must not claim that you wrote the original software. If you use
 301           this software in a product, an acknowledgment in the product
 302           documentation would be appreciated but is not required.
 303    2. Altered source versions must be plainly marked as such, and must
 304       not be misrepresented as being the original software.
 305    3. This notice may not be removed or altered from any source
 306       distribution.
 307
 308
 309 JThread
 310 ---------------
 311
 312 This program uses the JThread library. License for JThread follows:
 313
 314 Copyright (c) 2000-2006  Jori Liesenborgs (jori.liesenborgs@gmail.com)
 315
 316 Permission is hereby granted, free of charge, to any person obtaining a
 317 copy of this software and associated documentation files (the "Software"),
 318 to deal in the Software without restriction, including without limitation
 319 the rights to use, copy, modify, merge, publish, distribute, sublicense,
 320 and/or sell copies of the Software, and to permit persons to whom the
 321 Software is furnished to do so, subject to the following conditions:
 322
 323 The above copyright notice and this permission notice shall be included
 324 in all copies or substantial portions of the Software.
 325
 326 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 327 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 328 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 329 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 330 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 331 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 332 IN THE SOFTWARE.
 333
 334 Lua
 335 ---------------
 336
 337 Lua is licensed under the terms of the MIT license reproduced below.
 338 This means that Lua is free software and can be used for both academic
 339 and commercial purposes at absolutely no cost.
 340
 341 For details and rationale, see http://www.lua.org/license.html .
 342
 343 Copyright (C) 1994-2008 Lua.org, PUC-Rio.
 344
 345 Permission is hereby granted, free of charge, to any person obtaining a copy
 346 of this software and associated documentation files (the "Software"), to deal
 347 in the Software without restriction, including without limitation the rights
 348 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 349 copies of the Software, and to permit persons to whom the Software is
 350 furnished to do so, subject to the following conditions:
 351
 352 The above copyright notice and this permission notice shall be included in
 353 all copies or substantial portions of the Software.
 354
 355 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 356 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 357 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
 358 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 359 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 360 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 361 THE SOFTWARE.
 362
 363 Fonts
 364 ---------------
 365
 366 DejaVu Sans Mono:
 367
 368   Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
 369   Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
 370
 371   Bitstream Vera Fonts Copyright:
 372
 373   Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
 374   a trademark of Bitstream, Inc.
 375
 376   Arev Fonts Copyright:
 377
 378   Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
 379
 380   Liberation Fonts Copyright:
 381
 382   Copyright (c) 2007 Red Hat, Inc. All rights reserved. LIBERATION is a trademark of Red Hat, Inc.
 383
 384