3 An InfiniMiner/Minecraft inspired game.
4 Copyright (c) 2010-2011 Perttu Ahola <celeron55@gmail.com>
5 (see source files for other contributors)
9 - Website: http://celeron.55.lt/~celeron55/minetest/
10 - Wiki: http://celeron.55.lt/~celeron55/minetest/wiki/
11 - Forum: http://celeron.55.lt/~celeron55/minetest/forum/
12 - doc/ directory of source distribution
14 This game is not finished:
15 --------------------------
16 - Don't expect it to work as well as a finished game will.
17 - Please report any bugs to me. debug.txt is useful.
21 - See the in-game pause menu
22 - Settable in the configuration file, see the section below.
26 - Map is stored in a directory, which can be removed to generate a new map.
27 - There is a command-line option for it: --map-dir
28 - For a RUN_IN_PLACE build, it is located in:
30 - Otherwise something like this:
31 Windows: C:\Documents and Settings\user\Application Data\minetest\world
32 Linux: ~/.minetest/world
33 OS X: ~/Library/Application Support/minetest/world
37 - An optional configuration file can be used. See minetest.conf.example.
38 - Path to file can be passed as a parameter to the executable:
39 --config <path-to-file>
41 - If built with -DRUN_IN_PLACE=1:
44 - Otherwise something like this:
45 Windows: C:\Documents and Settings\user\Application Data\minetest\minetest.conf
46 Linux: ~/.minetest/minetest.conf
47 OS X: ~/Library/Application Support/minetest.conf
53 Compiling on GNU/Linux:
54 -----------------------
56 Install dependencies. Here's an example for Debian/Ubuntu:
57 $ apt-get install build-essential libirrlicht-dev cmake libbz2-dev libpng12-dev libjpeg8-dev libxxf86vm-dev libgl1-mesa-dev
59 Download source, extract (this is the URL to the latest of source repository, which might not work at all times):
60 $ wget https://bitbucket.org/celeron55/minetest/get/tip.tar.gz
64 Build a version that runs directly from the source directory:
65 $ cmake . -DRUN_IN_PLACE=1
72 - Use cmake . -LH to see all CMake options and their current state
73 - If you want to install it system-wide (or are making a distribution package), you will want to use -DRUN_IN_PLACE=0
74 - You can build a bare server or a bare client by specifying -DBUILD_CLIENT=0 or -DBUILD_SERVER=0
75 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
76 - Note that the Debug build is considerably slower
83 http://www.cmake.org/cmake/resources/software.html
84 * MinGW or Visual Studio
86 http://msdn.microsoft.com/en-us/vstudio/default
88 http://irrlicht.sourceforge.net/downloads.html
89 * Zlib headers (zlib125.zip)
90 http://www.winimage.com/zLibDll/index.html
91 * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
92 http://www.winimage.com/zLibDll/index.html
93 * gettext bibrary and tools:
94 http://gnuwin32.sourceforge.net/downlinks/gettext.php
95 * And, of course, Minetest-c55:
96 http://celeron.55.lt/~celeron55/minetest/download
98 - Select a directory called DIR hereafter in which you will operate.
99 - Make sure you have CMake and a compiler installed.
100 - Download all the other stuff to DIR and extract them into there. All those
101 packages contain a nice base directory in them, which should end up being
102 the direct subdirectories of DIR.
103 - You will end up with a directory structure like this (+=dir, -=file):
109 - 110214175330.zip (or whatever, this is the minetest source)
132 - Start up the CMake GUI
133 - Select "Browse Source..." and select DIR/minetest
134 - Now, if using MSVC:
135 - Select "Browse Build..." and select DIR/minetest-build
136 - Else if using MinGW:
137 - Select "Browse Build..." and select DIR/minetest
139 - Select your compiler
140 - It will warn about missing stuff, ignore that at this point. (later don't)
141 - Make sure the configuration is as follows
142 (note that the versions may differ for you):
146 CMAKE_BUILD_TYPE Release
147 CMAKE_INSTALL_PREFIX DIR/minetest-install
148 IRRLICHT_SOURCE_DIR DIR/irrlicht-1.7.1
151 ZLIB_DLL DIR/zlib125dll/dll32/zlibwapi.dll
152 ZLIB_INCLUDE_DIR DIR/zlib-1.2.5
153 ZLIB_LIBRARIES DIR/zlib125dll/dll32/zlibwapi.lib
154 GETTEXT_BIN_DIR DIR/gettext/bin
155 GETTEXT_INCLUDE_DIR DIR/gettext/include
156 GETTEXT_LIBRARIES DIR/gettext/lib/intl.lib
157 GETTEXT_MSGFMT DIR/gettext/bin/msgfmt
160 - Hit "Configure" once again 8)
161 - If something is still coloured red, you have a problem.
164 - Open the generated minetest.sln
165 - The project defaults to the "Debug" configuration. Make very sure to
166 select "Release", unless you want to debug some stuff (it's slower)
167 - Build the ALL_BUILD project
168 - Build the INSTALL project
169 - You should now have a working game with the executable in
170 DIR/minetest-install/bin/minetest.exe
171 - Additionally you may create a zip package by building the PACKAGE
174 - Using the command line, browse to the build directory and run 'make'
175 (or mingw32-make or whatever it happens to be)
176 - You should now have a working game with the executable in
177 DIR/minetest/bin/minetest.exe
179 License of Minetest-c55
180 -----------------------
183 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
185 This program is free software; you can redistribute it and/or modify
186 it under the terms of the GNU General Public License as published by
187 the Free Software Foundation; either version 2 of the License, or
188 (at your option) any later version.
190 This program is distributed in the hope that it will be useful,
191 but WITHOUT ANY WARRANTY; without even the implied warranty of
192 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
193 GNU General Public License for more details.
195 You should have received a copy of the GNU General Public License along
196 with this program; if not, write to the Free Software Foundation, Inc.,
197 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
202 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
204 The Irrlicht Engine License
206 Copyright © 2002-2005 Nikolaus Gebhardt
208 This software is provided 'as-is', without any express or implied
209 warranty. In no event will the authors be held liable for any damages
210 arising from the use of this software.
212 Permission is granted to anyone to use this software for any purpose,
213 including commercial applications, and to alter it and redistribute
214 it freely, subject to the following restrictions:
216 1. The origin of this software must not be misrepresented; you
217 must not claim that you wrote the original software. If you use
218 this software in a product, an acknowledgment in the product
219 documentation would be appreciated but is not required.
220 2. Altered source versions must be plainly marked as such, and must
221 not be misrepresented as being the original software.
222 3. This notice may not be removed or altered from any source
229 This program uses the JThread library. License for JThread follows:
231 Copyright (c) 2000-2006 Jori Liesenborgs (jori.liesenborgs@gmail.com)
233 Permission is hereby granted, free of charge, to any person obtaining a
234 copy of this software and associated documentation files (the "Software"),
235 to deal in the Software without restriction, including without limitation
236 the rights to use, copy, modify, merge, publish, distribute, sublicense,
237 and/or sell copies of the Software, and to permit persons to whom the
238 Software is furnished to do so, subject to the following conditions:
240 The above copyright notice and this permission notice shall be included
241 in all copies or substantial portions of the Software.
243 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
244 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
245 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
246 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
247 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
248 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS