doc/README.txt

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