]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - README.txt
projects / dragonfireclient.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Merge pull request #447 from sapier/add_lua_log_parameter_check
[dragonfireclient.git] / README.txt
diff --git a/README.txt b/README.txt
index 662f2770b0734d0ca2a6212959cae376b890f4db..8c5a46223ab72b908bf31e1910a1656f746ce702 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,50 +1,76 @@
-Minetest-c55
----------------
+Minetest
+============
+
 An InfiniMiner/Minecraft inspired game.
 An InfiniMiner/Minecraft inspired game.
-Copyright (c) 2010-2011 Perttu Ahola <celeron55@gmail.com>
-(see source files for other contributors)
 
 
-Further documentation:
+Copyright (c) 2010-2012 Perttu Ahola <celeron55@gmail.com>
+and ther contributors (see source file comments and the version control log)
+
+In case you downloaded the source code:
+---------------------------------------
+If you downloaded the Minetest Engine source code in which this file is
+contained, you probably want to download the minetest_game project too:
+  https://github.com/celeron55/minetest_game/
+See the README.txt in it.
+
+Further documentation
 ----------------------
 ----------------------
-- Website: http://celeron.55.lt/~celeron55/minetest/
-- Wiki: http://celeron.55.lt/~celeron55/minetest/wiki/
-- Forum: http://celeron.55.lt/~celeron55/minetest/forum/
+- Website: http://minetest.net/
+- Wiki: http://wiki.minetest.com/
+- Developer wiki: http://minetest.net/wiki/
+- Forum: http://minetest.net/forum/
+- Github: https://github.com/celeron55/minetest/
 - doc/ directory of source distribution
 
 - doc/ directory of source distribution
 
-This game is not finished:
+This game is not finished
 --------------------------
 - Don't expect it to work as well as a finished game will.
 --------------------------
 - Don't expect it to work as well as a finished game will.
-- Please report any bugs to me. debug.txt is useful.
-
-Controls:
----------
-- See the in-game pause menu
+- Please report any bugs. When doing that, debug.txt is useful.
+
+Default Controls
+-----------------
+- WASD: Move
+- Space: Jump
+- E: Go down
+- Shift: Sneak
+- Q: Drop item
+- I: Open inventory
+- Mouse: Turn/look
 - Settable in the configuration file, see the section below.
 
 - Settable in the configuration file, see the section below.
 
-Map directory:
---------------
-- Map is stored in a directory, which can be removed to generate a new map.
-- There is a command-line option for it: --map-dir
-- For a RUN_IN_PLACE build, it is located in:
-               ../map
-- Otherwise something like this:
-       Windows: C:\Documents and Settings\user\Application Data\minetest\map
-       Linux: ~/.minetest/map
-       OS X: ~/Library/Application Support/minetest/map
+Paths
+------
+$bin   - Compiled binaries
+$share - Cistributed read-only data
+$user  - User-created modifiable data
+
+Windows .zip / RUN_IN_PLACE source:
+$bin   = bin
+$share = .
+$user  = .
+
+Linux installed:
+$bin   = /usr/bin
+$share = /usr/share/minetest
+$user  = ~/.minetest
+
+OS X:
+$bin   = ?
+$share = ?
+$user  = ~/Library/Application Support/minetest
+
+World directory
+----------------
+- Worlds can be found as separate folders in:
+    $user/worlds/
 
 Configuration file:
 -------------------
 
 Configuration file:
 -------------------
-- An optional configuration file can be used. See minetest.conf.example.
-- Path to file can be passed as a parameter to the executable:
+- Default location:
+    $user/minetest.conf
+- It is created by Minetest when it is ran the first time.
+- A specific file can be specified on the command line:
        --config <path-to-file>
        --config <path-to-file>
-- Defaults:
-       - If built with -DRUN_IN_PLACE=1:
-               ../minetest.conf
-               ../../minetest.conf
-       - Otherwise something like this:
-               Windows: C:\Documents and Settings\user\Application Data\minetest\minetest.conf
-               Linux: ~/.minetest/minetest.conf
-               OS X: ~/Library/Application Support/minetest.conf
 
 Command-line options:
 ---------------------
 
 Command-line options:
 ---------------------
@@ -54,12 +80,19 @@ Compiling on GNU/Linux:
 -----------------------
 
 Install dependencies. Here's an example for Debian/Ubuntu:
 -----------------------
 
 Install dependencies. Here's an example for Debian/Ubuntu:
-$ apt-get install build-essential libirrlicht-dev cmake libbz2-dev libpng12-dev libjpeg8-dev libxxf86vm-dev libgl1-mesa-dev
+$ apt-get install build-essential libirrlicht-dev cmake libbz2-dev libpng12-dev libjpeg8-dev libxxf86vm-dev libgl1-mesa-dev libsqlite3-dev libogg-dev libvorbis-dev libopenal-dev
 
 Download source, extract (this is the URL to the latest of source repository, which might not work at all times):
 
 Download source, extract (this is the URL to the latest of source repository, which might not work at all times):
-$ wget https://bitbucket.org/celeron55/minetest/get/tip.tar.gz
-$ tar xf tip.tar.gz
-$ cd minetest
+$ wget https://github.com/celeron55/minetest/tarball/master -O master.tar.gz
+$ tar xf master.tar.gz
+$ cd celeron55-minetest-286edd4 (or similar)
+
+Download minetest_game (otherwise only the "Minimal development test" game is available)
+$ cd games/
+$ wget https://github.com/celeron55/minetest_game/tarball/master -O master.tar.gz
+$ tar xf master.tar.gz
+$ mv celeron55-minetest_game-* minetest_game
+$ cd ..
 
 Build a version that runs directly from the source directory:
 $ cmake . -DRUN_IN_PLACE=1
 
 Build a version that runs directly from the source directory:
 $ cmake . -DRUN_IN_PLACE=1
@@ -73,10 +106,13 @@ $ ./minetest
 - If you want to install it system-wide (or are making a distribution package), you will want to use -DRUN_IN_PLACE=0
 - You can build a bare server or a bare client by specifying -DBUILD_CLIENT=0 or -DBUILD_SERVER=0
 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
 - If you want to install it system-wide (or are making a distribution package), you will want to use -DRUN_IN_PLACE=0
 - You can build a bare server or a bare client by specifying -DBUILD_CLIENT=0 or -DBUILD_SERVER=0
 - You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
-  - Note that the Debug build is considerably slower
+  - Debug build is slower, but gives much more useful output in a debugger
 
 Compiling on Windows:
 ---------------------
 
 Compiling on Windows:
 ---------------------
+- This section is outdated. In addition to what is described here:
+  - In addition to minetest, you need to download minetest_game.
+  - If you wish to have sound support, you need libogg, libvorbis and libopenal
 
 - You need:
        * CMake:
 
 - You need:
        * CMake:
@@ -90,16 +126,19 @@ Compiling on Windows:
                http://www.winimage.com/zLibDll/index.html
        * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
                http://www.winimage.com/zLibDll/index.html
                http://www.winimage.com/zLibDll/index.html
        * Zlib library (zlibwapi.lib and zlibwapi.dll from zlib125dll.zip):
                http://www.winimage.com/zLibDll/index.html
-       * gettext bibrary and tools:
+       * Optional: gettext bibrary and tools:
                http://gnuwin32.sourceforge.net/downlinks/gettext.php
                http://gnuwin32.sourceforge.net/downlinks/gettext.php
-       * And, of course, Minetest-c55:
-               http://celeron.55.lt/~celeron55/minetest/download
+               - This is used for other UI languages. Feel free to leave it out.
+       * And, of course, Minetest:
+               http://minetest.net/download.php
 - Steps:
        - Select a directory called DIR hereafter in which you will operate.
        - Make sure you have CMake and a compiler installed.
 - Steps:
        - Select a directory called DIR hereafter in which you will operate.
        - Make sure you have CMake and a compiler installed.
-       - Download all the other stuff to DIR and extract them into there. All those
-         packages contain a nice base directory in them, which should end up being
-         the direct subdirectories of DIR.
+       - Download all the other stuff to DIR and extract them into there.
+         ("extract here", not "extract to packagename/")
+         NOTE: zlib125dll.zip needs to be extracted into zlib125dll
+       - All those packages contain a nice base directory in them, which
+         should end up being the direct subdirectories of DIR.
        - You will end up with a directory structure like this (+=dir, -=file):
        -----------------
        + DIR
        - You will end up with a directory structure like this (+=dir, -=file):
        -----------------
        + DIR
@@ -119,7 +158,7 @@ Compiling on Windows:
                        + lib
                        + include
                        ...
                        + lib
                        + include
                        ...
-               + gettext
+               + gettext (optional)
                        +bin
                        +include
                        +lib
                        +bin
                        +include
                        +lib
@@ -157,11 +196,14 @@ Compiling on Windows:
        GETTEXT_MSGFMT           DIR/gettext/bin/msgfmt
        -----------------
        - Hit "Configure"
        GETTEXT_MSGFMT           DIR/gettext/bin/msgfmt
        -----------------
        - Hit "Configure"
+       - Hit "Configure" once again 8)
+       - If something is still coloured red, you have a problem.
        - Hit "Generate"
        If using MSVC:
                - Open the generated minetest.sln
                - The project defaults to the "Debug" configuration. Make very sure to
        - Hit "Generate"
        If using MSVC:
                - Open the generated minetest.sln
                - The project defaults to the "Debug" configuration. Make very sure to
-                 select "Release", unless you want to debug some stuff (it's slower)
+                 select "Release", unless you want to debug some stuff (it's slower
+                 and might not even work at all)
                - Build the ALL_BUILD project
                - Build the INSTALL project
                - You should now have a working game with the executable in
                - Build the ALL_BUILD project
                - Build the INSTALL project
                - You should now have a working game with the executable in
@@ -171,18 +213,56 @@ Compiling on Windows:
        If using MinGW:
                - Using the command line, browse to the build directory and run 'make'
                  (or mingw32-make or whatever it happens to be)
        If using MinGW:
                - Using the command line, browse to the build directory and run 'make'
                  (or mingw32-make or whatever it happens to be)
+               - You may need to copy some of the downloaded DLLs into bin/, see what
+                 running the produced executable tells you it doesn't have.
                - You should now have a working game with the executable in
                        DIR/minetest/bin/minetest.exe
 
                - You should now have a working game with the executable in
                        DIR/minetest/bin/minetest.exe
 
-License of Minetest-c55
------------------------
-
-Minetest-c55
+Windows releases of minetest are built using a bat script like this:
+--------------------------------------------------------------------
+
+set sourcedir=%CD%
+set installpath="C:\tmp\minetest_install"
+set irrlichtpath="C:\tmp\irrlicht-1.7.2"
+
+set builddir=%sourcedir%\bvc10
+mkdir %builddir%
+pushd %builddir%
+cmake %sourcedir% -G "Visual Studio 10" -DIRRLICHT_SOURCE_DIR=%irrlichtpath% -DRUN_IN_PLACE=1 -DCMAKE_INSTALL_PREFIX=%installpath%
+if %errorlevel% neq 0 goto fail
+"C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" ALL_BUILD.vcxproj /p:Configuration=Release
+if %errorlevel% neq 0 goto fail
+"C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" INSTALL.vcxproj /p:Configuration=Release
+if %errorlevel% neq 0 goto fail
+"C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe" PACKAGE.vcxproj /p:Configuration=Release
+if %errorlevel% neq 0 goto fail
+popd
+echo Finished.
+exit /b 0
+
+:fail
+popd
+echo Failed.
+exit /b 1
+
+License of Minetest textures and sounds
+---------------------------------------
+
+This applies to textures and sounds contained in the main Minetest
+distribution.
+
+Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
+http://creativecommons.org/licenses/by-sa/3.0/
+
+License of Minetest source code
+-------------------------------
+
+Minetest
 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
 (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
@@ -190,7 +270,7 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser General Public License along
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
@@ -246,4 +326,50 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 IN THE SOFTWARE.
 
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 IN THE SOFTWARE.
 
+Lua
+---------------
+
+Lua is licensed under the terms of the MIT license reproduced below.
+This means that Lua is free software and can be used for both academic
+and commercial purposes at absolutely no cost.
+
+For details and rationale, see http://www.lua.org/license.html .
+
+Copyright (C) 1994-2008 Lua.org, PUC-Rio.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Fonts
+---------------
+
+DejaVu Sans Mono:
+
+  Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
+  Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
+
+  Bitstream Vera Fonts Copyright:
+
+  Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
+  a trademark of Bitstream, Inc.
+
+  Arev Fonts Copyright:
+
+  Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
+
 
 
Dragonfireclient is an utility client for the Voxelengine minetest (http://minetest.net/). The client was created by Elias Fleckenstein and is inspired by the Minecraft clients Liquid Bounce and Impact. Discord: https://discord.gg/kab99uu for more information.