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