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