doc/README.txt

   1 Minetest-c55
   2 ---------------
   3 An InfiniMiner/Minecraft inspired game.
   4 Copyright (c) 2010 Perttu Ahola <celeron55@gmail.com>
   5
   6 This is a development version:
   7 ------------------------------
   8 - Don't expect it to work as well as a finished game will.
   9 - Please report any bugs to me. That way I can fix them to the next release.
  10         - debug.txt is useful when the game crashes.
  11
  12 Public servers:
  13 ---------------
  14         kray.dy.fi :30000 (friend's server)
  15         celeron.55.lt :30000 (my own server)
  16
  17 Controls:
  18 ---------
  19 - See the in-game pause menu
  20
  21 Map directory:
  22 --------------
  23 - Map is stored in a directory, which can be removed to generate a new map.
  24 - There is a command-line option for it: --map-dir
  25 - As default, it is located in:
  26                 ../map
  27 - Otherwise something like this:
  28         Windows: C:\Documents and Settings\user\Application Data\minetest\map
  29         Linux: ~/.minetest/map
  30         OS X: ~/Library/Application Support/minetest/map
  31
  32 Configuration file:
  33 -------------------
  34 - An optional configuration file can be used. See minetest.conf.example.
  35 - Path to file can be passed as a parameter to the executable:
  36         --config <path-to-file>
  37 - Defaults:
  38         - If built with -DRUN_IN_PLACE:
  39                 ../minetest.conf
  40                 ../../minetest.conf
  41         - Otherwise something like this:
  42                 Windows: C:\Documents and Settings\user\Application Data\minetest\minetest.conf
  43                 Linux: ~/.minetest/minetest.conf
  44                 OS X: ~/Library/Application Support/minetest.conf
  45
  46 Command-line options:
  47 ---------------------
  48 - Use --help
  49
  50 Compiling on GNU/Linux:
  51 -----------------------
  52
  53 Install dependencies. Here's an example for Debian/Ubuntu:
  54 $ apt-get install libirrlicht-dev cmake libbz2-dev libpng12-dev libjpeg8-dev libxxf86vm-dev
  55
  56 Download source, extract (this is the URL to the latest of source repository, which might not work at all times):
  57 $ wget https://bitbucket.org/celeron55/minetest/get/tip.tar.gz
  58 $ tar xf tip.tar.gz
  59 $ cd minetest
  60
  61 Build a version that runs directly from the source directory:
  62 $ cmake . -DRUN_IN_PLACE=1
  63 $ make -j2
  64
  65 Run it:
  66 $ cd bin
  67 $ ./minetest
  68
  69 - Use cmake . -LH to see all CMake options and their current state
  70 - If you want to install it system-wide (or are making a distribution package), you will want to use -DRUN_IN_PLACE=0
  71 - You can build a bare server or a bare client by specifying -DBUILD_CLIENT=0 or -DBUILD_SERVER=0
  72 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
  73   - Note that the Debug build is considerably slower
  74
  75 Compiling on Windows:
  76 - NOTE: Seems that the CMake build system produces executables that don't work
  77   for many people. The old build system is still included, but it's not
  78   documented anywhere.
  79 - You need CMake, Irrlicht, Zlib and Visual Studio or MinGW
  80 - NOTE: Probably it will not work easily and you will need to fix some stuff.
  81 - Steps:
  82         - Start up the CMake GUI
  83         - Select your compiler
  84         - Hit "Configure"
  85         - Set up some options and paths
  86         - Hit "Configure"
  87         - Hit "Generate"
  88         - MSVC: Open the generated .sln and build it
  89           MinGW: Browse to the build directory and run 'make'
  90
  91 License of Minetest-c55
  92 -----------------------
  93
  94 Minetest-c55
  95 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
  96
  97 This program is free software; you can redistribute it and/or modify
  98 it under the terms of the GNU General Public License as published by
  99 the Free Software Foundation; either version 2 of the License, or
 100 (at your option) any later version.
 101
 102 This program is distributed in the hope that it will be useful,
 103 but WITHOUT ANY WARRANTY; without even the implied warranty of
 104 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 105 GNU General Public License for more details.
 106
 107 You should have received a copy of the GNU General Public License along
 108 with this program; if not, write to the Free Software Foundation, Inc.,
 109 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 110
 111 Irrlicht
 112 ---------------
 113
 114 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
 115
 116  The Irrlicht Engine License
 117
 118 Copyright © 2002-2005 Nikolaus Gebhardt
 119
 120 This software is provided 'as-is', without any express or implied
 121 warranty. In no event will the authors be held liable for any damages
 122 arising from the use of this software.
 123
 124 Permission is granted to anyone to use this software for any purpose,
 125 including commercial applications, and to alter it and redistribute
 126 it freely, subject to the following restrictions:
 127
 128    1. The origin of this software must not be misrepresented; you
 129       must not claim that you wrote the original software. If you use
 130           this software in a product, an acknowledgment in the product
 131           documentation would be appreciated but is not required.
 132    2. Altered source versions must be plainly marked as such, and must
 133       not be misrepresented as being the original software.
 134    3. This notice may not be removed or altered from any source
 135       distribution.
 136
 137
 138 JThread
 139 ---------------
 140
 141 This program uses the JThread library. License for JThread follows:
 142
 143 Copyright (c) 2000-2006  Jori Liesenborgs (jori.liesenborgs@gmail.com)
 144
 145 Permission is hereby granted, free of charge, to any person obtaining a
 146 copy of this software and associated documentation files (the "Software"),
 147 to deal in the Software without restriction, including without limitation
 148 the rights to use, copy, modify, merge, publish, distribute, sublicense,
 149 and/or sell copies of the Software, and to permit persons to whom the
 150 Software is furnished to do so, subject to the following conditions:
 151
 152 The above copyright notice and this permission notice shall be included
 153 in all copies or substantial portions of the Software.
 154
 155 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 156 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 157 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 158 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 159 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 160 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 161 IN THE SOFTWARE.
 162
 163