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 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
109 $ 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
111 You can install git for easily keeping your copy up to date.
112 If you dont want git, read below on how to get the source without git.
113 This is an example for installing git on Debian/Ubuntu:
114 $ sudo apt-get install git
117 $ sudo dnf install git
119 Download source (this is the URL to the latest of source repository, which might not work at all times) using git:
120 $ git clone --depth 1 https://github.com/minetest/minetest.git
123 Download minetest_game (otherwise only the "Minimal development test" game is available) using git:
124 $ git clone --depth 1 https://github.com/minetest/minetest_game.git games/minetest_game
126 Download source, without using git:
127 $ wget https://github.com/minetest/minetest/archive/master.tar.gz
128 $ tar xf master.tar.gz
131 Download minetest_game, without using git:
133 $ wget https://github.com/minetest/minetest_game/archive/master.tar.gz
134 $ tar xf master.tar.gz
135 $ mv minetest_game-master minetest_game
138 Build a version that runs directly from the source directory:
139 $ cmake . -DRUN_IN_PLACE=TRUE
140 $ make -j <number of processors>
145 - Use cmake . -LH to see all CMake options and their current state
146 - If you want to install it system-wide (or are making a distribution package),
147 you will want to use -DRUN_IN_PLACE=FALSE
148 - You can build a bare server by specifying -DBUILD_SERVER=TRUE
149 - You can disable the client build by specifying -DBUILD_CLIENT=FALSE
150 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
151 - Debug build is slower, but gives much more useful output in a debugger
152 - If you build a bare server, you don't need to have Irrlicht installed.
153 In that case use -DIRRLICHT_SOURCE_DIR=/the/irrlicht/source
159 BUILD_CLIENT - Build Minetest client
160 BUILD_SERVER - Build Minetest server
161 CMAKE_BUILD_TYPE - Type of build (Release vs. Debug)
162 Release - Release build
164 SemiDebug - Partially optimized debug build
165 RelWithDebInfo - Release build with Debug information
166 MinSizeRel - Release build with -Os passed to compiler to make executable as small as possible
167 ENABLE_CURL - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
168 ENABLE_CURSES - Build with (n)curses; Enables a server side terminal (command line option: --terminal)
169 ENABLE_FREETYPE - Build with FreeType2; Allows using TTF fonts
170 ENABLE_GETTEXT - Build with Gettext; Allows using translations
171 ENABLE_GLES - Search for Open GLES headers & libraries and use them
172 ENABLE_LEVELDB - Build with LevelDB; Enables use of LevelDB map backend
173 ENABLE_POSTGRESQL - Build with libpq; Enables use of PostgreSQL map backend (PostgreSQL 9.5 or greater required)
174 ENABLE_REDIS - Build with libhiredis; Enables use of Redis map backend
175 ENABLE_SPATIAL - Build with LibSpatial; Speeds up AreaStores
176 ENABLE_SOUND - Build with OpenAL, libogg & libvorbis; in-game Sounds
177 ENABLE_LUAJIT - Build with LuaJIT (much faster than non-JIT Lua)
178 ENABLE_SYSTEM_GMP - Use GMP from system (much faster than bundled mini-gmp)
179 RUN_IN_PLACE - Create a portable install (worlds, settings etc. in current directory)
180 USE_GPROF - Enable profiling using GProf
181 VERSION_EXTRA - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
183 Library specific options:
185 BZIP2_INCLUDE_DIR - Linux only; directory where bzlib.h is located
186 BZIP2_LIBRARY - Linux only; path to libbz2.a/libbz2.so
187 CURL_DLL - Only if building with cURL on Windows; path to libcurl.dll
188 CURL_INCLUDE_DIR - Only if building with cURL; directory where curl.h is located
189 CURL_LIBRARY - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
190 EGL_INCLUDE_DIR - Only if building with GLES; directory that contains egl.h
191 EGL_LIBRARY - Only if building with GLES; path to libEGL.a/libEGL.so
192 FREETYPE_INCLUDE_DIR_freetype2 - Only if building with Freetype2; directory that contains an freetype directory with files such as ftimage.h in it
193 FREETYPE_INCLUDE_DIR_ft2build - Only if building with Freetype2; directory that contains ft2build.h
194 FREETYPE_LIBRARY - Only if building with Freetype2; path to libfreetype.a/libfreetype.so/freetype.lib
195 FREETYPE_DLL - Only if building with Freetype2 on Windows; path to libfreetype.dll
196 GETTEXT_DLL - Only when building with Gettext on Windows; path to libintl3.dll
197 GETTEXT_ICONV_DLL - Only when building with Gettext on Windows; path to libiconv2.dll
198 GETTEXT_INCLUDE_DIR - Only when building with Gettext; directory that contains iconv.h
199 GETTEXT_LIBRARY - Only when building with Gettext on Windows; path to libintl.dll.a
200 GETTEXT_MSGFMT - Only when building with Gettext; path to msgfmt/msgfmt.exe
201 IRRLICHT_DLL - Only on Windows; path to Irrlicht.dll
202 IRRLICHT_INCLUDE_DIR - Directory that contains IrrCompileConfig.h
203 IRRLICHT_LIBRARY - Path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a/Irrlicht.lib
204 LEVELDB_INCLUDE_DIR - Only when building with LevelDB; directory that contains db.h
205 LEVELDB_LIBRARY - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll.a
206 LEVELDB_DLL - Only when building with LevelDB on Windows; path to libleveldb.dll
207 POSTGRESQL_INCLUDE_DIR - Only when building with PostgreSQL; directory that contains libpq-fe.h
208 POSTGRESQL_LIBRARY - Only when building with PostgreSQL; path to libpq.a/libpq.so
209 REDIS_INCLUDE_DIR - Only when building with Redis; directory that contains hiredis.h
210 REDIS_LIBRARY - Only when building with Redis; path to libhiredis.a/libhiredis.so
211 SPATIAL_INCLUDE_DIR - Only when building with LibSpatial; directory that contains spatialindex/SpatialIndex.h
212 SPATIAL_LIBRARY - Only when building with LibSpatial; path to libspatialindex_c.so/spatialindex-32.lib
213 LUA_INCLUDE_DIR - Only if you want to use LuaJIT; directory where luajit.h is located
214 LUA_LIBRARY - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
215 MINGWM10_DLL - Only if compiling with MinGW; path to mingwm10.dll
216 OGG_DLL - Only if building with sound on Windows; path to libogg.dll
217 OGG_INCLUDE_DIR - Only if building with sound; directory that contains an ogg directory which contains ogg.h
218 OGG_LIBRARY - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
219 OPENAL_DLL - Only if building with sound on Windows; path to OpenAL32.dll
220 OPENAL_INCLUDE_DIR - Only if building with sound; directory where al.h is located
221 OPENAL_LIBRARY - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
222 OPENGLES2_INCLUDE_DIR - Only if building with GLES; directory that contains gl2.h
223 OPENGLES2_LIBRARY - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
224 SQLITE3_INCLUDE_DIR - Directory that contains sqlite3.h
225 SQLITE3_LIBRARY - Path to libsqlite3.a/libsqlite3.so/sqlite3.lib
226 VORBISFILE_DLL - Only if building with sound on Windows; path to libvorbisfile-3.dll
227 VORBISFILE_LIBRARY - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
228 VORBIS_DLL - Only if building with sound on Windows; path to libvorbis-0.dll
229 VORBIS_INCLUDE_DIR - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
230 VORBIS_LIBRARY - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
231 XXF86VM_LIBRARY - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
232 ZLIB_DLL - Only on Windows; path to zlib1.dll
233 ZLIBWAPI_DLL - Only on Windows; path to zlibwapi.dll
234 ZLIB_INCLUDE_DIR - Directory that contains zlib.h
235 ZLIB_LIBRARY - Path to libz.a/libz.so/zlibwapi.lib
237 Compiling on Windows:
238 ---------------------
239 - This section is outdated. In addition to what is described here:
240 - In addition to minetest, you need to download minetest_game.
241 - If you wish to have sound support, you need libogg, libvorbis and libopenal
245 http://www.cmake.org/cmake/resources/software.html
246 * MinGW or Visual Studio
247 http://www.mingw.org/
248 http://msdn.microsoft.com/en-us/vstudio/default
250 http://irrlicht.sourceforge.net/downloads.html
251 * Zlib headers (zlib125.zip)
252 http://www.winimage.com/zLibDll/index.html
253 * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
254 http://www.winimage.com/zLibDll/index.html
255 * SQLite3 headers and library
256 https://www.sqlite.org/download.html
257 * Optional: gettext library and tools:
258 http://gnuwin32.sourceforge.net/downlinks/gettext.php
259 - This is used for other UI languages. Feel free to leave it out.
260 * And, of course, Minetest:
261 http://minetest.net/download
263 - Select a directory called DIR hereafter in which you will operate.
264 - Make sure you have CMake and a compiler installed.
265 - Download all the other stuff to DIR and extract them into there.
266 ("extract here", not "extract to packagename/")
267 NOTE: zlib125dll.zip needs to be extracted into zlib125dll
268 NOTE: You need to extract sqlite3.h & sqlite3ext.h from sqlite3 source
269 and sqlite3.dll & sqlite3.def from sqlite3 precompiled binaries
270 into "sqlite3" directory, and generate sqlite3.lib using command
271 "LIB /DEF:sqlite3.def /OUT:sqlite3.lib"
272 - All those packages contain a nice base directory in them, which
273 should end up being the direct subdirectories of DIR.
274 - You will end up with a directory structure like this (+=dir, -=file):
280 - sqlite-amalgamation-3130000.zip (SQLite3 headers)
281 - sqlite-dll-win32-x86-3130000.zip (SQLite3 library for 32bit system)
282 - 110214175330.zip (or whatever, this is the minetest source)
310 - Start up the CMake GUI
311 - Select "Browse Source..." and select DIR/minetest
312 - Now, if using MSVC:
313 - Select "Browse Build..." and select DIR/minetest-build
314 - Else if using MinGW:
315 - Select "Browse Build..." and select DIR/minetest
317 - Select your compiler
318 - It will warn about missing stuff, ignore that at this point. (later don't)
319 - Make sure the configuration is as follows
320 (note that the versions may differ for you):
324 CMAKE_BUILD_TYPE Release
325 CMAKE_INSTALL_PREFIX DIR/minetest-install
326 IRRLICHT_SOURCE_DIR DIR/irrlicht-1.8.3
329 ZLIB_DLL DIR/zlib125dll/dll32/zlibwapi.dll
330 ZLIB_INCLUDE_DIR DIR/zlib-1.2.5
331 ZLIB_LIBRARIES DIR/zlib125dll/dll32/zlibwapi.lib
332 GETTEXT_BIN_DIR DIR/gettext/bin
333 GETTEXT_INCLUDE_DIR DIR/gettext/include
334 GETTEXT_LIBRARIES DIR/gettext/lib/intl.lib
335 GETTEXT_MSGFMT DIR/gettext/bin/msgfmt
337 - If CMake complains it couldn't find SQLITE3, choose "Advanced" box on the
338 right top corner, then specify the location of SQLITE3_INCLUDE_DIR and
339 SQLITE3_LIBRARY manually.
340 - If you want to build 64-bit minetest, you will need to build 64-bit version
341 of irrlicht engine manually, as only 32-bit pre-built library is provided.
343 - Hit "Configure" once again 8)
344 - If something is still coloured red, you have a problem.
347 - Open the generated minetest.sln
348 - The project defaults to the "Debug" configuration. Make very sure to
349 select "Release", unless you want to debug some stuff (it's slower
350 and might not even work at all)
351 - Build the ALL_BUILD project
352 - Build the INSTALL project
353 - You should now have a working game with the executable in
354 DIR/minetest-install/bin/minetest.exe
355 - Additionally you may create a zip package by building the PACKAGE
358 - Using the command line, browse to the build directory and run 'make'
359 (or mingw32-make or whatever it happens to be)
360 - You may need to copy some of the downloaded DLLs into bin/, see what
361 running the produced executable tells you it doesn't have.
362 - You should now have a working game with the executable in
363 DIR/minetest/bin/minetest.exe
365 Windows releases of minetest are built using a bat script like this:
366 --------------------------------------------------------------------
369 set installpath="C:\tmp\minetest_install"
370 set irrlichtpath="C:\tmp\irrlicht-1.7.2"
372 set builddir=%sourcedir%\bvc10
375 cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=TRUE -DCMAKE_INSTALL_PREFIX=%installpath%
376 if %errorlevel% neq 0 goto fail
377 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
378 if %errorlevel% neq 0 goto fail
379 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
380 if %errorlevel% neq 0 goto fail
381 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
382 if %errorlevel% neq 0 goto fail
392 License of Minetest textures and sounds
393 ---------------------------------------
395 This applies to textures and sounds contained in the main Minetest
398 Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
399 http://creativecommons.org/licenses/by-sa/3.0/
401 Authors of media files
402 -----------------------
403 Everything not listed in here:
404 Copyright (C) 2010-2012 celeron55, Perttu Ahola <celeron55@gmail.com>
407 textures/base/pack/menu_header.png
410 misc/minetest-icon-24x24.png
411 misc/minetest-icon.ico
413 textures/base/pack/logo.png
415 License of Minetest source code
416 -------------------------------
419 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
421 This program is free software; you can redistribute it and/or modify
422 it under the terms of the GNU Lesser General Public License as published by
423 the Free Software Foundation; either version 2.1 of the License, or
424 (at your option) any later version.
426 This program is distributed in the hope that it will be useful,
427 but WITHOUT ANY WARRANTY; without even the implied warranty of
428 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
429 GNU Lesser General Public License for more details.
431 You should have received a copy of the GNU Lesser General Public License along
432 with this program; if not, write to the Free Software Foundation, Inc.,
433 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
438 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
440 The Irrlicht Engine License
442 Copyright © 2002-2005 Nikolaus Gebhardt
444 This software is provided 'as-is', without any express or implied
445 warranty. In no event will the authors be held liable for any damages
446 arising from the use of this software.
448 Permission is granted to anyone to use this software for any purpose,
449 including commercial applications, and to alter it and redistribute
450 it freely, subject to the following restrictions:
452 1. The origin of this software must not be misrepresented; you
453 must not claim that you wrote the original software. If you use
454 this software in a product, an acknowledgment in the product
455 documentation would be appreciated but is not required.
456 2. Altered source versions must be plainly marked as such, and must
457 not be misrepresented as being the original software.
458 3. This notice may not be removed or altered from any source
465 This program uses the JThread library. License for JThread follows:
467 Copyright (c) 2000-2006 Jori Liesenborgs (jori.liesenborgs@gmail.com)
469 Permission is hereby granted, free of charge, to any person obtaining a
470 copy of this software and associated documentation files (the "Software"),
471 to deal in the Software without restriction, including without limitation
472 the rights to use, copy, modify, merge, publish, distribute, sublicense,
473 and/or sell copies of the Software, and to permit persons to whom the
474 Software is furnished to do so, subject to the following conditions:
476 The above copyright notice and this permission notice shall be included
477 in all copies or substantial portions of the Software.
479 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
480 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
481 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
482 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
483 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
484 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
490 Lua is licensed under the terms of the MIT license reproduced below.
491 This means that Lua is free software and can be used for both academic
492 and commercial purposes at absolutely no cost.
494 For details and rationale, see http://www.lua.org/license.html .
496 Copyright (C) 1994-2008 Lua.org, PUC-Rio.
498 Permission is hereby granted, free of charge, to any person obtaining a copy
499 of this software and associated documentation files (the "Software"), to deal
500 in the Software without restriction, including without limitation the rights
501 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
502 copies of the Software, and to permit persons to whom the Software is
503 furnished to do so, subject to the following conditions:
505 The above copyright notice and this permission notice shall be included in
506 all copies or substantial portions of the Software.
508 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
509 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
510 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
511 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
512 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
513 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
521 Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
522 Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
524 Bitstream Vera Fonts Copyright:
526 Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
527 a trademark of Bitstream, Inc.
529 Arev Fonts Copyright:
531 Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
533 Liberation Fonts Copyright:
535 Copyright (c) 2007 Red Hat, Inc. All rights reserved. LIBERATION is a trademark of Red Hat, Inc.
539 Copyright (C) 2008 The Android Open Source Project
541 Licensed under the Apache License, Version 2.0 (the "License");
542 you may not use this file except in compliance with the License.
543 You may obtain a copy of the License at
545 http://www.apache.org/licenses/LICENSE-2.0
547 Unless required by applicable law or agreed to in writing, software
548 distributed under the License is distributed on an "AS IS" BASIS,
549 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
550 See the License for the specific language governing permissions and
551 limitations under the License.