Update czech translation
[oweals/minetest.git] / README.txt
1 Minetest
2 ========
3
4 An InfiniMiner/Minecraft inspired game.
5
6 Copyright (c) 2010-2013 Perttu Ahola <celeron55@gmail.com>
7 and contributors (see source file comments and the version control log)
8
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.
15
16 Further documentation
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
24
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.
29
30 Default Controls
31 -----------------
32 - WASD: move
33 - Space: jump/climb
34 - Shift: sneak/go down
35 - Q: drop itemstack (+ SHIFT for single item)
36 - I: inventory
37 - Mouse: turn/look
38 - Mouse left: dig/punch
39 - Mouse right: place/use
40 - Mouse wheel: select item
41 - T: chat
42 - 1-8: select item
43
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)
51
52 - F1:  Hide/Show HUD
53 - F2:  Hide/Show Chat
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
61
62 - Settable in the configuration file, see the section below.
63
64 Paths
65 ------
66 $bin   - Compiled binaries
67 $share - Distributed read-only data
68 $user  - User-created modifiable data
69
70 Windows .zip / RUN_IN_PLACE source:
71 $bin   = bin
72 $share = .
73 $user  = .
74
75 Linux installed:
76 $bin   = /usr/bin
77 $share = /usr/share/minetest
78 $user  = ~/.minetest
79
80 OS X:
81 $bin   = ?
82 $share = ?
83 $user  = ~/Library/Application Support/minetest
84
85 World directory
86 ----------------
87 - Worlds can be found as separate folders in:
88     $user/worlds/
89
90 Configuration file:
91 -------------------
92 - Default location:
93     $user/minetest.conf
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>
97
98 Command-line options:
99 ---------------------
100 - Use --help
101
102 Compiling on GNU/Linux:
103 -----------------------
104
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 zlib1g-dev libjsoncpp-dev
107
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 $ apt-get install git-core
112
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
115 $ cd minetest
116
117 Download minetest_game (otherwise only the "Minimal development test" game is available) using git:
118 $ cd games/
119 $ git clone --depth 1 https://github.com/minetest/minetest_game.git
120 $ cd ..
121
122 Download source, without using git:
123 $ wget https://github.com/minetest/minetest/archive/master.tar.gz
124 $ tar xf master.tar.gz
125 $ cd minetest-master
126
127 Download minetest_game, without using git:
128 $ cd games/
129 $ wget https://github.com/minetest/minetest_game/archive/master.tar.gz
130 $ tar xf master.tar.gz
131 $ mv minetest_game-master minetest_game
132 $ cd ..
133
134 Build a version that runs directly from the source directory:
135 $ cmake . -DRUN_IN_PLACE=1
136 $ make -j2
137
138 Run it:
139 $ cd bin
140 $ ./minetest
141
142 - Use cmake . -LH to see all CMake options and their current state
143 - If you want to install it system-wide (or are making a distribution package), you will want to use -DRUN_IN_PLACE=0
144 - You can build a bare server or a bare client by specifying -DBUILD_CLIENT=0 or -DBUILD_SERVER=0
145 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
146   - Debug build is slower, but gives much more useful output in a debugger
147 - If you build a bare server, you don't need to have Irrlicht installed. In that case use -DIRRLICHT_SOURCE_DIR=/the/irrlicht/source
148
149 CMake options
150 -------------
151 General options:
152
153 BUILD_CLIENT        - Build Minetest client
154 BUILD_SERVER        - Build Minetest server
155 CMAKE_BUILD_TYPE    - Type of build (Release vs. Debug)
156     Release         - Release build
157     Debug           - Debug build
158     RelWithDebInfo  - Release build with Debug information
159     MinSizeRel      - Release build with -Os passed to compiler to make executable as small as possible
160 ENABLE_CURL         - Build with cURL; Enables use of online mod repo, public serverlist and remote media fetching via http
161 ENABLE_FREETYPE     - Build with Freetype2; Allows using TTF fonts
162 ENABLE_GETTEXT      - Build with Gettext; Allows using translations
163 ENABLE_GLES         - Search for Open GLES headers & libraries and use them
164 ENABLE_LEVELDB      - Build with LevelDB; Enables use of LevelDB, which is much faster than SQLite, as map backend
165 ENABLE_REDIS        - Build with libhiredis; Enables use of redis map backend
166 ENABLE_SOUND        - Build with OpenAL, libogg & libvorbis; in-game Sounds
167 DISABLE_LUAJIT      - Do not search for LuaJIT headers & library
168 RUN_IN_PLACE        - Create a portable install (worlds, settings etc. in current directory)
169 USE_GPROF           - Enable profiling using GProf
170 VERSION_EXTRA       - Text to append to version (e.g. VERSION_EXTRA=foobar -> Minetest 0.4.9-foobar)
171
172 Library specific options:
173
174 BZIP2_INCLUDE_DIR               - Linux only; directory where bzlib.h is located
175 BZIP2_LIBRARY                   - Linux only; path to libbz2.a/libbz2.so
176 CURL_DLL                        - Only if building with cURL on Windows; path to libcurl.dll
177 CURL_INCLUDE_DIR                - Only if building with cURL; directory where curl.h is located
178 CURL_LIBRARY                    - Only if building with cURL; path to libcurl.a/libcurl.so/libcurl.lib
179 EGL_INCLUDE_DIR                 - Only if building with GLES; directory that contains egl.h
180 EGL_egl_LIBRARY                 - Only if building with GLES; path to libEGL.a/libEGL.so
181 FREETYPE_INCLUDE_DIR_freetype2  - Only if building with Freetype2; directory that contains an freetype directory with files such as ftimage.h in it
182 FREETYPE_INCLUDE_DIR_ft2build   - Only if building with Freetype2; directory that contains ft2build.h
183 FREETYPE_LIBRARY                - Only if building with Freetype2; path to libfreetype.a/libfreetype.so/freetype.lib
184 FREETYPE_DLL                    - Only if building with Freetype2 on Windows; path to libfreetype.dll
185 GETTEXT_DLL                     - Only when building with Gettext on Windows; path to libintl3.dll
186 GETTEXT_ICONV_DLL               - Only when building with Gettext on Windows; path to libiconv2.dll
187 GETTEXT_INCLUDE_DIR             - Only when building with Gettext; directory that contains iconv.h
188 GETTEXT_LIBRARY                 - Only when building with Gettext on Windows; path to libintl.dll.a
189 GETTEXT_MSGFMT                  - Only when building with Gettext; path to msgfmt/msgfmt.exe
190 IRRLICHT_DLL                    - path to Irrlicht.dll
191 IRRLICHT_INCLUDE_DIR            - directory that contains IrrCompileConfig.h
192 IRRLICHT_LIBRARY                - path to libIrrlicht.a/libIrrlicht.so/libIrrlicht.dll.a
193 LEVELDB_INCLUDE_DIR             - Only when building with LevelDB; directory that contains db.h
194 LEVELDB_LIBRARY                 - Only when building with LevelDB; path to libleveldb.a/libleveldb.so/libleveldb.dll.a
195 LEVELDB_DLL                     - Only when building with LevelDB on Windows; path to libleveldb.dll
196 REDIS_INCLUDE_DIR               - Only when building with redis support; directory that contains hiredis.h
197 REDIS_LIBRARY                   - Only when building with redis support; path to libhiredis.a/libhiredis.so
198 LUA_INCLUDE_DIR                 - Only if you want to use LuaJIT; directory where luajit.h is located
199 LUA_LIBRARY                     - Only if you want to use LuaJIT; path to libluajit.a/libluajit.so
200 MINGWM10_DLL                    - Only if compiling with MinGW; path to mingwm10.dll
201 OGG_DLL                         - Only if building with sound on Windows; path to libogg.dll
202 OGG_INCLUDE_DIR                 - Only if building with sound; directory that contains an ogg directory which contains ogg.h
203 OGG_LIBRARY                     - Only if building with sound; path to libogg.a/libogg.so/libogg.dll.a
204 OPENAL_DLL                      - Only if building with sound on Windows; path to OpenAL32.dll
205 OPENAL_INCLUDE_DIR              - Only if building with sound; directory where al.h is located
206 OPENAL_LIBRARY                  - Only if building with sound; path to libopenal.a/libopenal.so/OpenAL32.lib
207 OPENGLES2_INCLUDE_DIR           - Only if building with GLES; directory that contains gl2.h
208 OPENGLES2_gl_LIBRARY            - Only if building with GLES; path to libGLESv2.a/libGLESv2.so
209 SQLITE3_INCLUDE_DIR             - Only if you want to use SQLite from your OS; directory that contains sqlite3.h
210 SQLITE3_LIBRARY                 - Only if you want to use the SQLite from your OS; path to libsqlite3.a/libsqlite3.so
211 VORBISFILE_DLL                  - Only if building with sound on Windows; path to libvorbisfile-3.dll
212 VORBISFILE_LIBRARY              - Only if building with sound; path to libvorbisfile.a/libvorbisfile.so/libvorbisfile.dll.a
213 VORBIS_DLL                      - Only if building with sound on Windows; path to libvorbis-0.dll
214 VORBIS_INCLUDE_DIR              - Only if building with sound; directory that contains a directory vorbis with vorbisenc.h inside
215 VORBIS_LIBRARY                  - Only if building with sound; path to libvorbis.a/libvorbis.so/libvorbis.dll.a
216 XXF86VM_LIBRARY                 - Only on Linux; path to libXXf86vm.a/libXXf86vm.so
217 ZLIB_DLL                        - Only on Windows; path to zlib1.dll
218 ZLIBWAPI_DLL                    - Only on Windows; path to zlibwapi.dll
219 ZLIB_INCLUDE_DIR                - directory where zlib.h is located
220 ZLIB_LIBRARY                    - path to libz.a/libz.so/zlibwapi.lib
221
222 Compiling on Windows:
223 ---------------------
224 - This section is outdated. In addition to what is described here:
225   - In addition to minetest, you need to download minetest_game.
226   - If you wish to have sound support, you need libogg, libvorbis and libopenal
227
228 - You need:
229         * CMake:
230                 http://www.cmake.org/cmake/resources/software.html
231         * MinGW or Visual Studio
232                 http://www.mingw.org/
233                 http://msdn.microsoft.com/en-us/vstudio/default
234         * Irrlicht SDK 1.7:
235                 http://irrlicht.sourceforge.net/downloads.html
236         * Zlib headers (zlib125.zip)
237                 http://www.winimage.com/zLibDll/index.html
238         * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
239                 http://www.winimage.com/zLibDll/index.html
240         * Optional: gettext library and tools:
241                 http://gnuwin32.sourceforge.net/downlinks/gettext.php
242                 - This is used for other UI languages. Feel free to leave it out.
243         * And, of course, Minetest:
244                 http://minetest.net/download
245 - Steps:
246         - Select a directory called DIR hereafter in which you will operate.
247         - Make sure you have CMake and a compiler installed.
248         - Download all the other stuff to DIR and extract them into there.
249           ("extract here", not "extract to packagename/")
250           NOTE: zlib125dll.zip needs to be extracted into zlib125dll
251         - All those packages contain a nice base directory in them, which
252           should end up being the direct subdirectories of DIR.
253         - You will end up with a directory structure like this (+=dir, -=file):
254         -----------------
255         + DIR
256                 - zlib-1.2.5.tar.gz
257                 - zlib125dll.zip
258                 - irrlicht-1.7.1.zip
259                 - 110214175330.zip (or whatever, this is the minetest source)
260                 + zlib-1.2.5
261                         - zlib.h
262                         + win32
263                         ...
264                 + zlib125dll
265                         - readme.txt
266                         + dll32
267                         ...
268                 + irrlicht-1.7.1
269                         + lib
270                         + include
271                         ...
272                 + gettext (optional)
273                         +bin
274                         +include
275                         +lib
276                 + minetest
277                         + src
278                         + doc
279                         - CMakeLists.txt
280                         ...
281         -----------------
282         - Start up the CMake GUI
283         - Select "Browse Source..." and select DIR/minetest
284         - Now, if using MSVC:
285                 - Select "Browse Build..." and select DIR/minetest-build
286         - Else if using MinGW:
287                 - Select "Browse Build..." and select DIR/minetest
288         - Select "Configure"
289         - Select your compiler
290         - It will warn about missing stuff, ignore that at this point. (later don't)
291         - Make sure the configuration is as follows
292           (note that the versions may differ for you):
293         -----------------
294         BUILD_CLIENT             [X]
295         BUILD_SERVER             [ ]
296         CMAKE_BUILD_TYPE         Release
297         CMAKE_INSTALL_PREFIX     DIR/minetest-install
298         IRRLICHT_SOURCE_DIR      DIR/irrlicht-1.7.1
299         RUN_IN_PLACE             [X]
300         WARN_ALL                 [ ]
301         ZLIB_DLL                 DIR/zlib125dll/dll32/zlibwapi.dll
302         ZLIB_INCLUDE_DIR         DIR/zlib-1.2.5
303         ZLIB_LIBRARIES           DIR/zlib125dll/dll32/zlibwapi.lib
304         GETTEXT_BIN_DIR          DIR/gettext/bin
305         GETTEXT_INCLUDE_DIR      DIR/gettext/include
306         GETTEXT_LIBRARIES        DIR/gettext/lib/intl.lib
307         GETTEXT_MSGFMT           DIR/gettext/bin/msgfmt
308         -----------------
309         - Hit "Configure"
310         - Hit "Configure" once again 8)
311         - If something is still coloured red, you have a problem.
312         - Hit "Generate"
313         If using MSVC:
314                 - Open the generated minetest.sln
315                 - The project defaults to the "Debug" configuration. Make very sure to
316                   select "Release", unless you want to debug some stuff (it's slower
317                   and might not even work at all)
318                 - Build the ALL_BUILD project
319                 - Build the INSTALL project
320                 - You should now have a working game with the executable in
321                         DIR/minetest-install/bin/minetest.exe
322                 - Additionally you may create a zip package by building the PACKAGE
323                   project.
324         If using MinGW:
325                 - Using the command line, browse to the build directory and run 'make'
326                   (or mingw32-make or whatever it happens to be)
327                 - You may need to copy some of the downloaded DLLs into bin/, see what
328                   running the produced executable tells you it doesn't have.
329                 - You should now have a working game with the executable in
330                         DIR/minetest/bin/minetest.exe
331
332 Windows releases of minetest are built using a bat script like this:
333 --------------------------------------------------------------------
334
335 set sourcedir=%CD%
336 set installpath="C:\tmp\minetest_install"
337 set irrlichtpath="C:\tmp\irrlicht-1.7.2"
338
339 set builddir=%sourcedir%\bvc10
340 mkdir %builddir%
341 pushd %builddir%
342 cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=1 -DCMAKE_INSTALL_PREFIX=%installpath%
343 if %errorlevel% neq 0 goto fail
344 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
345 if %errorlevel% neq 0 goto fail
346 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
347 if %errorlevel% neq 0 goto fail
348 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
349 if %errorlevel% neq 0 goto fail
350 popd
351 echo Finished.
352 exit /b 0
353
354 :fail
355 popd
356 echo Failed.
357 exit /b 1
358
359 License of Minetest textures and sounds
360 ---------------------------------------
361
362 This applies to textures and sounds contained in the main Minetest
363 distribution.
364
365 Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
366 http://creativecommons.org/licenses/by-sa/3.0/
367
368 Authors of media files
369 -----------------------
370 Everything not listed in here:
371 Copyright (C) 2010-2012 celeron55, Perttu Ahola <celeron55@gmail.com>
372
373 BlockMen:
374   textures/base/pack/menuheader.png
375
376 erlehmann:
377   misc/minetest-icon-24x24.png
378   misc/minetest-icon.ico
379   misc/minetest-icon.svg
380   textures/base/pack/logo.png
381
382 License of Minetest source code
383 -------------------------------
384
385 Minetest
386 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
387
388 This program is free software; you can redistribute it and/or modify
389 it under the terms of the GNU Lesser General Public License as published by
390 the Free Software Foundation; either version 2.1 of the License, or
391 (at your option) any later version.
392
393 This program is distributed in the hope that it will be useful,
394 but WITHOUT ANY WARRANTY; without even the implied warranty of
395 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
396 GNU Lesser General Public License for more details.
397
398 You should have received a copy of the GNU Lesser General Public License along
399 with this program; if not, write to the Free Software Foundation, Inc.,
400 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
401
402 Irrlicht
403 ---------------
404
405 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
406
407  The Irrlicht Engine License
408
409 Copyright © 2002-2005 Nikolaus Gebhardt
410
411 This software is provided 'as-is', without any express or implied
412 warranty. In no event will the authors be held liable for any damages
413 arising from the use of this software.
414
415 Permission is granted to anyone to use this software for any purpose,
416 including commercial applications, and to alter it and redistribute
417 it freely, subject to the following restrictions:
418
419    1. The origin of this software must not be misrepresented; you
420       must not claim that you wrote the original software. If you use
421           this software in a product, an acknowledgment in the product
422           documentation would be appreciated but is not required.
423    2. Altered source versions must be plainly marked as such, and must
424       not be misrepresented as being the original software.
425    3. This notice may not be removed or altered from any source
426       distribution.
427
428
429 JThread
430 ---------------
431
432 This program uses the JThread library. License for JThread follows:
433
434 Copyright (c) 2000-2006  Jori Liesenborgs (jori.liesenborgs@gmail.com)
435
436 Permission is hereby granted, free of charge, to any person obtaining a
437 copy of this software and associated documentation files (the "Software"),
438 to deal in the Software without restriction, including without limitation
439 the rights to use, copy, modify, merge, publish, distribute, sublicense,
440 and/or sell copies of the Software, and to permit persons to whom the
441 Software is furnished to do so, subject to the following conditions:
442
443 The above copyright notice and this permission notice shall be included
444 in all copies or substantial portions of the Software.
445
446 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
447 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
448 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
449 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
450 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
451 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
452 IN THE SOFTWARE.
453
454 Lua
455 ---------------
456
457 Lua is licensed under the terms of the MIT license reproduced below.
458 This means that Lua is free software and can be used for both academic
459 and commercial purposes at absolutely no cost.
460
461 For details and rationale, see http://www.lua.org/license.html .
462
463 Copyright (C) 1994-2008 Lua.org, PUC-Rio.
464
465 Permission is hereby granted, free of charge, to any person obtaining a copy
466 of this software and associated documentation files (the "Software"), to deal
467 in the Software without restriction, including without limitation the rights
468 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
469 copies of the Software, and to permit persons to whom the Software is
470 furnished to do so, subject to the following conditions:
471
472 The above copyright notice and this permission notice shall be included in
473 all copies or substantial portions of the Software.
474
475 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
476 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
477 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
478 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
479 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
480 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
481 THE SOFTWARE.
482
483 Fonts
484 ---------------
485
486 DejaVu Sans Mono:
487
488   Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
489   Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
490
491 Bitstream Vera Fonts Copyright:
492
493   Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
494   a trademark of Bitstream, Inc.
495
496 Arev Fonts Copyright:
497
498   Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
499
500 Liberation Fonts Copyright:
501
502   Copyright (c) 2007 Red Hat, Inc. All rights reserved. LIBERATION is a trademark of Red Hat, Inc.
503
504 DroidSansFallback:
505
506   Copyright (C) 2008 The Android Open Source Project
507
508   Licensed under the Apache License, Version 2.0 (the "License");
509   you may not use this file except in compliance with the License.
510   You may obtain a copy of the License at
511
512      http://www.apache.org/licenses/LICENSE-2.0
513
514   Unless required by applicable law or agreed to in writing, software
515   distributed under the License is distributed on an "AS IS" BASIS,
516   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
517   See the License for the specific language governing permissions and
518   limitations under the License.