summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorPerttu Ahola <celeron55@gmail.com>2012-03-26 23:18:17 +0300
committerPerttu Ahola <celeron55@gmail.com>2012-03-26 23:28:19 +0300
commit862d76b6176e60c4a92a316e20b0d7665c92467a (patch)
tree2dbbdb20f900bea41d2b9748b49ffb0cde6d383a /README.txt
parentbd9912213f459d2b86154d17a2cbbe09c4ab562e (diff)
downloadminetest-862d76b6176e60c4a92a316e20b0d7665c92467a.tar.gz
minetest-862d76b6176e60c4a92a316e20b0d7665c92467a.tar.bz2
minetest-862d76b6176e60c4a92a316e20b0d7665c92467a.zip
Move games/minetest to games/minimal and update README.txt
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt91
1 files changed, 58 insertions, 33 deletions
diff --git a/README.txt b/README.txt
index 6e8889e89..e319c3494 100644
--- a/README.txt
+++ b/README.txt
@@ -1,50 +1,75 @@
Minetest-c55
----------------
+============
+
An InfiniMiner/Minecraft inspired game.
+
Copyright (c) 2010-2012 Perttu Ahola <celeron55@gmail.com>
-(see source files for other contributors)
+and ther contributors (see source file comments and the version control log)
-Further documentation:
+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://c55.me/minetest/
+- Wiki: http://c55.me/minetest/wiki/
+- Forum: http://c55.me/minetest/forum/
+- Github: https://github.com/celeron55/minetest/
- 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.
-- 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.
-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:
- ../world
-- Otherwise something like this:
- Windows: C:\Documents and Settings\user\Application Data\minetest\world
- Linux: ~/.minetest/world
- OS X: ~/Library/Application Support/minetest/world
+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:
-------------------
-- 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>
-- 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:
---------------------
@@ -94,7 +119,7 @@ Compiling on Windows:
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
+ http://c55.me/minetest/download
- Steps:
- Select a directory called DIR hereafter in which you will operate.
- Make sure you have CMake and a compiler installed.