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