]> git.lizzy.rs Git - minetest.git/blob - doc/README.txt
doc update
[minetest.git] / 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 - If not given as a parameter, these are checked, in order:
37         ../minetest.conf
38         ../../minetest.conf
39
40 Running on Windows:
41 - The working directory should be ./bin
42
43 Running on GNU/Linux:
44 - fasttest is a linux binary compiled on a recent Arch Linux installation.
45   It should run on most recent GNU/Linux distributions.
46 - Browse to the game ./bin directory and type:
47     LD_LIBRARY_PATH=. ./fasttest
48 - If it doesn't work, use wine. I aim at 100% compatibility with wine.
49
50 Compiling on GNU/Linux:
51 - You need:
52 * Irrlicht:
53         http://downloads.sourceforge.net/irrlicht/irrlicht-1.7.2.zip
54 * JThread:
55         http://research.edm.uhasselt.be/~jori/page/index.php?n=CS.Jthread
56 - Neither of which can probably be found from your distro's repository.
57 - Compiling each of them should be fairly unproblematic, though.
58
59 Compiling on Windows:
60 - Be sure to
61   #define JMUTEX_CRITICALSECTION
62   in jmutex.h before compiling it. Otherwise mutexes will be very slow.
63
64 License of Minetest-c55
65 -----------------------
66
67 Minetest-c55
68 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
69
70 This program is free software; you can redistribute it and/or modify
71 it under the terms of the GNU General Public License as published by
72 the Free Software Foundation; either version 2 of the License, or
73 (at your option) any later version.
74
75 This program is distributed in the hope that it will be useful,
76 but WITHOUT ANY WARRANTY; without even the implied warranty of
77 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
78 GNU General Public License for more details.
79
80 You should have received a copy of the GNU General Public License along
81 with this program; if not, write to the Free Software Foundation, Inc.,
82 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
83
84
85 Irrlicht
86 ---------------
87
88 This program uses the Irrlicht Engine. http://irrlicht.sourceforge.net/
89
90  The Irrlicht Engine License
91
92 Copyright © 2002-2005 Nikolaus Gebhardt
93
94 This software is provided 'as-is', without any express or implied
95 warranty. In no event will the authors be held liable for any damages
96 arising from the use of this software.
97
98 Permission is granted to anyone to use this software for any purpose,
99 including commercial applications, and to alter it and redistribute
100 it freely, subject to the following restrictions:
101
102    1. The origin of this software must not be misrepresented; you
103       must not claim that you wrote the original software. If you use
104           this software in a product, an acknowledgment in the product
105           documentation would be appreciated but is not required.
106    2. Altered source versions must be plainly marked as such, and must
107       not be misrepresented as being the original software.
108    3. This notice may not be removed or altered from any source
109       distribution.
110
111
112 JThread
113 ---------------
114
115 This program uses the JThread library. License for JThread follows:
116
117 Copyright (c) 2000-2006  Jori Liesenborgs (jori.liesenborgs@gmail.com)
118
119 Permission is hereby granted, free of charge, to any person obtaining a
120 copy of this software and associated documentation files (the "Software"),
121 to deal in the Software without restriction, including without limitation
122 the rights to use, copy, modify, merge, publish, distribute, sublicense,
123 and/or sell copies of the Software, and to permit persons to whom the
124 Software is furnished to do so, subject to the following conditions:
125
126 The above copyright notice and this permission notice shall be included
127 in all copies or substantial portions of the Software.
128
129 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
130 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
131 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
132 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
133 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
134 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
135 IN THE SOFTWARE.
136
137