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 This is a development version:
   9 - Don't expect it to work as well as a finished game will.
  10 - Please report any bugs to me. That way I can fix them to the next release.
  11         - debug.txt is very useful when the game crashes.
  12
  13 Public servers:
  14         kray.dy.fi :30000 (friend's server - usually in creative mode)
  15         celer.oni.biz :30000 (main development server)
  16 - Both of these have very limited bandwidth and the game will become laggy
  17   with 4-5 players.
  18 - If you want to run a server, I can list you on my website and in here.
  19
  20 Features, as of now:
  21 - Almost Infinite Map (limited to +-31000 blocks in any direction at the moment)
  22     - Minecraft alpha has a height restriction of 128 blocks
  23 - Map Generator capable of taking advantage of the infinite map
  24
  25 Controls:
  26 - WASD+mouse: Move
  27 - Mouse L: Dig
  28 - Mouse R: Place block
  29 - Mouse Wheel: Change item
  30 - F: Change item
  31 - R: Toggle full view range
  32
  33 Configuration file:
  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 - If not given as a parameter, these are checked, in order:
  38         ../minetest.conf
  39         ../../minetest.conf
  40
  41 Command-line options:
  42 - Use --help
  43
  44 Running on Windows:
  45 - The working directory should be ./bin
  46
  47 Running on GNU/Linux:
  48 - fasttest is a linux binary compiled on a recent Arch Linux installation.
  49   It should run on most recent GNU/Linux distributions.
  50 - Browse to the game ./bin directory and type:
  51     LD_LIBRARY_PATH=. ./fasttest
  52 - If it doesn't work, use wine. I aim at 100% compatibility with wine.
  53
  54 Compiling on GNU/Linux:
  55 - You need:
  56 * Irrlicht:
  57         http://downloads.sourceforge.net/irrlicht/irrlicht-1.7.2.zip
  58 * JThread:
  59         http://research.edm.uhasselt.be/~jori/page/index.php?n=CS.Jthread
  60 * zlib:
  61         - Get the -dev package from your package manager.
  62 - Irrlicht and JThread are very likely not to be found from your distro's
  63   repository.
  64 - Compiling each of them should be fairly unproblematic, though.
  65
  66 Compiling on Windows:
  67 - You need Irrlicht, JThread and zlib, see above
  68 - Be sure to
  69   #define JMUTEX_CRITICALSECTION
  70   in jmutex.h before compiling it. Otherwise mutexes will be very slow.
  71
  72 License of Minetest-c55
  73 -----------------------
  74
  75 Minetest-c55
  76 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
  77
  78 This program is free software; you can redistribute it and/or modify
  79 it under the terms of the GNU General Public License as published by
  80 the Free Software Foundation; either version 2 of the License, or
  81 (at your option) any later version.
  82
  83 This program is distributed in the hope that it will be useful,
  84 but WITHOUT ANY WARRANTY; without even the implied warranty of
  85 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  86 GNU General Public License for more details.
  87
  88 You should have received a copy of the GNU General Public License along
  89 with this program; if not, write to the Free Software Foundation, Inc.,
  90 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  91
  92 Irrlicht
  93 ---------------
  94
  95 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
  96
  97  The Irrlicht Engine License
  98
  99 Copyright © 2002-2005 Nikolaus Gebhardt
 100
 101 This software is provided 'as-is', without any express or implied
 102 warranty. In no event will the authors be held liable for any damages
 103 arising from the use of this software.
 104
 105 Permission is granted to anyone to use this software for any purpose,
 106 including commercial applications, and to alter it and redistribute
 107 it freely, subject to the following restrictions:
 108
 109    1. The origin of this software must not be misrepresented; you
 110       must not claim that you wrote the original software. If you use
 111           this software in a product, an acknowledgment in the product
 112           documentation would be appreciated but is not required.
 113    2. Altered source versions must be plainly marked as such, and must
 114       not be misrepresented as being the original software.
 115    3. This notice may not be removed or altered from any source
 116       distribution.
 117
 118
 119 JThread
 120 ---------------
 121
 122 This program uses the JThread library. License for JThread follows:
 123
 124 Copyright (c) 2000-2006  Jori Liesenborgs (jori.liesenborgs@gmail.com)
 125
 126 Permission is hereby granted, free of charge, to any person obtaining a
 127 copy of this software and associated documentation files (the "Software"),
 128 to deal in the Software without restriction, including without limitation
 129 the rights to use, copy, modify, merge, publish, distribute, sublicense,
 130 and/or sell copies of the Software, and to permit persons to whom the
 131 Software is furnished to do so, subject to the following conditions:
 132
 133 The above copyright notice and this permission notice shall be included
 134 in all copies or substantial portions of the Software.
 135
 136 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 137 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 138 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 139 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 140 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 141 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 142 IN THE SOFTWARE.
 143
 144