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