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
38 - Mouse left: dig/punch
39 - Mouse right: place/use
40 - Mouse wheel: select item
43 - Settable in the configuration file, see the section below.
47 $bin - Compiled binaries
48 $share - Distributed read-only data
49 $user - User-created modifiable data
51 Windows .zip / RUN_IN_PLACE source:
58 $share = /usr/share/minetest
64 $user = ~/Library/Application Support/minetest
68 - Worlds can be found as separate folders in:
75 - It is created by Minetest when it is ran the first time.
76 - A specific file can be specified on the command line:
77 --config <path-to-file>
83 Compiling on GNU/Linux:
84 -----------------------
86 Install dependencies. Here's an example for Debian/Ubuntu:
87 $ 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
89 Download source, extract (this is the URL to the latest of source repository, which might not work at all times):
90 $ wget https://github.com/minetest/minetest/tarball/master -O master.tar.gz
91 $ tar xf master.tar.gz
92 $ cd minetest-minetest-286edd4 (or similar)
94 Download minetest_game (otherwise only the "Minimal development test" game is available)
96 $ wget https://github.com/minetest/minetest_game/tarball/master -O minetest_game.tar.gz
97 $ tar xf minetest_game.tar.gz
98 $ mv minetest-minetest_game-* minetest_game
101 Build a version that runs directly from the source directory:
102 $ cmake . -DRUN_IN_PLACE=1
109 - Use cmake . -LH to see all CMake options and their current state
110 - If you want to install it system-wide (or are making a distribution package), you will want to use -DRUN_IN_PLACE=0
111 - You can build a bare server or a bare client by specifying -DBUILD_CLIENT=0 or -DBUILD_SERVER=0
112 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
113 - Debug build is slower, but gives much more useful output in a debugger
114 - If you build a bare server, you don't need to have Irrlicht installed. In that case use -DIRRLICHT_SOURCE_DIR=/the/irrlicht/source
120 BUILD_CLIENT - Build Minetest client
121 BUILD_SERVER - Build Minetest server
122 CMAKE_BUILD_TYPE - Type of build (Release vs. Debug)
123 Release - Release build
125 RelWithDebInfo - Release build with Debug information
126 MinSizeRel - Release build with -Os passed to compiler to make executable as small as possible
127 ENABLE_CURL - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
128 ENABLE_FREETYPE - Build with Freetype2; Allows using TTF fonts
129 ENABLE_GETTEXT - Build with Gettext; Allows using translations
130 ENABLE_GLES - Search for Open GLES headers & libraries and use them
131 ENABLE_LEVELDB - Build with LevelDB; Enables use of LevelDB, which is much faster than SQLite, as map backend
132 ENABLE_SOUND - Build with OpenAL, libogg & libvorbis; in-game Sounds
133 DISABLE_LUAJIT - Do not search for LuaJIT headers & library
134 RUN_IN_PLACE - Create a portable install (worlds, settings etc. in current directory)
135 USE_GPROF - Enable profiling using GProf
136 VERSION_EXTRA - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
138 Library specific options:
140 BZIP2_INCLUDE_DIR - Linux only; directory where bzlib.h is located
141 BZIP2_LIBRARY - Linux only; path to libbz2.a/libbz2.so
142 CURL_DLL - Only if building with cURL on Windows; path to libcurl.dll
143 CURL_INCLUDE_DIR - Only if building with cURL; directory where curl.h is located
144 CURL_LIBRARY - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
145 EGL_INCLUDE_DIR - Only if building with GLES; directory that contains egl.h
146 EGL_egl_LIBRARY - Only if building with GLES; path to libEGL.a/libEGL.so
147 FREETYPE_INCLUDE_DIR_freetype2 - Only if building with Freetype2; directory that contains an freetype directory with files such as ftimage.h in it
148 FREETYPE_INCLUDE_DIR_ft2build - Only if building with Freetype2; directory that contains ft2build.h
149 FREETYPE_LIBRARY - Only if building with Freetype2; path to libfreetype.a/libfreetype.so/freetype.lib
150 GETTEXT_DLL - Only when building with Gettext on Windows; path to libintl3.dll
151 GETTEXT_ICONV_DLL - Only when building with Gettext on Windows; path to libiconv2.dll
152 GETTEXT_INCLUDE_DIR - Only when building with Gettext; directory that contains iconv.h
153 GETTEXT_LIBRARY - Only when building with Gettext on Windows; path to libintl.dll.a
154 GETTEXT_MSGFMT - Only when building with Gettext; path to msgfmt/msgfmt.exe
155 IRRLICHT_DLL - path to Irrlicht.dll
156 IRRLICHT_INCLUDE_DIR - directory that contains IrrCompileConfig.h
157 IRRLICHT_LIBRARY - path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a
158 LEVELDB_INCLUDE_DIR - Only when building with LevelDB; directory that contains db.h
159 LEVELDB_LIBRARY - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll
160 LUA_INCLUDE_DIR - Only if you want to use LuaJIT; directory where luajit.h is located
161 LUA_LIBRARY - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
162 MINGWM10_DLL - Only if compiling with MinGW; path to mingwm10.dll
163 OGG_DLL - Only if building with sound on Windows; path to libogg.dll
164 OGG_INCLUDE_DIR - Only if building with sound; directory that contains an ogg directory which contains ogg.h
165 OGG_LIBRARY - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
166 OPENAL_DLL - Only if building with sound on Windows; path to OpenAL32.dll
167 OPENAL_INCLUDE_DIR - Only if building with sound; directory where al.h is located
168 OPENAL_LIBRARY - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
169 OPENGLES2_INCLUDE_DIR - Only if building with GLES; directory that contains gl2.h
170 OPENGLES2_gl_LIBRARY - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
171 SQLITE3_INCLUDE_DIR - Only if you want to use SQLite from your OS; directory that contains sqlite3.h
172 SQLITE3_LIBRARY - Only if you want to use the SQLite from your OS; path to libsqlite3.a/libsqlite3.so
173 VORBISFILE_DLL - Only if building with sound on Windows; path to libvorbisfile-3.dll
174 VORBISFILE_LIBRARY - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
175 VORBIS_DLL - Only if building with sound on Windows; path to libvorbis-0.dll
176 VORBIS_INCLUDE_DIR - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
177 VORBIS_LIBRARY - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
178 XXF86VM_LIBRARY - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
179 ZLIB_DLL - Only on Windows; path to zlibwapi.dll
180 ZLIB_INCLUDE_DIR - directory where zlib.h is located
181 ZLIB_LIBRARY - path to libz.a/libz.so/zlibwapi.lib
183 Compiling on Windows:
184 ---------------------
185 - This section is outdated. In addition to what is described here:
186 - In addition to minetest, you need to download minetest_game.
187 - If you wish to have sound support, you need libogg, libvorbis and libopenal
191 http://www.cmake.org/cmake/resources/software.html
192 * MinGW or Visual Studio
193 http://www.mingw.org/
194 http://msdn.microsoft.com/en-us/vstudio/default
196 http://irrlicht.sourceforge.net/downloads.html
197 * Zlib headers (zlib125.zip)
198 http://www.winimage.com/zLibDll/index.html
199 * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
200 http://www.winimage.com/zLibDll/index.html
201 * Optional: gettext library and tools:
202 http://gnuwin32.sourceforge.net/downlinks/gettext.php
203 - This is used for other UI languages. Feel free to leave it out.
204 * And, of course, Minetest:
205 http://minetest.net/download.php
207 - Select a directory called DIR hereafter in which you will operate.
208 - Make sure you have CMake and a compiler installed.
209 - Download all the other stuff to DIR and extract them into there.
210 ("extract here", not "extract to packagename/")
211 NOTE: zlib125dll.zip needs to be extracted into zlib125dll
212 - All those packages contain a nice base directory in them, which
213 should end up being the direct subdirectories of DIR.
214 - You will end up with a directory structure like this (+=dir, -=file):
220 - 110214175330.zip (or whatever, this is the minetest source)
243 - Start up the CMake GUI
244 - Select "Browse Source..." and select DIR/minetest
245 - Now, if using MSVC:
246 - Select "Browse Build..." and select DIR/minetest-build
247 - Else if using MinGW:
248 - Select "Browse Build..." and select DIR/minetest
250 - Select your compiler
251 - It will warn about missing stuff, ignore that at this point. (later don't)
252 - Make sure the configuration is as follows
253 (note that the versions may differ for you):
257 CMAKE_BUILD_TYPE Release
258 CMAKE_INSTALL_PREFIX DIR/minetest-install
259 IRRLICHT_SOURCE_DIR DIR/irrlicht-1.7.1
262 ZLIB_DLL DIR/zlib125dll/dll32/zlibwapi.dll
263 ZLIB_INCLUDE_DIR DIR/zlib-1.2.5
264 ZLIB_LIBRARIES DIR/zlib125dll/dll32/zlibwapi.lib
265 GETTEXT_BIN_DIR DIR/gettext/bin
266 GETTEXT_INCLUDE_DIR DIR/gettext/include
267 GETTEXT_LIBRARIES DIR/gettext/lib/intl.lib
268 GETTEXT_MSGFMT DIR/gettext/bin/msgfmt
271 - Hit "Configure" once again 8)
272 - If something is still coloured red, you have a problem.
275 - Open the generated minetest.sln
276 - The project defaults to the "Debug" configuration. Make very sure to
277 select "Release", unless you want to debug some stuff (it's slower
278 and might not even work at all)
279 - Build the ALL_BUILD project
280 - Build the INSTALL project
281 - You should now have a working game with the executable in
282 DIR/minetest-install/bin/minetest.exe
283 - Additionally you may create a zip package by building the PACKAGE
286 - Using the command line, browse to the build directory and run 'make'
287 (or mingw32-make or whatever it happens to be)
288 - You may need to copy some of the downloaded DLLs into bin/, see what
289 running the produced executable tells you it doesn't have.
290 - You should now have a working game with the executable in
291 DIR/minetest/bin/minetest.exe
293 Windows releases of minetest are built using a bat script like this:
294 --------------------------------------------------------------------
297 set installpath="C:\tmp\minetest_install"
298 set irrlichtpath="C:\tmp\irrlicht-1.7.2"
300 set builddir=%sourcedir%\bvc10
303 cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=1 -DCMAKE_INSTALL_PREFIX=%installpath%
304 if %errorlevel% neq 0 goto fail
305 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
306 if %errorlevel% neq 0 goto fail
307 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
308 if %errorlevel% neq 0 goto fail
309 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
310 if %errorlevel% neq 0 goto fail
320 License of Minetest textures and sounds
321 ---------------------------------------
323 This applies to textures and sounds contained in the main Minetest
326 Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
327 http://creativecommons.org/licenses/by-sa/3.0/
329 Authors of media files
330 -----------------------
331 Everything not listed in here:
332 Copyright (C) 2010-2012 celeron55, Perttu Ahola <celeron55@gmail.com>
335 textures/base/pack/menuheader.png
338 misc/minetest-icon-24x24.png
339 misc/minetest-icon.ico
340 misc/minetest-icon.svg
341 textures/base/pack/logo.png
343 License of Minetest source code
344 -------------------------------
347 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
349 This program is free software; you can redistribute it and/or modify
350 it under the terms of the GNU Lesser General Public License as published by
351 the Free Software Foundation; either version 2.1 of the License, or
352 (at your option) any later version.
354 This program is distributed in the hope that it will be useful,
355 but WITHOUT ANY WARRANTY; without even the implied warranty of
356 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
357 GNU Lesser General Public License for more details.
359 You should have received a copy of the GNU Lesser General Public License along
360 with this program; if not, write to the Free Software Foundation, Inc.,
361 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
366 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
368 The Irrlicht Engine License
370 Copyright © 2002-2005 Nikolaus Gebhardt
372 This software is provided 'as-is', without any express or implied
373 warranty. In no event will the authors be held liable for any damages
374 arising from the use of this software.
376 Permission is granted to anyone to use this software for any purpose,
377 including commercial applications, and to alter it and redistribute
378 it freely, subject to the following restrictions:
380 1. The origin of this software must not be misrepresented; you
381 must not claim that you wrote the original software. If you use
382 this software in a product, an acknowledgment in the product
383 documentation would be appreciated but is not required.
384 2. Altered source versions must be plainly marked as such, and must
385 not be misrepresented as being the original software.
386 3. This notice may not be removed or altered from any source
393 This program uses the JThread library. License for JThread follows:
395 Copyright (c) 2000-2006 Jori Liesenborgs (jori.liesenborgs@gmail.com)
397 Permission is hereby granted, free of charge, to any person obtaining a
398 copy of this software and associated documentation files (the "Software"),
399 to deal in the Software without restriction, including without limitation
400 the rights to use, copy, modify, merge, publish, distribute, sublicense,
401 and/or sell copies of the Software, and to permit persons to whom the
402 Software is furnished to do so, subject to the following conditions:
404 The above copyright notice and this permission notice shall be included
405 in all copies or substantial portions of the Software.
407 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
408 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
409 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
410 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
411 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
412 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
418 Lua is licensed under the terms of the MIT license reproduced below.
419 This means that Lua is free software and can be used for both academic
420 and commercial purposes at absolutely no cost.
422 For details and rationale, see http://www.lua.org/license.html .
424 Copyright (C) 1994-2008 Lua.org, PUC-Rio.
426 Permission is hereby granted, free of charge, to any person obtaining a copy
427 of this software and associated documentation files (the "Software"), to deal
428 in the Software without restriction, including without limitation the rights
429 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
430 copies of the Software, and to permit persons to whom the Software is
431 furnished to do so, subject to the following conditions:
433 The above copyright notice and this permission notice shall be included in
434 all copies or substantial portions of the Software.
436 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
437 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
438 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
439 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
440 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
441 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
449 Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
450 Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
452 Bitstream Vera Fonts Copyright:
454 Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
455 a trademark of Bitstream, Inc.
457 Arev Fonts Copyright:
459 Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
461 Liberation Fonts Copyright:
463 Copyright (c) 2007 Red Hat, Inc. All rights reserved. LIBERATION is a trademark of Red Hat, Inc.
467 Copyright (C) 2008 The Android Open Source Project
469 Licensed under the Apache License, Version 2.0 (the "License");
470 you may not use this file except in compliance with the License.
471 You may obtain a copy of the License at
473 http://www.apache.org/licenses/LICENSE-2.0
475 Unless required by applicable law or agreed to in writing, software
476 distributed under the License is distributed on an "AS IS" BASIS,
477 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
478 See the License for the specific language governing permissions and
479 limitations under the License.