4 An InfiniMiner/Minecraft inspired game.
6 Copyright (c) 2010-2013 Perttu Ahola <celeron55@gmail.com>
7 and contributors (see source file comments and the version control log)
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.
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
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.
34 - Shift: sneak/go down
35 - Q: drop itemstack (+ SHIFT for single item)
38 - Mouse left: dig/punch
39 - Mouse right: place/use
40 - Mouse wheel: select item
44 - Esc: pause menu (pauses only singleplayer game)
45 - R: Enable/Disable full range view
46 - +: Increase view range
47 - -: Decrease view range
48 - K: Enable/Disable fly (needs fly privilege)
49 - J: Enable/Disable fast (needs fast privilege)
50 - H: Enable/Disable noclip (needs noclip privilege)
54 - F3: Disable/Enable Fog
55 - F4: Disable/Enable Camera update (Mapblocks are not updated anymore when disabled)
56 - F5: Toogle through debug info screens
57 - F6: Toogle through output data
58 - F7: Toggle through camera modes
59 - F10: Show/Hide console
60 - F12: Take screenshot
62 - Settable in the configuration file, see the section below.
66 $bin - Compiled binaries
67 $share - Distributed read-only data
68 $user - User-created modifiable data
70 Windows .zip / RUN_IN_PLACE source:
77 $share = /usr/share/minetest
82 $share = Contents/Resources
83 $user = Contents/User OR ~/Library/Application Support/minetest
87 - Worlds can be found as separate folders in:
94 - It is created by Minetest when it is ran the first time.
95 - A specific file can be specified on the command line:
96 --config <path-to-file>
102 Compiling on GNU/Linux:
103 -----------------------
105 Install dependencies. Here's an example for Debian/Ubuntu:
106 $ sudo apt-get install build-essential libirrlicht-dev cmake libbz2-dev libpng12-dev libjpeg-dev libxxf86vm-dev libgl1-mesa-dev libsqlite3-dev libogg-dev libvorbis-dev libopenal-dev libcurl4-gnutls-dev libfreetype6-dev zlib1g-dev libgmp-dev libjsoncpp-dev
108 You can install git for easily keeping your copy up to date.
109 If you dont want git, read below on how to get the source without git.
110 This is an example for installing git on Debian/Ubuntu:
111 $ sudo apt-get install git-core
113 Download source (this is the URL to the latest of source repository, which might not work at all times) using git:
114 $ git clone --depth 1 https://github.com/minetest/minetest.git
117 Download minetest_game (otherwise only the "Minimal development test" game is available) using git:
118 $ git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game
120 Download source, without using git:
121 $ wget https://github.com/minetest/minetest/archive/master.tar.gz
122 $ tar xf master.tar.gz
125 Download minetest_game, without using git:
127 $ wget https://github.com/minetest/minetest_game/archive/master.tar.gz
128 $ tar xf master.tar.gz
129 $ mv minetest_game-master minetest_game
132 Build a version that runs directly from the source directory:
133 $ cmake . -DRUN_IN_PLACE=TRUE
134 $ make -j <number of processors>
139 - Use cmake . -LH to see all CMake options and their current state
140 - If you want to install it system-wide (or are making a distribution package),
141 you will want to use -DRUN_IN_PLACE=FALSE
142 - You can build a bare server by specifying -DBUILD_SERVER=TRUE
143 - You can disable the client build by specifying -DBUILD_CLIENT=FALSE
144 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
145 - Debug build is slower, but gives much more useful output in a debugger
146 - If you build a bare server, you don't need to have Irrlicht installed.
147 In that case use -DIRRLICHT_SOURCE_DIR=/the/irrlicht/source
153 BUILD_CLIENT - Build Minetest client
154 BUILD_SERVER - Build Minetest server
155 CMAKE_BUILD_TYPE - Type of build (Release vs. Debug)
156 Release - Release build
158 SemiDebug - Partially optimized debug build
159 RelWithDebInfo - Release build with Debug information
160 MinSizeRel - Release build with -Os passed to compiler to make executable as small as possible
161 ENABLE_CURL - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
162 ENABLE_FREETYPE - Build with FreeType2; Allows using TTF fonts
163 ENABLE_GETTEXT - Build with Gettext; Allows using translations
164 ENABLE_GLES - Search for Open GLES headers & libraries and use them
165 ENABLE_LEVELDB - Build with LevelDB; Enables use of LevelDB map backend (faster than SQLite3)
166 ENABLE_REDIS - Build with libhiredis; Enables use of Redis map backend
167 ENABLE_SOUND - Build with OpenAL, libogg & libvorbis; in-game Sounds
168 ENABLE_LUAJIT - Build with LuaJIT (much faster than non-JIT Lua)
169 ENABLE_SYSTEM_GMP - Use GMP from system (much faster than bundled mini-gmp)
170 RUN_IN_PLACE - Create a portable install (worlds, settings etc. in current directory)
171 USE_GPROF - Enable profiling using GProf
172 VERSION_EXTRA - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
174 Library specific options:
176 BZIP2_INCLUDE_DIR - Linux only; directory where bzlib.h is located
177 BZIP2_LIBRARY - Linux only; path to libbz2.a/libbz2.so
178 CURL_DLL - Only if building with cURL on Windows; path to libcurl.dll
179 CURL_INCLUDE_DIR - Only if building with cURL; directory where curl.h is located
180 CURL_LIBRARY - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
181 EGL_INCLUDE_DIR - Only if building with GLES; directory that contains egl.h
182 EGL_LIBRARY - Only if building with GLES; path to libEGL.a/libEGL.so
183 FREETYPE_INCLUDE_DIR_freetype2 - Only if building with Freetype2; directory that contains an freetype directory with files such as ftimage.h in it
184 FREETYPE_INCLUDE_DIR_ft2build - Only if building with Freetype2; directory that contains ft2build.h
185 FREETYPE_LIBRARY - Only if building with Freetype2; path to libfreetype.a/libfreetype.so/freetype.lib
186 FREETYPE_DLL - Only if building with Freetype2 on Windows; path to libfreetype.dll
187 GETTEXT_DLL - Only when building with Gettext on Windows; path to libintl3.dll
188 GETTEXT_ICONV_DLL - Only when building with Gettext on Windows; path to libiconv2.dll
189 GETTEXT_INCLUDE_DIR - Only when building with Gettext; directory that contains iconv.h
190 GETTEXT_LIBRARY - Only when building with Gettext on Windows; path to libintl.dll.a
191 GETTEXT_MSGFMT - Only when building with Gettext; path to msgfmt/msgfmt.exe
192 IRRLICHT_DLL - path to Irrlicht.dll
193 IRRLICHT_INCLUDE_DIR - directory that contains IrrCompileConfig.h
194 IRRLICHT_LIBRARY - path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a
195 LEVELDB_INCLUDE_DIR - Only when building with LevelDB; directory that contains db.h
196 LEVELDB_LIBRARY - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll.a
197 LEVELDB_DLL - Only when building with LevelDB on Windows; path to libleveldb.dll
198 REDIS_INCLUDE_DIR - Only when building with Redis support; directory that contains hiredis.h
199 REDIS_LIBRARY - Only when building with Redis support; path to libhiredis.a/libhiredis.so
200 LUA_INCLUDE_DIR - Only if you want to use LuaJIT; directory where luajit.h is located
201 LUA_LIBRARY - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
202 MINGWM10_DLL - Only if compiling with MinGW; path to mingwm10.dll
203 OGG_DLL - Only if building with sound on Windows; path to libogg.dll
204 OGG_INCLUDE_DIR - Only if building with sound; directory that contains an ogg directory which contains ogg.h
205 OGG_LIBRARY - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
206 OPENAL_DLL - Only if building with sound on Windows; path to OpenAL32.dll
207 OPENAL_INCLUDE_DIR - Only if building with sound; directory where al.h is located
208 OPENAL_LIBRARY - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
209 OPENGLES2_INCLUDE_DIR - Only if building with GLES; directory that contains gl2.h
210 OPENGLES2_LIBRARY - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
211 SQLITE3_INCLUDE_DIR - Only if you want to use SQLite from your OS; directory that contains sqlite3.h
212 SQLITE3_LIBRARY - Only if you want to use the SQLite from your OS; path to libsqlite3.a/libsqlite3.so
213 VORBISFILE_DLL - Only if building with sound on Windows; path to libvorbisfile-3.dll
214 VORBISFILE_LIBRARY - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
215 VORBIS_DLL - Only if building with sound on Windows; path to libvorbis-0.dll
216 VORBIS_INCLUDE_DIR - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
217 VORBIS_LIBRARY - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
218 XXF86VM_LIBRARY - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
219 ZLIB_DLL - Only on Windows; path to zlib1.dll
220 ZLIBWAPI_DLL - Only on Windows; path to zlibwapi.dll
221 ZLIB_INCLUDE_DIR - directory where zlib.h is located
222 ZLIB_LIBRARY - path to libz.a/libz.so/zlibwapi.lib
224 Compiling on Windows:
225 ---------------------
226 - This section is outdated. In addition to what is described here:
227 - In addition to minetest, you need to download minetest_game.
228 - If you wish to have sound support, you need libogg, libvorbis and libopenal
232 http://www.cmake.org/cmake/resources/software.html
233 * MinGW or Visual Studio
234 http://www.mingw.org/
235 http://msdn.microsoft.com/en-us/vstudio/default
237 http://irrlicht.sourceforge.net/downloads.html
238 * Zlib headers (zlib125.zip)
239 http://www.winimage.com/zLibDll/index.html
240 * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
241 http://www.winimage.com/zLibDll/index.html
242 * Optional: gettext library and tools:
243 http://gnuwin32.sourceforge.net/downlinks/gettext.php
244 - This is used for other UI languages. Feel free to leave it out.
245 * And, of course, Minetest:
246 http://minetest.net/download
248 - Select a directory called DIR hereafter in which you will operate.
249 - Make sure you have CMake and a compiler installed.
250 - Download all the other stuff to DIR and extract them into there.
251 ("extract here", not "extract to packagename/")
252 NOTE: zlib125dll.zip needs to be extracted into zlib125dll
253 - All those packages contain a nice base directory in them, which
254 should end up being the direct subdirectories of DIR.
255 - You will end up with a directory structure like this (+=dir, -=file):
261 - 110214175330.zip (or whatever, this is the minetest source)
284 - Start up the CMake GUI
285 - Select "Browse Source..." and select DIR/minetest
286 - Now, if using MSVC:
287 - Select "Browse Build..." and select DIR/minetest-build
288 - Else if using MinGW:
289 - Select "Browse Build..." and select DIR/minetest
291 - Select your compiler
292 - It will warn about missing stuff, ignore that at this point. (later don't)
293 - Make sure the configuration is as follows
294 (note that the versions may differ for you):
298 CMAKE_BUILD_TYPE Release
299 CMAKE_INSTALL_PREFIX DIR/minetest-install
300 IRRLICHT_SOURCE_DIR DIR/irrlicht-1.7.1
303 ZLIB_DLL DIR/zlib125dll/dll32/zlibwapi.dll
304 ZLIB_INCLUDE_DIR DIR/zlib-1.2.5
305 ZLIB_LIBRARIES DIR/zlib125dll/dll32/zlibwapi.lib
306 GETTEXT_BIN_DIR DIR/gettext/bin
307 GETTEXT_INCLUDE_DIR DIR/gettext/include
308 GETTEXT_LIBRARIES DIR/gettext/lib/intl.lib
309 GETTEXT_MSGFMT DIR/gettext/bin/msgfmt
312 - Hit "Configure" once again 8)
313 - If something is still coloured red, you have a problem.
316 - Open the generated minetest.sln
317 - The project defaults to the "Debug" configuration. Make very sure to
318 select "Release", unless you want to debug some stuff (it's slower
319 and might not even work at all)
320 - Build the ALL_BUILD project
321 - Build the INSTALL project
322 - You should now have a working game with the executable in
323 DIR/minetest-install/bin/minetest.exe
324 - Additionally you may create a zip package by building the PACKAGE
327 - Using the command line, browse to the build directory and run 'make'
328 (or mingw32-make or whatever it happens to be)
329 - You may need to copy some of the downloaded DLLs into bin/, see what
330 running the produced executable tells you it doesn't have.
331 - You should now have a working game with the executable in
332 DIR/minetest/bin/minetest.exe
334 Windows releases of minetest are built using a bat script like this:
335 --------------------------------------------------------------------
338 set installpath="C:\tmp\minetest_install"
339 set irrlichtpath="C:\tmp\irrlicht-1.7.2"
341 set builddir=%sourcedir%\bvc10
344 cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=TRUE -DCMAKE_INSTALL_PREFIX=%installpath%
345 if %errorlevel% neq 0 goto fail
346 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
347 if %errorlevel% neq 0 goto fail
348 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
349 if %errorlevel% neq 0 goto fail
350 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
351 if %errorlevel% neq 0 goto fail
361 License of Minetest textures and sounds
362 ---------------------------------------
364 This applies to textures and sounds contained in the main Minetest
367 Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
368 http://creativecommons.org/licenses/by-sa/3.0/
370 Authors of media files
371 -----------------------
372 Everything not listed in here:
373 Copyright (C) 2010-2012 celeron55, Perttu Ahola <celeron55@gmail.com>
376 textures/base/pack/menuheader.png
379 misc/minetest-icon-24x24.png
380 misc/minetest-icon.ico
381 misc/minetest-icon.svg
382 textures/base/pack/logo.png
384 License of Minetest source code
385 -------------------------------
388 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
390 This program is free software; you can redistribute it and/or modify
391 it under the terms of the GNU Lesser General Public License as published by
392 the Free Software Foundation; either version 2.1 of the License, or
393 (at your option) any later version.
395 This program is distributed in the hope that it will be useful,
396 but WITHOUT ANY WARRANTY; without even the implied warranty of
397 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
398 GNU Lesser General Public License for more details.
400 You should have received a copy of the GNU Lesser General Public License along
401 with this program; if not, write to the Free Software Foundation, Inc.,
402 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
407 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
409 The Irrlicht Engine License
411 Copyright © 2002-2005 Nikolaus Gebhardt
413 This software is provided 'as-is', without any express or implied
414 warranty. In no event will the authors be held liable for any damages
415 arising from the use of this software.
417 Permission is granted to anyone to use this software for any purpose,
418 including commercial applications, and to alter it and redistribute
419 it freely, subject to the following restrictions:
421 1. The origin of this software must not be misrepresented; you
422 must not claim that you wrote the original software. If you use
423 this software in a product, an acknowledgment in the product
424 documentation would be appreciated but is not required.
425 2. Altered source versions must be plainly marked as such, and must
426 not be misrepresented as being the original software.
427 3. This notice may not be removed or altered from any source
434 This program uses the JThread library. License for JThread follows:
436 Copyright (c) 2000-2006 Jori Liesenborgs (jori.liesenborgs@gmail.com)
438 Permission is hereby granted, free of charge, to any person obtaining a
439 copy of this software and associated documentation files (the "Software"),
440 to deal in the Software without restriction, including without limitation
441 the rights to use, copy, modify, merge, publish, distribute, sublicense,
442 and/or sell copies of the Software, and to permit persons to whom the
443 Software is furnished to do so, subject to the following conditions:
445 The above copyright notice and this permission notice shall be included
446 in all copies or substantial portions of the Software.
448 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
449 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
450 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
451 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
452 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
453 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
459 Lua is licensed under the terms of the MIT license reproduced below.
460 This means that Lua is free software and can be used for both academic
461 and commercial purposes at absolutely no cost.
463 For details and rationale, see http://www.lua.org/license.html .
465 Copyright (C) 1994-2008 Lua.org, PUC-Rio.
467 Permission is hereby granted, free of charge, to any person obtaining a copy
468 of this software and associated documentation files (the "Software"), to deal
469 in the Software without restriction, including without limitation the rights
470 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
471 copies of the Software, and to permit persons to whom the Software is
472 furnished to do so, subject to the following conditions:
474 The above copyright notice and this permission notice shall be included in
475 all copies or substantial portions of the Software.
477 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
478 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
479 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
480 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
481 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
482 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
490 Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
491 Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
493 Bitstream Vera Fonts Copyright:
495 Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
496 a trademark of Bitstream, Inc.
498 Arev Fonts Copyright:
500 Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
502 Liberation Fonts Copyright:
504 Copyright (c) 2007 Red Hat, Inc. All rights reserved. LIBERATION is a trademark of Red Hat, Inc.
508 Copyright (C) 2008 The Android Open Source Project
510 Licensed under the Apache License, Version 2.0 (the "License");
511 you may not use this file except in compliance with the License.
512 You may obtain a copy of the License at
514 http://www.apache.org/licenses/LICENSE-2.0
516 Unless required by applicable law or agreed to in writing, software
517 distributed under the License is distributed on an "AS IS" BASIS,
518 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
519 See the License for the specific language governing permissions and
520 limitations under the License.