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 $ sudo 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 zlib1g-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=1
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), you will want to use -DRUN_IN_PLACE=0
141 - You can build a bare server or a bare client by specifying -DBUILD_CLIENT=0 or -DBUILD_SERVER=0
142 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
143 - Debug build is slower, but gives much more useful output in a debugger
144 - If you build a bare server, you don't need to have Irrlicht installed. In that case use -DIRRLICHT_SOURCE_DIR=/the/irrlicht/source
150 BUILD_CLIENT - Build Minetest client
151 BUILD_SERVER - Build Minetest server
152 CMAKE_BUILD_TYPE - Type of build (Release vs. Debug)
153 Release - Release build
155 RelWithDebInfo - Release build with Debug information
156 MinSizeRel - Release build with -Os passed to compiler to make executable as small as possible
157 ENABLE_CURL - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
158 ENABLE_FREETYPE - Build with Freetype2; Allows using TTF fonts
159 ENABLE_GETTEXT - Build with Gettext; Allows using translations
160 ENABLE_GLES - Search for Open GLES headers & libraries and use them
161 ENABLE_LEVELDB - Build with LevelDB; Enables use of LevelDB, which is much faster than SQLite, as map backend
162 ENABLE_REDIS - Build with libhiredis; Enables use of redis map backend
163 ENABLE_SOUND - Build with OpenAL, libogg & libvorbis; in-game Sounds
164 DISABLE_LUAJIT - Do not search for LuaJIT headers & library
165 RUN_IN_PLACE - Create a portable install (worlds, settings etc. in current directory)
166 USE_GPROF - Enable profiling using GProf
167 VERSION_EXTRA - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
169 Library specific options:
171 BZIP2_INCLUDE_DIR - Linux only; directory where bzlib.h is located
172 BZIP2_LIBRARY - Linux only; path to libbz2.a/libbz2.so
173 CURL_DLL - Only if building with cURL on Windows; path to libcurl.dll
174 CURL_INCLUDE_DIR - Only if building with cURL; directory where curl.h is located
175 CURL_LIBRARY - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
176 EGL_INCLUDE_DIR - Only if building with GLES; directory that contains egl.h
177 EGL_egl_LIBRARY - Only if building with GLES; path to libEGL.a/libEGL.so
178 FREETYPE_INCLUDE_DIR_freetype2 - Only if building with Freetype2; directory that contains an freetype directory with files such as ftimage.h in it
179 FREETYPE_INCLUDE_DIR_ft2build - Only if building with Freetype2; directory that contains ft2build.h
180 FREETYPE_LIBRARY - Only if building with Freetype2; path to libfreetype.a/libfreetype.so/freetype.lib
181 FREETYPE_DLL - Only if building with Freetype2 on Windows; path to libfreetype.dll
182 GETTEXT_DLL - Only when building with Gettext on Windows; path to libintl3.dll
183 GETTEXT_ICONV_DLL - Only when building with Gettext on Windows; path to libiconv2.dll
184 GETTEXT_INCLUDE_DIR - Only when building with Gettext; directory that contains iconv.h
185 GETTEXT_LIBRARY - Only when building with Gettext on Windows; path to libintl.dll.a
186 GETTEXT_MSGFMT - Only when building with Gettext; path to msgfmt/msgfmt.exe
187 IRRLICHT_DLL - path to Irrlicht.dll
188 IRRLICHT_INCLUDE_DIR - directory that contains IrrCompileConfig.h
189 IRRLICHT_LIBRARY - path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a
190 LEVELDB_INCLUDE_DIR - Only when building with LevelDB; directory that contains db.h
191 LEVELDB_LIBRARY - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll.a
192 LEVELDB_DLL - Only when building with LevelDB on Windows; path to libleveldb.dll
193 REDIS_INCLUDE_DIR - Only when building with redis support; directory that contains hiredis.h
194 REDIS_LIBRARY - Only when building with redis support; path to libhiredis.a/libhiredis.so
195 LUA_INCLUDE_DIR - Only if you want to use LuaJIT; directory where luajit.h is located
196 LUA_LIBRARY - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
197 MINGWM10_DLL - Only if compiling with MinGW; path to mingwm10.dll
198 OGG_DLL - Only if building with sound on Windows; path to libogg.dll
199 OGG_INCLUDE_DIR - Only if building with sound; directory that contains an ogg directory which contains ogg.h
200 OGG_LIBRARY - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
201 OPENAL_DLL - Only if building with sound on Windows; path to OpenAL32.dll
202 OPENAL_INCLUDE_DIR - Only if building with sound; directory where al.h is located
203 OPENAL_LIBRARY - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
204 OPENGLES2_INCLUDE_DIR - Only if building with GLES; directory that contains gl2.h
205 OPENGLES2_gl_LIBRARY - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
206 SQLITE3_INCLUDE_DIR - Only if you want to use SQLite from your OS; directory that contains sqlite3.h
207 SQLITE3_LIBRARY - Only if you want to use the SQLite from your OS; path to libsqlite3.a/libsqlite3.so
208 VORBISFILE_DLL - Only if building with sound on Windows; path to libvorbisfile-3.dll
209 VORBISFILE_LIBRARY - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
210 VORBIS_DLL - Only if building with sound on Windows; path to libvorbis-0.dll
211 VORBIS_INCLUDE_DIR - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
212 VORBIS_LIBRARY - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
213 XXF86VM_LIBRARY - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
214 ZLIB_DLL - Only on Windows; path to zlib1.dll
215 ZLIBWAPI_DLL - Only on Windows; path to zlibwapi.dll
216 ZLIB_INCLUDE_DIR - directory where zlib.h is located
217 ZLIB_LIBRARY - path to libz.a/libz.so/zlibwapi.lib
219 Compiling on Windows:
220 ---------------------
221 - This section is outdated. In addition to what is described here:
222 - In addition to minetest, you need to download minetest_game.
223 - If you wish to have sound support, you need libogg, libvorbis and libopenal
227 http://www.cmake.org/cmake/resources/software.html
228 * MinGW or Visual Studio
229 http://www.mingw.org/
230 http://msdn.microsoft.com/en-us/vstudio/default
232 http://irrlicht.sourceforge.net/downloads.html
233 * Zlib headers (zlib125.zip)
234 http://www.winimage.com/zLibDll/index.html
235 * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
236 http://www.winimage.com/zLibDll/index.html
237 * Optional: gettext library and tools:
238 http://gnuwin32.sourceforge.net/downlinks/gettext.php
239 - This is used for other UI languages. Feel free to leave it out.
240 * And, of course, Minetest:
241 http://minetest.net/download
243 - Select a directory called DIR hereafter in which you will operate.
244 - Make sure you have CMake and a compiler installed.
245 - Download all the other stuff to DIR and extract them into there.
246 ("extract here", not "extract to packagename/")
247 NOTE: zlib125dll.zip needs to be extracted into zlib125dll
248 - All those packages contain a nice base directory in them, which
249 should end up being the direct subdirectories of DIR.
250 - You will end up with a directory structure like this (+=dir, -=file):
256 - 110214175330.zip (or whatever, this is the minetest source)
279 - Start up the CMake GUI
280 - Select "Browse Source..." and select DIR/minetest
281 - Now, if using MSVC:
282 - Select "Browse Build..." and select DIR/minetest-build
283 - Else if using MinGW:
284 - Select "Browse Build..." and select DIR/minetest
286 - Select your compiler
287 - It will warn about missing stuff, ignore that at this point. (later don't)
288 - Make sure the configuration is as follows
289 (note that the versions may differ for you):
293 CMAKE_BUILD_TYPE Release
294 CMAKE_INSTALL_PREFIX DIR/minetest-install
295 IRRLICHT_SOURCE_DIR DIR/irrlicht-1.7.1
298 ZLIB_DLL DIR/zlib125dll/dll32/zlibwapi.dll
299 ZLIB_INCLUDE_DIR DIR/zlib-1.2.5
300 ZLIB_LIBRARIES DIR/zlib125dll/dll32/zlibwapi.lib
301 GETTEXT_BIN_DIR DIR/gettext/bin
302 GETTEXT_INCLUDE_DIR DIR/gettext/include
303 GETTEXT_LIBRARIES DIR/gettext/lib/intl.lib
304 GETTEXT_MSGFMT DIR/gettext/bin/msgfmt
307 - Hit "Configure" once again 8)
308 - If something is still coloured red, you have a problem.
311 - Open the generated minetest.sln
312 - The project defaults to the "Debug" configuration. Make very sure to
313 select "Release", unless you want to debug some stuff (it's slower
314 and might not even work at all)
315 - Build the ALL_BUILD project
316 - Build the INSTALL project
317 - You should now have a working game with the executable in
318 DIR/minetest-install/bin/minetest.exe
319 - Additionally you may create a zip package by building the PACKAGE
322 - Using the command line, browse to the build directory and run 'make'
323 (or mingw32-make or whatever it happens to be)
324 - You may need to copy some of the downloaded DLLs into bin/, see what
325 running the produced executable tells you it doesn't have.
326 - You should now have a working game with the executable in
327 DIR/minetest/bin/minetest.exe
329 Windows releases of minetest are built using a bat script like this:
330 --------------------------------------------------------------------
333 set installpath="C:\tmp\minetest_install"
334 set irrlichtpath="C:\tmp\irrlicht-1.7.2"
336 set builddir=%sourcedir%\bvc10
339 cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=1 -DCMAKE_INSTALL_PREFIX=%installpath%
340 if %errorlevel% neq 0 goto fail
341 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
342 if %errorlevel% neq 0 goto fail
343 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
344 if %errorlevel% neq 0 goto fail
345 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
346 if %errorlevel% neq 0 goto fail
356 License of Minetest textures and sounds
357 ---------------------------------------
359 This applies to textures and sounds contained in the main Minetest
362 Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
363 http://creativecommons.org/licenses/by-sa/3.0/
365 Authors of media files
366 -----------------------
367 Everything not listed in here:
368 Copyright (C) 2010-2012 celeron55, Perttu Ahola <celeron55@gmail.com>
371 textures/base/pack/menuheader.png
374 misc/minetest-icon-24x24.png
375 misc/minetest-icon.ico
376 misc/minetest-icon.svg
377 textures/base/pack/logo.png
379 License of Minetest source code
380 -------------------------------
383 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
385 This program is free software; you can redistribute it and/or modify
386 it under the terms of the GNU Lesser General Public License as published by
387 the Free Software Foundation; either version 2.1 of the License, or
388 (at your option) any later version.
390 This program is distributed in the hope that it will be useful,
391 but WITHOUT ANY WARRANTY; without even the implied warranty of
392 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
393 GNU Lesser General Public License for more details.
395 You should have received a copy of the GNU Lesser General Public License along
396 with this program; if not, write to the Free Software Foundation, Inc.,
397 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
402 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
404 The Irrlicht Engine License
406 Copyright © 2002-2005 Nikolaus Gebhardt
408 This software is provided 'as-is', without any express or implied
409 warranty. In no event will the authors be held liable for any damages
410 arising from the use of this software.
412 Permission is granted to anyone to use this software for any purpose,
413 including commercial applications, and to alter it and redistribute
414 it freely, subject to the following restrictions:
416 1. The origin of this software must not be misrepresented; you
417 must not claim that you wrote the original software. If you use
418 this software in a product, an acknowledgment in the product
419 documentation would be appreciated but is not required.
420 2. Altered source versions must be plainly marked as such, and must
421 not be misrepresented as being the original software.
422 3. This notice may not be removed or altered from any source
429 This program uses the JThread library. License for JThread follows:
431 Copyright (c) 2000-2006 Jori Liesenborgs (jori.liesenborgs@gmail.com)
433 Permission is hereby granted, free of charge, to any person obtaining a
434 copy of this software and associated documentation files (the "Software"),
435 to deal in the Software without restriction, including without limitation
436 the rights to use, copy, modify, merge, publish, distribute, sublicense,
437 and/or sell copies of the Software, and to permit persons to whom the
438 Software is furnished to do so, subject to the following conditions:
440 The above copyright notice and this permission notice shall be included
441 in all copies or substantial portions of the Software.
443 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
444 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
445 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
446 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
447 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
448 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
454 Lua is licensed under the terms of the MIT license reproduced below.
455 This means that Lua is free software and can be used for both academic
456 and commercial purposes at absolutely no cost.
458 For details and rationale, see http://www.lua.org/license.html .
460 Copyright (C) 1994-2008 Lua.org, PUC-Rio.
462 Permission is hereby granted, free of charge, to any person obtaining a copy
463 of this software and associated documentation files (the "Software"), to deal
464 in the Software without restriction, including without limitation the rights
465 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
466 copies of the Software, and to permit persons to whom the Software is
467 furnished to do so, subject to the following conditions:
469 The above copyright notice and this permission notice shall be included in
470 all copies or substantial portions of the Software.
472 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
473 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
474 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
475 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
476 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
477 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
485 Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
486 Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
488 Bitstream Vera Fonts Copyright:
490 Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
491 a trademark of Bitstream, Inc.
493 Arev Fonts Copyright:
495 Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
497 Liberation Fonts Copyright:
499 Copyright (c) 2007 Red Hat, Inc. All rights reserved. LIBERATION is a trademark of Red Hat, Inc.
503 Copyright (C) 2008 The Android Open Source Project
505 Licensed under the Apache License, Version 2.0 (the "License");
506 you may not use this file except in compliance with the License.
507 You may obtain a copy of the License at
509 http://www.apache.org/licenses/LICENSE-2.0
511 Unless required by applicable law or agreed to in writing, software
512 distributed under the License is distributed on an "AS IS" BASIS,
513 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
514 See the License for the specific language governing permissions and
515 limitations under the License.