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