]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - README.txt
Texture cache -> Media cache WIP
[dragonfireclient.git] / README.txt
index 41048992e98e10d083b9f413d6789c7005be11e7..6e8889e89fdfe8235fa9305c0c7779ee707a5766 100644 (file)
@@ -1,7 +1,7 @@
 Minetest-c55
 ---------------
 An InfiniMiner/Minecraft inspired game.
-Copyright (c) 2010-2011 Perttu Ahola <celeron55@gmail.com>
+Copyright (c) 2010-2012 Perttu Ahola <celeron55@gmail.com>
 (see source files for other contributors)
 
 Further documentation:
@@ -26,11 +26,11 @@ 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
+               ../world
 - Otherwise something like this:
-       Windows: C:\Documents and Settings\user\Application Data\minetest\map
-       Linux: ~/.minetest/map
-       OS X: ~/Library/Application Support/minetest/map
+       Windows: C:\Documents and Settings\user\Application Data\minetest\world
+       Linux: ~/.minetest/world
+       OS X: ~/Library/Application Support/minetest/world
 
 Configuration file:
 -------------------
@@ -54,12 +54,12 @@ Compiling on GNU/Linux:
 -----------------------
 
 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
 
 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)
 
 Build a version that runs directly from the source directory:
 $ cmake . -DRUN_IN_PLACE=1
@@ -73,7 +73,7 @@ $ ./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>
-  - Note that the Debug build is considerably slower
+  - Debug build is slower, but gives much more useful output in a debugger
 
 Compiling on Windows:
 ---------------------
@@ -90,14 +90,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
+       * Optional: gettext bibrary and tools:
+               http://gnuwin32.sourceforge.net/downlinks/gettext.php
+               - This is used for other UI languages. Feel free to leave it out.
        * And, of course, Minetest-c55:
                http://celeron.55.lt/~celeron55/minetest/download
 - 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
@@ -117,6 +122,10 @@ Compiling on Windows:
                        + lib
                        + include
                        ...
+               + gettext (optional)
+                       +bin
+                       +include
+                       +lib
                + minetest
                        + src
                        + doc
@@ -145,13 +154,20 @@ Compiling on Windows:
        ZLIB_DLL                 DIR/zlib125dll/dll32/zlibwapi.dll
        ZLIB_INCLUDE_DIR         DIR/zlib-1.2.5
        ZLIB_LIBRARIES           DIR/zlib125dll/dll32/zlibwapi.lib
+       GETTEXT_BIN_DIR          DIR/gettext/bin
+       GETTEXT_INCLUDE_DIR      DIR/gettext/include
+       GETTEXT_LIBRARIES        DIR/gettext/lib/intl.lib
+       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
-                 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
@@ -161,11 +177,49 @@ 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)
+               - 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
 
-License of 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-c55 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-c55 source code
+-----------------------------------
 
 Minetest-c55
 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
@@ -237,3 +291,21 @@ 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.
+
+