README.txt

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