4 An InfiniMiner/Minecraft inspired game.
6 Copyright (c) 2010-2017 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.
32 - Move mouse: Look around
35 - Shift: Sneak/move down
37 - Shift + Q: Drop single item
38 - Left mouse button: Dig/punch/take item
39 - Right mouse button: Place/use
40 - Shift + right mouse button: Build (without using)
42 - Mouse wheel: Select item
44 - Z: Zoom (needs zoom privilege)
48 - Esc: Pause menu/abort/exit (pauses only singleplayer game)
49 - R: Enable/disable full range view
50 - +: Increase view range
51 - -: Decrease view range
52 - K: Enable/disable fly mode (needs fly privilege)
53 - J: Enable/disable fast mode (needs fast privilege)
54 - E: Move fast in fast mode
55 - H: Enable/disable noclip mode (needs noclip privilege)
59 - F3: Disable/enable fog
60 - F4: Disable/enable camera update (Mapblocks are not updated anymore when disabled, disabled in release builds)
61 - F5: Cycle through debug info screens
62 - F6: Cycle through profiler info screens
63 - F7: Cycle through camera modes
64 - F8: Toggle cinematic mode
65 - F9: Cycle through minimap modes
66 - Shift + F9: Change minimap orientation
67 - F10: Show/hide console
68 - F12: Take screenshot
69 - P: Write stack traces into debug.txt
71 Most controls are settable in the configuration file, see the section below.
75 $bin - Compiled binaries
76 $share - Distributed read-only data
77 $user - User-created modifiable data
79 Windows .zip / RUN_IN_PLACE source:
86 $share = /usr/share/minetest
91 $share = Contents/Resources
92 $user = Contents/User OR ~/Library/Application Support/minetest
96 - Worlds can be found as separate folders in:
103 - It is created by Minetest when it is ran the first time.
104 - A specific file can be specified on the command line:
105 --config <path-to-file>
106 - A run-in-place build will look for the configuration file in
107 $location_of_exe/../minetest.conf and also $location_of_exe/../../minetest.conf
109 Command-line options:
110 ---------------------
113 Compiling on GNU/Linux:
114 -----------------------
116 Install dependencies. Here's an example for Debian/Ubuntu:
117 $ sudo apt-get install build-essential libirrlicht-dev cmake libbz2-dev libpng-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
120 $ sudo dnf install make automake gcc gcc-c++ kernel-devel cmake libcurl* openal* libvorbis* libXxf86vm-devel libogg-devel freetype-devel mesa-libGL-devel zlib-devel jsoncpp-devel irrlicht-devel bzip2-libs gmp-devel sqlite-devel luajit-devel leveldb-devel ncurses-devel doxygen spatialindex-devel bzip2-devel
122 You can install git for easily keeping your copy up to date.
123 If you don’t want git, read below on how to get the source without git.
124 This is an example for installing git on Debian/Ubuntu:
125 $ sudo apt-get install git
128 $ sudo dnf install git
130 Download source (this is the URL to the latest of source repository, which might not work at all times) using git:
131 $ git clone --depth 1 https://github.com/minetest/minetest.git
134 Download minetest_game (otherwise only the "Minimal development test" game is available) using git:
135 $ git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game
137 Download source, without using git:
138 $ wget https://github.com/minetest/minetest/archive/master.tar.gz
139 $ tar xf master.tar.gz
142 Download minetest_game, without using git:
144 $ wget https://github.com/minetest/minetest_game/archive/master.tar.gz
145 $ tar xf master.tar.gz
146 $ mv minetest_game-master minetest_game
149 Build a version that runs directly from the source directory:
150 $ cmake . -DRUN_IN_PLACE=TRUE
151 $ make -j <number of processors>
156 - Use cmake . -LH to see all CMake options and their current state
157 - If you want to install it system-wide (or are making a distribution package),
158 you will want to use -DRUN_IN_PLACE=FALSE
159 - You can build a bare server by specifying -DBUILD_SERVER=TRUE
160 - You can disable the client build by specifying -DBUILD_CLIENT=FALSE
161 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
162 - Debug build is slower, but gives much more useful output in a debugger
163 - If you build a bare server, you don't need to have Irrlicht installed.
164 In that case use -DIRRLICHT_SOURCE_DIR=/the/irrlicht/source
170 BUILD_CLIENT - Build Minetest client
171 BUILD_SERVER - Build Minetest server
172 CMAKE_BUILD_TYPE - Type of build (Release vs. Debug)
173 Release - Release build
175 SemiDebug - Partially optimized debug build
176 RelWithDebInfo - Release build with Debug information
177 MinSizeRel - Release build with -Os passed to compiler to make executable as small as possible
178 ENABLE_CURL - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
179 ENABLE_CURSES - Build with (n)curses; Enables a server side terminal (command line option: --terminal)
180 ENABLE_FREETYPE - Build with FreeType2; Allows using TTF fonts
181 ENABLE_GETTEXT - Build with Gettext; Allows using translations
182 ENABLE_GLES - Search for Open GLES headers & libraries and use them
183 ENABLE_LEVELDB - Build with LevelDB; Enables use of LevelDB map backend
184 ENABLE_POSTGRESQL - Build with libpq; Enables use of PostgreSQL map backend (PostgreSQL 9.5 or greater recommended)
185 ENABLE_REDIS - Build with libhiredis; Enables use of Redis map backend
186 ENABLE_SPATIAL - Build with LibSpatial; Speeds up AreaStores
187 ENABLE_SOUND - Build with OpenAL, libogg & libvorbis; in-game Sounds
188 ENABLE_LUAJIT - Build with LuaJIT (much faster than non-JIT Lua)
189 ENABLE_SYSTEM_GMP - Use GMP from system (much faster than bundled mini-gmp)
190 RUN_IN_PLACE - Create a portable install (worlds, settings etc. in current directory)
191 USE_GPROF - Enable profiling using GProf
192 VERSION_EXTRA - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
194 Library specific options:
196 BZIP2_INCLUDE_DIR - Linux only; directory where bzlib.h is located
197 BZIP2_LIBRARY - Linux only; path to libbz2.a/libbz2.so
198 CURL_DLL - Only if building with cURL on Windows; path to libcurl.dll
199 CURL_INCLUDE_DIR - Only if building with cURL; directory where curl.h is located
200 CURL_LIBRARY - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
201 EGL_INCLUDE_DIR - Only if building with GLES; directory that contains egl.h
202 EGL_LIBRARY - Only if building with GLES; path to libEGL.a/libEGL.so
203 FREETYPE_INCLUDE_DIR_freetype2 - Only if building with Freetype2; directory that contains an freetype directory with files such as ftimage.h in it
204 FREETYPE_INCLUDE_DIR_ft2build - Only if building with Freetype2; directory that contains ft2build.h
205 FREETYPE_LIBRARY - Only if building with Freetype2; path to libfreetype.a/libfreetype.so/freetype.lib
206 FREETYPE_DLL - Only if building with Freetype2 on Windows; path to libfreetype.dll
207 GETTEXT_DLL - Only when building with Gettext on Windows; path to libintl3.dll
208 GETTEXT_ICONV_DLL - Only when building with Gettext on Windows; path to libiconv2.dll
209 GETTEXT_INCLUDE_DIR - Only when building with Gettext; directory that contains iconv.h
210 GETTEXT_LIBRARY - Only when building with Gettext on Windows; path to libintl.dll.a
211 GETTEXT_MSGFMT - Only when building with Gettext; path to msgfmt/msgfmt.exe
212 IRRLICHT_DLL - Only on Windows; path to Irrlicht.dll
213 IRRLICHT_INCLUDE_DIR - Directory that contains IrrCompileConfig.h
214 IRRLICHT_LIBRARY - Path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a/Irrlicht.lib
215 LEVELDB_INCLUDE_DIR - Only when building with LevelDB; directory that contains db.h
216 LEVELDB_LIBRARY - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll.a
217 LEVELDB_DLL - Only when building with LevelDB on Windows; path to libleveldb.dll
218 PostgreSQL_INCLUDE_DIR - Only when building with PostgreSQL; directory that contains libpq-fe.h
219 POSTGRESQL_LIBRARY - Only when building with PostgreSQL; path to libpq.a/libpq.so
220 REDIS_INCLUDE_DIR - Only when building with Redis; directory that contains hiredis.h
221 REDIS_LIBRARY - Only when building with Redis; path to libhiredis.a/libhiredis.so
222 SPATIAL_INCLUDE_DIR - Only when building with LibSpatial; directory that contains spatialindex/SpatialIndex.h
223 SPATIAL_LIBRARY - Only when building with LibSpatial; path to libspatialindex_c.so/spatialindex-32.lib
224 LUA_INCLUDE_DIR - Only if you want to use LuaJIT; directory where luajit.h is located
225 LUA_LIBRARY - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
226 MINGWM10_DLL - Only if compiling with MinGW; path to mingwm10.dll
227 OGG_DLL - Only if building with sound on Windows; path to libogg.dll
228 OGG_INCLUDE_DIR - Only if building with sound; directory that contains an ogg directory which contains ogg.h
229 OGG_LIBRARY - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
230 OPENAL_DLL - Only if building with sound on Windows; path to OpenAL32.dll
231 OPENAL_INCLUDE_DIR - Only if building with sound; directory where al.h is located
232 OPENAL_LIBRARY - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
233 OPENGLES2_INCLUDE_DIR - Only if building with GLES; directory that contains gl2.h
234 OPENGLES2_LIBRARY - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
235 SQLITE3_INCLUDE_DIR - Directory that contains sqlite3.h
236 SQLITE3_LIBRARY - Path to libsqlite3.a/libsqlite3.so/sqlite3.lib
237 VORBISFILE_DLL - Only if building with sound on Windows; path to libvorbisfile-3.dll
238 VORBISFILE_LIBRARY - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
239 VORBIS_DLL - Only if building with sound on Windows; path to libvorbis-0.dll
240 VORBIS_INCLUDE_DIR - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
241 VORBIS_LIBRARY - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
242 XXF86VM_LIBRARY - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
243 ZLIB_DLL - Only on Windows; path to zlib1.dll
244 ZLIBWAPI_DLL - Only on Windows; path to zlibwapi.dll
245 ZLIB_INCLUDE_DIR - Directory that contains zlib.h
246 ZLIB_LIBRARY - Path to libz.a/libz.so/zlibwapi.lib
248 Compiling on Windows:
249 ---------------------
250 - This section is outdated. In addition to what is described here:
251 - In addition to minetest, you need to download minetest_game.
252 - If you wish to have sound support, you need libogg, libvorbis and libopenal
256 http://www.cmake.org/cmake/resources/software.html
257 * MinGW or Visual Studio
258 http://www.mingw.org/
259 http://msdn.microsoft.com/en-us/vstudio/default
261 http://irrlicht.sourceforge.net/downloads.html
262 * Zlib headers (zlib125.zip)
263 http://www.winimage.com/zLibDll/index.html
264 * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
265 http://www.winimage.com/zLibDll/index.html
266 * SQLite3 headers and library
267 https://www.sqlite.org/download.html
268 * Optional: gettext library and tools:
269 http://gnuwin32.sourceforge.net/downlinks/gettext.php
270 - This is used for other UI languages. Feel free to leave it out.
271 * And, of course, Minetest:
272 http://minetest.net/download
274 - Select a directory called DIR hereafter in which you will operate.
275 - Make sure you have CMake and a compiler installed.
276 - Download all the other stuff to DIR and extract them into there.
277 ("extract here", not "extract to packagename/")
278 NOTE: zlib125dll.zip needs to be extracted into zlib125dll
279 NOTE: You need to extract sqlite3.h & sqlite3ext.h from sqlite3 source
280 and sqlite3.dll & sqlite3.def from sqlite3 precompiled binaries
281 into "sqlite3" directory, and generate sqlite3.lib using command
282 "LIB /DEF:sqlite3.def /OUT:sqlite3.lib"
283 - All those packages contain a nice base directory in them, which
284 should end up being the direct subdirectories of DIR.
285 - You will end up with a directory structure like this (+=dir, -=file):
291 - sqlite-amalgamation-3130000.zip (SQLite3 headers)
292 - sqlite-dll-win32-x86-3130000.zip (SQLite3 library for 32bit system)
293 - 110214175330.zip (or whatever, this is the minetest source)
321 - Start up the CMake GUI
322 - Select "Browse Source..." and select DIR/minetest
323 - Now, if using MSVC:
324 - Select "Browse Build..." and select DIR/minetest-build
325 - Else if using MinGW:
326 - Select "Browse Build..." and select DIR/minetest
328 - Select your compiler
329 - It will warn about missing stuff, ignore that at this point. (later don't)
330 - Make sure the configuration is as follows
331 (note that the versions may differ for you):
335 CMAKE_BUILD_TYPE Release
336 CMAKE_INSTALL_PREFIX DIR/minetest-install
337 IRRLICHT_SOURCE_DIR DIR/irrlicht-1.8.3
340 ZLIB_DLL DIR/zlib125dll/dll32/zlibwapi.dll
341 ZLIB_INCLUDE_DIR DIR/zlib-1.2.5
342 ZLIB_LIBRARIES DIR/zlib125dll/dll32/zlibwapi.lib
343 GETTEXT_BIN_DIR DIR/gettext/bin
344 GETTEXT_INCLUDE_DIR DIR/gettext/include
345 GETTEXT_LIBRARIES DIR/gettext/lib/intl.lib
346 GETTEXT_MSGFMT DIR/gettext/bin/msgfmt
348 - If CMake complains it couldn't find SQLITE3, choose "Advanced" box on the
349 right top corner, then specify the location of SQLITE3_INCLUDE_DIR and
350 SQLITE3_LIBRARY manually.
351 - If you want to build 64-bit minetest, you will need to build 64-bit version
352 of irrlicht engine manually, as only 32-bit pre-built library is provided.
354 - Hit "Configure" once again 8)
355 - If something is still coloured red, you have a problem.
358 - Open the generated minetest.sln
359 - The project defaults to the "Debug" configuration. Make very sure to
360 select "Release", unless you want to debug some stuff (it's slower
361 and might not even work at all)
362 - Build the ALL_BUILD project
363 - Build the INSTALL project
364 - You should now have a working game with the executable in
365 DIR/minetest-install/bin/minetest.exe
366 - Additionally you may create a zip package by building the PACKAGE
369 - Using the command line, browse to the build directory and run 'make'
370 (or mingw32-make or whatever it happens to be)
371 - You may need to copy some of the downloaded DLLs into bin/, see what
372 running the produced executable tells you it doesn't have.
373 - You should now have a working game with the executable in
374 DIR/minetest/bin/minetest.exe
376 Windows releases of minetest are built using a bat script like this:
377 --------------------------------------------------------------------
380 set installpath="C:\tmp\minetest_install"
381 set irrlichtpath="C:\tmp\irrlicht-1.7.2"
383 set builddir=%sourcedir%\bvc10
386 cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=TRUE -DCMAKE_INSTALL_PREFIX=%installpath%
387 if %errorlevel% neq 0 goto fail
388 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
389 if %errorlevel% neq 0 goto fail
390 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
391 if %errorlevel% neq 0 goto fail
392 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
393 if %errorlevel% neq 0 goto fail
403 License of Minetest textures and sounds
404 ---------------------------------------
406 This applies to textures and sounds contained in the main Minetest
409 Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
410 http://creativecommons.org/licenses/by-sa/3.0/
412 Authors of media files
413 -----------------------
414 Everything not listed in here:
415 Copyright (C) 2010-2012 celeron55, Perttu Ahola <celeron55@gmail.com>
418 textures/base/pack/smoke_puff.png
421 textures/base/pack/menu_header.png
424 misc/minetest-icon-24x24.png
425 misc/minetest-icon.ico
427 textures/base/pack/logo.png
430 textures/base/pack/player_marker.png
432 License of Minetest source code
433 -------------------------------
436 Copyright (C) 2010-2017 celeron55, Perttu Ahola <celeron55@gmail.com>
438 This program is free software; you can redistribute it and/or modify
439 it under the terms of the GNU Lesser General Public License as published by
440 the Free Software Foundation; either version 2.1 of the License, or
441 (at your option) any later version.
443 This program is distributed in the hope that it will be useful,
444 but WITHOUT ANY WARRANTY; without even the implied warranty of
445 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
446 GNU Lesser General Public License for more details.
448 You should have received a copy of the GNU Lesser General Public License along
449 with this program; if not, write to the Free Software Foundation, Inc.,
450 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
455 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
457 The Irrlicht Engine License
459 Copyright © 2002-2005 Nikolaus Gebhardt
461 This software is provided 'as-is', without any express or implied
462 warranty. In no event will the authors be held liable for any damages
463 arising from the use of this software.
465 Permission is granted to anyone to use this software for any purpose,
466 including commercial applications, and to alter it and redistribute
467 it freely, subject to the following restrictions:
469 1. The origin of this software must not be misrepresented; you
470 must not claim that you wrote the original software. If you use
471 this software in a product, an acknowledgment in the product
472 documentation would be appreciated but is not required.
473 2. Altered source versions must be plainly marked as such, and must
474 not be misrepresented as being the original software.
475 3. This notice may not be removed or altered from any source
482 This program uses the JThread library. License for JThread follows:
484 Copyright (c) 2000-2006 Jori Liesenborgs (jori.liesenborgs@gmail.com)
486 Permission is hereby granted, free of charge, to any person obtaining a
487 copy of this software and associated documentation files (the "Software"),
488 to deal in the Software without restriction, including without limitation
489 the rights to use, copy, modify, merge, publish, distribute, sublicense,
490 and/or sell copies of the Software, and to permit persons to whom the
491 Software is furnished to do so, subject to the following conditions:
493 The above copyright notice and this permission notice shall be included
494 in all copies or substantial portions of the Software.
496 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
497 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
498 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
499 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
500 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
501 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
507 Lua is licensed under the terms of the MIT license reproduced below.
508 This means that Lua is free software and can be used for both academic
509 and commercial purposes at absolutely no cost.
511 For details and rationale, see https://www.lua.org/license.html .
513 Copyright (C) 1994-2008 Lua.org, PUC-Rio.
515 Permission is hereby granted, free of charge, to any person obtaining a copy
516 of this software and associated documentation files (the "Software"), to deal
517 in the Software without restriction, including without limitation the rights
518 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
519 copies of the Software, and to permit persons to whom the Software is
520 furnished to do so, subject to the following conditions:
522 The above copyright notice and this permission notice shall be included in
523 all copies or substantial portions of the Software.
525 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
526 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
527 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
528 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
529 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
530 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
536 Bitstream Vera Fonts Copyright:
538 Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
539 a trademark of Bitstream, Inc.
541 Arimo - Apache License, version 2.0
542 Digitized data copyright (c) 2010-2012 Google Corporation.
544 Cousine - Apache License, version 2.0
545 Digitized data copyright (c) 2010-2012 Google Corporation.
547 DroidSansFallBackFull:
549 Copyright (C) 2008 The Android Open Source Project
551 Licensed under the Apache License, Version 2.0 (the "License");
552 you may not use this file except in compliance with the License.
553 You may obtain a copy of the License at
555 http://www.apache.org/licenses/LICENSE-2.0
557 Unless required by applicable law or agreed to in writing, software
558 distributed under the License is distributed on an "AS IS" BASIS,
559 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
560 See the License for the specific language governing permissions and
561 limitations under the License.