README.txt

   1 Minetest-c55
   2 ============
   3
   4 An InfiniMiner/Minecraft inspired game.
   5
   6 Copyright (c) 2010-2012 Perttu Ahola <celeron55@gmail.com>
   7 and ther 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/celeron55/minetest_game/
  14 See the README.txt in it.
  15
  16 Further documentation
  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
  23
  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.
  28
  29 Default Controls
  30 -----------------
  31 - WASD: Move
  32 - Space: Jump
  33 - E: Go down
  34 - Shift: Sneak
  35 - Q: Drop item
  36 - I: Open inventory
  37 - Mouse: Turn/look
  38 - Settable in the configuration file, see the section below.
  39
  40 Paths
  41 ------
  42 $bin   - Compiled binaries
  43 $share - Cistributed read-only data
  44 $user  - User-created modifiable data
  45
  46 Windows .zip / RUN_IN_PLACE source:
  47 $bin   = bin
  48 $share = .
  49 $user  = .
  50
  51 Linux installed:
  52 $bin   = /usr/bin
  53 $share = /usr/share/minetest
  54 $user  = ~/.minetest
  55
  56 OS X:
  57 $bin   = ?
  58 $share = ?
  59 $user  = ~/Library/Application Support/minetest
  60
  61 World directory
  62 ----------------
  63 - Worlds can be found as separate folders in:
  64     $user/worlds/
  65
  66 Configuration file:
  67 -------------------
  68 - Default location:
  69     $user/minetest.conf
  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>
  73
  74 Command-line options:
  75 ---------------------
  76 - Use --help
  77
  78 Compiling on GNU/Linux:
  79 -----------------------
  80
  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
  83
  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)
  88
  89 Download minetest_game (otherwise only the "Minimal development test" game is available)
  90 $ cd games/
  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
  94 $ cd ..
  95
  96 Build a version that runs directly from the source directory:
  97 $ cmake . -DRUN_IN_PLACE=1
  98 $ make -j2
  99
 100 Run it:
 101 $ cd bin
 102 $ ./minetest
 103
 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
 109
 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
 115
 116 - You need:
 117         * CMake:
 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
 122         * Irrlicht SDK 1.7:
 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
 133 - Steps:
 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):
 142         -----------------
 143         + DIR
 144                 - zlib-1.2.5.tar.gz
 145                 - zlib125dll.zip
 146                 - irrlicht-1.7.1.zip
 147                 - 110214175330.zip (or whatever, this is the minetest source)
 148                 + zlib-1.2.5
 149                         - zlib.h
 150                         + win32
 151                         ...
 152                 + zlib125dll
 153                         - readme.txt
 154                         + dll32
 155                         ...
 156                 + irrlicht-1.7.1
 157                         + lib
 158                         + include
 159                         ...
 160                 + gettext (optional)
 161                         +bin
 162                         +include
 163                         +lib
 164                 + minetest
 165                         + src
 166                         + doc
 167                         - CMakeLists.txt
 168                         ...
 169         -----------------
 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
 176         - Select "Configure"
 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):
 181         -----------------
 182         BUILD_CLIENT             [X]
 183         BUILD_SERVER             [ ]
 184         CMAKE_BUILD_TYPE         Release
 185         CMAKE_INSTALL_PREFIX     DIR/minetest-install
 186         IRRLICHT_SOURCE_DIR      DIR/irrlicht-1.7.1
 187         RUN_IN_PLACE             [X]
 188         WARN_ALL                 [ ]
 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
 196         -----------------
 197         - Hit "Configure"
 198         - Hit "Configure" once again 8)
 199         - If something is still coloured red, you have a problem.
 200         - Hit "Generate"
 201         If using MSVC:
 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
 211                   project.
 212         If using MinGW:
 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
 219
 220 Windows releases of minetest are built using a bat script like this:
 221 --------------------------------------------------------------------
 222
 223 set sourcedir=%CD%
 224 set installpath="C:\tmp\minetest_install"
 225 set irrlichtpath="C:\tmp\irrlicht-1.7.2"
 226
 227 set builddir=%sourcedir%\bvc10
 228 mkdir %builddir%
 229 pushd %builddir%
 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
 238 popd
 239 echo Finished.
 240 exit /b 0
 241
 242 :fail
 243 popd
 244 echo Failed.
 245 exit /b 1
 246
 247 License of Minetest-c55 textures and sounds
 248 -------------------------------------------
 249
 250 This applies to textures and sounds contained in the main Minetest
 251 distribution.
 252
 253 Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
 254 http://creativecommons.org/licenses/by-sa/3.0/
 255
 256 License of Minetest-c55 source code
 257 -----------------------------------
 258
 259 MOST of code:
 260 -------------
 261 Minetest-c55
 262 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
 263
 264 This program is free software; you can redistribute it and/or modify
 265 it under the terms of the GNU Lesser General Public License as published by
 266 the Free Software Foundation; either version 2.1 of the License, or
 267 (at your option) any later version.
 268
 269 This program is distributed in the hope that it will be useful,
 270 but WITHOUT ANY WARRANTY; without even the implied warranty of
 271 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 272 GNU General Public License for more details.
 273
 274 You should have received a copy of the GNU Lesser General Public License along
 275 with this program; if not, write to the Free Software Foundation, Inc.,
 276 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 277
 278 Some code:
 279 ----------
 280 Some code in
 281 - src/clouds.cpp
 282 is distributed under (GPLv2 OR later) OR (LGPLv3 OR LATER), at your opinion.
 283 The conflicting parts can be determined by looking at the version control history.
 284 These parts will be shortly rewritten to a reasonable extent.
 285
 286 Irrlicht
 287 ---------------
 288
 289 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
 290
 291  The Irrlicht Engine License
 292
 293 Copyright © 2002-2005 Nikolaus Gebhardt
 294
 295 This software is provided 'as-is', without any express or implied
 296 warranty. In no event will the authors be held liable for any damages
 297 arising from the use of this software.
 298
 299 Permission is granted to anyone to use this software for any purpose,
 300 including commercial applications, and to alter it and redistribute
 301 it freely, subject to the following restrictions:
 302
 303    1. The origin of this software must not be misrepresented; you
 304       must not claim that you wrote the original software. If you use
 305           this software in a product, an acknowledgment in the product
 306           documentation would be appreciated but is not required.
 307    2. Altered source versions must be plainly marked as such, and must
 308       not be misrepresented as being the original software.
 309    3. This notice may not be removed or altered from any source
 310       distribution.
 311
 312
 313 JThread
 314 ---------------
 315
 316 This program uses the JThread library. License for JThread follows:
 317
 318 Copyright (c) 2000-2006  Jori Liesenborgs (jori.liesenborgs@gmail.com)
 319
 320 Permission is hereby granted, free of charge, to any person obtaining a
 321 copy of this software and associated documentation files (the "Software"),
 322 to deal in the Software without restriction, including without limitation
 323 the rights to use, copy, modify, merge, publish, distribute, sublicense,
 324 and/or sell copies of the Software, and to permit persons to whom the
 325 Software is furnished to do so, subject to the following conditions:
 326
 327 The above copyright notice and this permission notice shall be included
 328 in all copies or substantial portions of the Software.
 329
 330 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 331 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 332 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 333 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 334 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 335 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 336 IN THE SOFTWARE.
 337
 338 Lua
 339 ---------------
 340
 341 Lua is licensed under the terms of the MIT license reproduced below.
 342 This means that Lua is free software and can be used for both academic
 343 and commercial purposes at absolutely no cost.
 344
 345 For details and rationale, see http://www.lua.org/license.html .
 346
 347 Copyright (C) 1994-2008 Lua.org, PUC-Rio.
 348
 349 Permission is hereby granted, free of charge, to any person obtaining a copy
 350 of this software and associated documentation files (the "Software"), to deal
 351 in the Software without restriction, including without limitation the rights
 352 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 353 copies of the Software, and to permit persons to whom the Software is
 354 furnished to do so, subject to the following conditions:
 355
 356 The above copyright notice and this permission notice shall be included in
 357 all copies or substantial portions of the Software.
 358
 359 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 360 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 361 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
 362 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 363 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 364 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 365 THE SOFTWARE.
 366
 367 Fonts
 368 ---------------
 369
 370 DejaVu Sans Mono:
 371
 372   Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
 373   Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
 374
 375   Bitstream Vera Fonts Copyright:
 376
 377   Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
 378   a trademark of Bitstream, Inc.
 379
 380   Arev Fonts Copyright:
 381
 382   Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
 383
 384