4 An InfiniMiner/Minecraft inspired game.
6 Copyright (c) 2010-2012 Perttu Ahola <celeron55@gmail.com>
7 and ther 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/celeron55/minetest_game/
14 See the README.txt in it.
17 ----------------------
18 - Website: http://c55.me/minetest/
19 - Wiki: http://c55.me/minetest/wiki/
20 - Forum: http://c55.me/minetest/forum/
21 - Github: https://github.com/celeron55/minetest/
22 - doc/ directory of source distribution
24 This game is not finished
25 --------------------------
26 - Don't expect it to work as well as a finished game will.
27 - Please report any bugs. When doing that, debug.txt is useful.
38 - Settable in the configuration file, see the section below.
42 $bin - Compiled binaries
43 $share - Cistributed read-only data
44 $user - User-created modifiable data
46 Windows .zip / RUN_IN_PLACE source:
53 $share = /usr/share/minetest
59 $user = ~/Library/Application Support/minetest
63 - Worlds can be found as separate folders in:
70 - It is created by Minetest when it is ran the first time.
71 - A specific file can be specified on the command line:
72 --config <path-to-file>
78 Compiling on GNU/Linux:
79 -----------------------
81 Install dependencies. Here's an example for Debian/Ubuntu:
82 $ 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
84 Download source, extract (this is the URL to the latest of source repository, which might not work at all times):
85 $ wget https://github.com/celeron55/minetest/tarball/master -O master.tar.gz
86 $ tar xf master.tar.gz
87 $ cd celeron55-minetest-286edd4 (or similar)
89 Download minetest_game (otherwise only the "Minimal development test" game is available)
91 $ wget https://github.com/celeron55/minetest_game/tarball/master -O master.tar.gz
92 $ tar xf master.tar.gz
93 $ mv celeron55-minetest_game-* minetest_game
96 Build a version that runs directly from the source directory:
97 $ cmake . -DRUN_IN_PLACE=1
104 - Use cmake . -LH to see all CMake options and their current state
105 - If you want to install it system-wide (or are making a distribution package), you will want to use -DRUN_IN_PLACE=0
106 - You can build a bare server or a bare client by specifying -DBUILD_CLIENT=0 or -DBUILD_SERVER=0
107 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
108 - Debug build is slower, but gives much more useful output in a debugger
110 Compiling on Windows:
111 ---------------------
112 - This section is outdated. In addition to what is described here:
113 - In addition to minetest, you need to download minetest_game.
114 - If you wish to have sound support, you need libogg, libvorbis and libopenal
118 http://www.cmake.org/cmake/resources/software.html
119 * MinGW or Visual Studio
120 http://www.mingw.org/
121 http://msdn.microsoft.com/en-us/vstudio/default
123 http://irrlicht.sourceforge.net/downloads.html
124 * Zlib headers (zlib125.zip)
125 http://www.winimage.com/zLibDll/index.html
126 * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
127 http://www.winimage.com/zLibDll/index.html
128 * Optional: gettext bibrary and tools:
129 http://gnuwin32.sourceforge.net/downlinks/gettext.php
130 - This is used for other UI languages. Feel free to leave it out.
131 * And, of course, Minetest-c55:
132 http://c55.me/minetest/download
134 - Select a directory called DIR hereafter in which you will operate.
135 - Make sure you have CMake and a compiler installed.
136 - Download all the other stuff to DIR and extract them into there.
137 ("extract here", not "extract to packagename/")
138 NOTE: zlib125dll.zip needs to be extracted into zlib125dll
139 - All those packages contain a nice base directory in them, which
140 should end up being the direct subdirectories of DIR.
141 - You will end up with a directory structure like this (+=dir, -=file):
147 - 110214175330.zip (or whatever, this is the minetest source)
170 - Start up the CMake GUI
171 - Select "Browse Source..." and select DIR/minetest
172 - Now, if using MSVC:
173 - Select "Browse Build..." and select DIR/minetest-build
174 - Else if using MinGW:
175 - Select "Browse Build..." and select DIR/minetest
177 - Select your compiler
178 - It will warn about missing stuff, ignore that at this point. (later don't)
179 - Make sure the configuration is as follows
180 (note that the versions may differ for you):
184 CMAKE_BUILD_TYPE Release
185 CMAKE_INSTALL_PREFIX DIR/minetest-install
186 IRRLICHT_SOURCE_DIR DIR/irrlicht-1.7.1
189 ZLIB_DLL DIR/zlib125dll/dll32/zlibwapi.dll
190 ZLIB_INCLUDE_DIR DIR/zlib-1.2.5
191 ZLIB_LIBRARIES DIR/zlib125dll/dll32/zlibwapi.lib
192 GETTEXT_BIN_DIR DIR/gettext/bin
193 GETTEXT_INCLUDE_DIR DIR/gettext/include
194 GETTEXT_LIBRARIES DIR/gettext/lib/intl.lib
195 GETTEXT_MSGFMT DIR/gettext/bin/msgfmt
198 - Hit "Configure" once again 8)
199 - If something is still coloured red, you have a problem.
202 - Open the generated minetest.sln
203 - The project defaults to the "Debug" configuration. Make very sure to
204 select "Release", unless you want to debug some stuff (it's slower
205 and might not even work at all)
206 - Build the ALL_BUILD project
207 - Build the INSTALL project
208 - You should now have a working game with the executable in
209 DIR/minetest-install/bin/minetest.exe
210 - Additionally you may create a zip package by building the PACKAGE
213 - Using the command line, browse to the build directory and run 'make'
214 (or mingw32-make or whatever it happens to be)
215 - You may need to copy some of the downloaded DLLs into bin/, see what
216 running the produced executable tells you it doesn't have.
217 - You should now have a working game with the executable in
218 DIR/minetest/bin/minetest.exe
220 Windows releases of minetest are built using a bat script like this:
221 --------------------------------------------------------------------
224 set installpath="C:\tmp\minetest_install"
225 set irrlichtpath="C:\tmp\irrlicht-1.7.2"
227 set builddir=%sourcedir%\bvc10
230 cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=1 -DCMAKE_INSTALL_PREFIX=%installpath%
231 if %errorlevel% neq 0 goto fail
232 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
233 if %errorlevel% neq 0 goto fail
234 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
235 if %errorlevel% neq 0 goto fail
236 "C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
237 if %errorlevel% neq 0 goto fail
247 License of Minetest-c55 textures and sounds
248 -------------------------------------------
250 This applies to textures and sounds contained in the main Minetest
253 Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
254 http://creativecommons.org/licenses/by-sa/3.0/
256 License of Minetest-c55 source code
257 -----------------------------------
260 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
262 This program is free software; you can redistribute it and/or modify
263 it under the terms of the GNU Lesser General Public License as published by
264 the Free Software Foundation; either version 2.1 of the License, or
265 (at your option) any later version.
267 This program is distributed in the hope that it will be useful,
268 but WITHOUT ANY WARRANTY; without even the implied warranty of
269 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
270 GNU General Public License for more details.
272 You should have received a copy of the GNU Lesser General Public License along
273 with this program; if not, write to the Free Software Foundation, Inc.,
274 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
279 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
281 The Irrlicht Engine License
283 Copyright © 2002-2005 Nikolaus Gebhardt
285 This software is provided 'as-is', without any express or implied
286 warranty. In no event will the authors be held liable for any damages
287 arising from the use of this software.
289 Permission is granted to anyone to use this software for any purpose,
290 including commercial applications, and to alter it and redistribute
291 it freely, subject to the following restrictions:
293 1. The origin of this software must not be misrepresented; you
294 must not claim that you wrote the original software. If you use
295 this software in a product, an acknowledgment in the product
296 documentation would be appreciated but is not required.
297 2. Altered source versions must be plainly marked as such, and must
298 not be misrepresented as being the original software.
299 3. This notice may not be removed or altered from any source
306 This program uses the JThread library. License for JThread follows:
308 Copyright (c) 2000-2006 Jori Liesenborgs (jori.liesenborgs@gmail.com)
310 Permission is hereby granted, free of charge, to any person obtaining a
311 copy of this software and associated documentation files (the "Software"),
312 to deal in the Software without restriction, including without limitation
313 the rights to use, copy, modify, merge, publish, distribute, sublicense,
314 and/or sell copies of the Software, and to permit persons to whom the
315 Software is furnished to do so, subject to the following conditions:
317 The above copyright notice and this permission notice shall be included
318 in all copies or substantial portions of the Software.
320 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
321 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
322 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
323 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
324 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
325 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
331 Lua is licensed under the terms of the MIT license reproduced below.
332 This means that Lua is free software and can be used for both academic
333 and commercial purposes at absolutely no cost.
335 For details and rationale, see http://www.lua.org/license.html .
337 Copyright (C) 1994-2008 Lua.org, PUC-Rio.
339 Permission is hereby granted, free of charge, to any person obtaining a copy
340 of this software and associated documentation files (the "Software"), to deal
341 in the Software without restriction, including without limitation the rights
342 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
343 copies of the Software, and to permit persons to whom the Software is
344 furnished to do so, subject to the following conditions:
346 The above copyright notice and this permission notice shall be included in
347 all copies or substantial portions of the Software.
349 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
350 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
351 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
352 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
353 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
354 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
362 Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
363 Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
365 Bitstream Vera Fonts Copyright:
367 Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
368 a trademark of Bitstream, Inc.
370 Arev Fonts Copyright:
372 Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.