README.txt

   1 ========================================================================
   2                                 README
   3 ========================================================================
   4
   5 ABOUT:
   6 Voxelands is a sandbox construction game based on Minetest, which was
   7  inspired by earlier "voxel world" games such as Infiniminer. Gameplay
   8  puts players in a fully destructible 3D game world where they can place
   9  and dig numerous types of blocks, items and creatures using a variety
  10  of tools. Inside the game world players can build structures, artworks
  11  and anything else their creativity can think of on multiplayer servers
  12  and singleplayer worlds across multiple game modes.
  13
  14 DEPENDENCIES:
  15 Voxelands requires the standard C++ library, irrlicht 1.8 or later,
  16  freetype, openAL, vorbisfile, ogg, zlib. CMake, make, and g++ (or other
  17  C++ compiler) and bzip2 and jpeg are required to build from source.
  18
  19 INSTALL:
  20 If you're reading this then you've already unpacked the tarball, so
  21  just:
  22 1) cd /path/to/voxelands
  23 2) cmake -DRUN_IN_PLACE=1 .
  24 3) make -j3
  25
  26 Other optional cmake parameters:
  27 1) -DBUILD_SERVER=0 (default 1) builds the dedicated server
  28 2) -DBUILD_CLIENT=0 (default 1) builds the rich client
  29 3) -DENABLE_AUDIO=0 (default 1) enables audio support
  30
  31 The option -DRUN_IN_PLACE expects the user to run voxelands from the extracted source directory.
  32
  33 WINDOWS:
  34 Voxelands can be cross compiled with mingw, or built natively with MSVC,
  35  instructions for the latter are available on the forums:
  36  http://forum.voxelands.com
  37
  38 USE:
  39 Simply run bin/voxelands from any console/terminal.
  40
  41 CONTROLS:
  42 Controls can be set in the Settings tab of the main menu
  43
  44 Main controls:
  45
  46     W, S, A, D - Walk forward backward, left, and right.
  47     Mouse - Look / Aim.
  48     Mouse wheel - Change wielded item.
  49     1 through 8 - Change wielded item.
  50     Right Mouse Button - Place item.
  51     Left Mouse Button - Dig / Punch / Attack.
  52     Shift - Sneak.
  53     Space - Jump.
  54     R - Move Up (ladders, swimming, flying)
  55     F - Move Down (ladders, swimming, flying)
  56     E - Run.
  57
  58 Action controls:
  59
  60     I - Enter inventory.
  61     Q - Examine pointed block.
  62     H - Use item in hand.
  63 =======
  64     T - Talk / commands.
  65     K - Toggle fly mode.
  66     F1 - Hide / show hud.
  67     F2 - Hide / show chat.
  68     F3 - Disable / enable fog.
  69     F4 - Disable / enable camera update.
  70     F5 - Toggle through debug information.
  71     F6 - Toggle through profiler (info on FPS, chunk updates, etc.)
  72     F12 - Take a screenshot.
  73
  74
  75 LICENSE:
  76 Code:
  77 Voxelands is licensed under the GPLv3 or later.
  78 Copyright (c) 2013-2016 Lisa 'darkrose' Milne <lisa@ltmnet.com>
  79 Forked from Minetest 0.3.x
  80 Copyright (c) 2010-2011 Perttu Ahola <celeron55@gmail.com>
  81
  82 Textures, Sounds, and Models:
  83
  84 This does not apply to texture packs made by others.
  85
  86 Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
  87 http://creativecommons.org/licenses/by-sa/3.0/
  88
  89 To satisfy the attribution clause, any project using Voxelands' assets
  90  must provide a prominent notice as part of each of said project's
  91  credits notices (such as in documentation, on a website, and/or any
  92  other credits screen associated with the project) showing both the
  93  CC-BY-SA licensing, the ownership by Voxelands of the asset, and a link
  94  to the Voxelands' project at http://www.voxelands.com/.
  95
  96 Artists include:
  97 sdzen
  98 darkrose
  99 sapier
 100 Tom Peter
 101 Telaron
 102 juskiddink
 103 With special thanks to http://www.opengameart.org/
 104
 105 DEVELOPMENT:
 106 Voxelands is under active development, the latest updates can be found
 107  at:
 108   https://gitlab.com/voxelands/voxelands
 109  or on IRC at:
 110   irc.entropynet.net #voxelands
 111
 112 CHANGES:
 113 See doc/changelog.txt