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
83 $user = ~/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 $ 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 libcurl4-gnutls-dev libfreetype6-dev
108 Download source, extract (this is the URL to the latest of source repository, which might not work at all times):
109 $ wget https://github.com/minetest/minetest/tarball/master -O master.tar.gz
110 $ tar xf master.tar.gz
111 $ cd minetest-minetest-286edd4 (or similar)
113 Download minetest_game (otherwise only the "Minimal development test" game is available)
115 $ wget https://github.com/minetest/minetest_game/tarball/master -O minetest_game.tar.gz
116 $ tar xf minetest_game.tar.gz
117 $ mv minetest-minetest_game-* minetest_game
120 Build a version that runs directly from the source directory:
121 $ cmake . -DRUN_IN_PLACE=1
128 - Use cmake . -LH to see all CMake options and their current state
129 - If you want to install it system-wide (or are making a distribution package), you will want to use -DRUN_IN_PLACE=0
130 - You can build a bare server or a bare client by specifying -DBUILD_CLIENT=0 or -DBUILD_SERVER=0
131 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
132 - Debug build is slower, but gives much more useful output in a debugger
133 - If you build a bare server, you don't need to have Irrlicht installed. In that case use -DIRRLICHT_SOURCE_DIR=/the/irrlicht/source
139 BUILD_CLIENT - Build Minetest client
140 BUILD_SERVER - Build Minetest server
141 CMAKE_BUILD_TYPE - Type of build (Release vs. Debug)
142 Release - Release build
144 RelWithDebInfo - Release build with Debug information
145 MinSizeRel - Release build with -Os passed to compiler to make executable as small as possible
146 ENABLE_CURL - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
147 ENABLE_FREETYPE - Build with Freetype2; Allows using TTF fonts
148 ENABLE_GETTEXT - Build with Gettext; Allows using translations
149 ENABLE_GLES - Search for Open GLES headers & libraries and use them
150 ENABLE_LEVELDB - Build with LevelDB; Enables use of LevelDB, which is much faster than SQLite, as map backend
151 ENABLE_REDIS - Build with libhiredis; Enables use of redis map backend
152 ENABLE_SOUND - Build with OpenAL, libogg & libvorbis; in-game Sounds
153 DISABLE_LUAJIT - Do not search for LuaJIT headers & library
154 RUN_IN_PLACE - Create a portable install (worlds, settings etc. in current directory)
155 USE_GPROF - Enable profiling using GProf
156 VERSION_EXTRA - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
158 Library specific options:
160 BZIP2_INCLUDE_DIR - Linux only; directory where bzlib.h is located
161 BZIP2_LIBRARY - Linux only; path to libbz2.a/libbz2.so
162 CURL_DLL - Only if building with cURL on Windows; path to libcurl.dll
163 CURL_INCLUDE_DIR - Only if building with cURL; directory where curl.h is located
164 CURL_LIBRARY - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
165 EGL_INCLUDE_DIR - Only if building with GLES; directory that contains egl.h
166 EGL_egl_LIBRARY - Only if building with GLES; path to libEGL.a/libEGL.so
167 FREETYPE_INCLUDE_DIR_freetype2 - Only if building with Freetype2; directory that contains an freetype directory with files such as ftimage.h in it
168 FREETYPE_INCLUDE_DIR_ft2build - Only if building with Freetype2; directory that contains ft2build.h
169 FREETYPE_LIBRARY - Only if building with Freetype2; path to libfreetype.a/libfreetype.so/freetype.lib
170 GETTEXT_DLL - Only when building with Gettext on Windows; path to libintl3.dll
171 GETTEXT_ICONV_DLL - Only when building with Gettext on Windows; path to libiconv2.dll
172 GETTEXT_INCLUDE_DIR - Only when building with Gettext; directory that contains iconv.h
173 GETTEXT_LIBRARY - Only when building with Gettext on Windows; path to libintl.dll.a
174 GETTEXT_MSGFMT - Only when building with Gettext; path to msgfmt/msgfmt.exe
175 IRRLICHT_DLL - path to Irrlicht.dll
176 IRRLICHT_INCLUDE_DIR - directory that contains IrrCompileConfig.h
177 IRRLICHT_LIBRARY - path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a
178 LEVELDB_INCLUDE_DIR - Only when building with LevelDB; directory that contains db.h
179 LEVELDB_LIBRARY - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll
180 REDIS_INCLUDE_DIR - Only when building with redis support; directory that contains hiredis.h
181 REDIS_LIBRARY - Only when building with redis support; path to libhiredis.a/libhiredis.so
182 LUA_INCLUDE_DIR - Only if you want to use LuaJIT; directory where luajit.h is located
183 LUA_LIBRARY - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
184 MINGWM10_DLL - Only if compiling with MinGW; path to mingwm10.dll
185 OGG_DLL - Only if building with sound on Windows; path to libogg.dll
186 OGG_INCLUDE_DIR - Only if building with sound; directory that contains an ogg directory which contains ogg.h
187 OGG_LIBRARY - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
188 OPENAL_DLL - Only if building with sound on Windows; path to OpenAL32.dll
189 OPENAL_INCLUDE_DIR - Only if building with sound; directory where al.h is located
190 OPENAL_LIBRARY - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
191 OPENGLES2_INCLUDE_DIR - Only if building with GLES; directory that contains gl2.h
192 OPENGLES2_gl_LIBRARY - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
193 SQLITE3_INCLUDE_DIR - Only if you want to use SQLite from your OS; directory that contains sqlite3.h
194 SQLITE3_LIBRARY - Only if you want to use the SQLite from your OS; path to libsqlite3.a/libsqlite3.so
195 VORBISFILE_DLL - Only if building with sound on Windows; path to libvorbisfile-3.dll
196 VORBISFILE_LIBRARY - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
197 VORBIS_DLL - Only if building with sound on Windows; path to libvorbis-0.dll
198 VORBIS_INCLUDE_DIR - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
199 VORBIS_LIBRARY - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
200 XXF86VM_LIBRARY - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
201 ZLIB_DLL - Only on Windows; path to zlibwapi.dll
202 ZLIB_INCLUDE_DIR - directory where zlib.h is located
203 ZLIB_LIBRARY - path to libz.a/libz.so/zlibwapi.lib
205 Compiling on Windows:
206 ---------------------
207 - This section is outdated. In addition to what is described here:
208 - In addition to minetest, you need to download minetest_game.
209 - If you wish to have sound support, you need libogg, libvorbis and libopenal
213 http://www.cmake.org/cmake/resources/software.html
214 * MinGW or Visual Studio
215 http://www.mingw.org/
216 http://msdn.microsoft.com/en-us/vstudio/default
218 http://irrlicht.sourceforge.net/downloads.html
219 * Zlib headers (zlib125.zip)
220 http://www.winimage.com/zLibDll/index.html
221 * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
222 http://www.winimage.com/zLibDll/index.html
223 * Optional: gettext library and tools:
224 http://gnuwin32.sourceforge.net/downlinks/gettext.php
225 - This is used for other UI languages. Feel free to leave it out.
226 * And, of course, Minetest:
227 http://minetest.net/download.php
229 - Select a directory called DIR hereafter in which you will operate.
230 - Make sure you have CMake and a compiler installed.
231 - Download all the other stuff to DIR and extract them into there.
232 ("extract here", not "extract to packagename/")
233 NOTE: zlib125dll.zip needs to be extracted into zlib125dll
234 - All those packages contain a nice base directory in them, which
235 should end up being the direct subdirectories of DIR.
236 - You will end up with a directory structure like this (+=dir, -=file):
242 - 110214175330.zip (or whatever, this is the minetest source)
265 - Start up the CMake GUI
266 - Select "Browse Source..." and select DIR/minetest
267 - Now, if using MSVC:
268 - Select "Browse Build..." and select DIR/minetest-build
269 - Else if using MinGW:
270 - Select "Browse Build..." and select DIR/minetest
272 - Select your compiler
273 - It will warn about missing stuff, ignore that at this point. (later don't)
274 - Make sure the configuration is as follows
275 (note that the versions may differ for you):
279 CMAKE_BUILD_TYPE Release
280 CMAKE_INSTALL_PREFIX DIR/minetest-install
281 IRRLICHT_SOURCE_DIR DIR/irrlicht-1.7.1
284 ZLIB_DLL DIR/zlib125dll/dll32/zlibwapi.dll
285 ZLIB_INCLUDE_DIR DIR/zlib-1.2.5
286 ZLIB_LIBRARIES DIR/zlib125dll/dll32/zlibwapi.lib
287 GETTEXT_BIN_DIR DIR/gettext/bin
288 GETTEXT_INCLUDE_DIR DIR/gettext/include
289 GETTEXT_LIBRARIES DIR/gettext/lib/intl.lib
290 GETTEXT_MSGFMT DIR/gettext/bin/msgfmt
293 - Hit "Configure" once again 8)
294 - If something is still coloured red, you have a problem.
297 - Open the generated minetest.sln
298 - The project defaults to the "Debug" configuration. Make very sure to
299 select "Release", unless you want to debug some stuff (it's slower
300 and might not even work at all)
301 - Build the ALL_BUILD project
302 - Build the INSTALL project
303 - You should now have a working game with the executable in
304 DIR/minetest-install/bin/minetest.exe
305 - Additionally you may create a zip package by building the PACKAGE
308 - Using the command line, browse to the build directory and run 'make'
309 (or mingw32-make or whatever it happens to be)
310 - You may need to copy some of the downloaded DLLs into bin/, see what
311 running the produced executable tells you it doesn't have.
312 - You should now have a working game with the executable in
313 DIR/minetest/bin/minetest.exe
315 Windows releases of minetest are built using a bat script like this:
316 --------------------------------------------------------------------
319 set installpath="C:\tmp\minetest_install"
320 set irrlichtpath="C:\tmp\irrlicht-1.7.2"
322 set builddir=%sourcedir%\bvc10
325 cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=1 -DCMAKE_INSTALL_PREFIX=%installpath%
326 if %errorlevel% neq 0 goto fail
327 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
328 if %errorlevel% neq 0 goto fail
329 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
330 if %errorlevel% neq 0 goto fail
331 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
332 if %errorlevel% neq 0 goto fail
342 License of Minetest textures and sounds
343 ---------------------------------------
345 This applies to textures and sounds contained in the main Minetest
348 Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
349 http://creativecommons.org/licenses/by-sa/3.0/
351 Authors of media files
352 -----------------------
353 Everything not listed in here:
354 Copyright (C) 2010-2012 celeron55, Perttu Ahola <celeron55@gmail.com>
357 textures/base/pack/menuheader.png
360 misc/minetest-icon-24x24.png
361 misc/minetest-icon.ico
362 misc/minetest-icon.svg
363 textures/base/pack/logo.png
365 License of Minetest source code
366 -------------------------------
369 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
371 This program is free software; you can redistribute it and/or modify
372 it under the terms of the GNU Lesser General Public License as published by
373 the Free Software Foundation; either version 2.1 of the License, or
374 (at your option) any later version.
376 This program is distributed in the hope that it will be useful,
377 but WITHOUT ANY WARRANTY; without even the implied warranty of
378 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
379 GNU Lesser General Public License for more details.
381 You should have received a copy of the GNU Lesser General Public License along
382 with this program; if not, write to the Free Software Foundation, Inc.,
383 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
388 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
390 The Irrlicht Engine License
392 Copyright © 2002-2005 Nikolaus Gebhardt
394 This software is provided 'as-is', without any express or implied
395 warranty. In no event will the authors be held liable for any damages
396 arising from the use of this software.
398 Permission is granted to anyone to use this software for any purpose,
399 including commercial applications, and to alter it and redistribute
400 it freely, subject to the following restrictions:
402 1. The origin of this software must not be misrepresented; you
403 must not claim that you wrote the original software. If you use
404 this software in a product, an acknowledgment in the product
405 documentation would be appreciated but is not required.
406 2. Altered source versions must be plainly marked as such, and must
407 not be misrepresented as being the original software.
408 3. This notice may not be removed or altered from any source
415 This program uses the JThread library. License for JThread follows:
417 Copyright (c) 2000-2006 Jori Liesenborgs (jori.liesenborgs@gmail.com)
419 Permission is hereby granted, free of charge, to any person obtaining a
420 copy of this software and associated documentation files (the "Software"),
421 to deal in the Software without restriction, including without limitation
422 the rights to use, copy, modify, merge, publish, distribute, sublicense,
423 and/or sell copies of the Software, and to permit persons to whom the
424 Software is furnished to do so, subject to the following conditions:
426 The above copyright notice and this permission notice shall be included
427 in all copies or substantial portions of the Software.
429 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
430 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
431 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
432 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
433 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
434 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
440 Lua is licensed under the terms of the MIT license reproduced below.
441 This means that Lua is free software and can be used for both academic
442 and commercial purposes at absolutely no cost.
444 For details and rationale, see http://www.lua.org/license.html .
446 Copyright (C) 1994-2008 Lua.org, PUC-Rio.
448 Permission is hereby granted, free of charge, to any person obtaining a copy
449 of this software and associated documentation files (the "Software"), to deal
450 in the Software without restriction, including without limitation the rights
451 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
452 copies of the Software, and to permit persons to whom the Software is
453 furnished to do so, subject to the following conditions:
455 The above copyright notice and this permission notice shall be included in
456 all copies or substantial portions of the Software.
458 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
459 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
460 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
461 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
462 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
463 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
471 Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
472 Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
474 Bitstream Vera Fonts Copyright:
476 Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
477 a trademark of Bitstream, Inc.
479 Arev Fonts Copyright:
481 Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
483 Liberation Fonts Copyright:
485 Copyright (c) 2007 Red Hat, Inc. All rights reserved. LIBERATION is a trademark of Red Hat, Inc.
489 Copyright (C) 2008 The Android Open Source Project
491 Licensed under the Apache License, Version 2.0 (the "License");
492 you may not use this file except in compliance with the License.
493 You may obtain a copy of the License at
495 http://www.apache.org/licenses/LICENSE-2.0
497 Unless required by applicable law or agreed to in writing, software
498 distributed under the License is distributed on an "AS IS" BASIS,
499 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
500 See the License for the specific language governing permissions and
501 limitations under the License.