Go to file
darkrose 3f8324d7e0 ensure getUser() returns a valid player name 2015-12-28 01:09:35 +10:00
.tx setup for transifex 2014-09-27 18:37:51 +10:00
cmake/Modules gettext cmake changes 2015-04-12 16:03:18 +10:00
data add support for privileged crafting, add mithril key 2015-12-28 01:09:35 +10:00
doc 1510.01 2015-11-14 17:07:21 +10:00
misc script tweaks for the new stable release 2014-11-17 18:38:55 +10:00
po translation updates 2015-10-24 22:40:58 +10:00
src ensure getUser() returns a valid player name 2015-12-28 01:09:35 +10:00
util api pt2 2015-04-17 02:52:33 +10:00
.gitignore new multiplayer menu, pt3 2015-12-28 01:09:35 +10:00
CMakeLists.txt this is next 2015-12-28 01:09:34 +10:00
README.txt add new controls to readme file 2015-08-16 17:15:45 +10:00
voxelands-icon.ico update logos - still need svg logo 2014-09-27 18:37:51 +10:00
voxelands.conf.example add mapgen types to gui 2014-10-23 04:40:15 +10:00

README.txt

========================================================================
				README
========================================================================

ABOUT:
Voxelands is a sandbox construction game based on Minetest, which was
 inspired by earlier "voxel world" games such as Infiniminer. Gameplay
 puts players in a fully destructible 3D game world where they can place
 and dig numerous types of blocks, items and creatures using a variety
 of tools. Inside the game world players can build structures, artworks
 and anything else their creativity can think of on multiplayer servers
 and singleplayer worlds across multiple game modes.

DEPENDENCIES:
Voxelands requires the standard C++ library, irrlicht 1.8 or later,
 freetype, openAL, vorbisfile, ogg, and zlib. CMake, make, and g++ (or other
 C++ compiler) are required to build from source.

INSTALL:
If you're reading this then you've already unpacked the tarball, so
 just:
1) cd /path/to/voxelands
2) cmake -DRUN_IN_PLACE=1 .
2) make -j3

WINDOWS:
Voxelands can be cross compiled with mingw, or built natively with MSVC,
 instructions for the latter are available on the forums:
 http://forum.voxelands.com

USE:
Simply run bin/voxelands from any console/terminal.

CONTROLS:
Controls can be set in the Settings tab of the main menu

Main controls:

    W, S, A, D - Walk forward backward, left, and right.
    Mouse - Look / Aim.
    Mouse wheel - Change wielded item.
    1 through 8 - Change wielded item.
    Right Mouse Button - Place item.
    Left Mouse Button - Dig / Punch / Attack.
    Shift - Sneak.
    Space - Jump.
    R - Move Up (ladders, swimming, flying)
    F - Move Down (ladders, swimming, flying)
    E - Run.

Action controls:

    I - Enter inventory.
    Q - Examine pointed block.
    H - Use item in hand.
    T - Talk / commands.
    K - Toggle fly mode.
    F1 - Hide / show hud.
    F2 - Hide / show chat.
    F3 - Disable / enable fog.
    F4 - Disable / enable camera update.
    F5 - Toggle through debug information.
    F6 - Toggle through profiler (info on FPS, chunk updates, etc.)
    F12 - Take a screenshot.


LICENSE:
Code:
Voxelands is licensed under the GPLv3 or later.
Copyright (c) 2013-2015 Lisa 'darkrose' Milne <lisa@ltmnet.com>
Forked from Minetest 0.3.x
Copyright (c) 2010-2011 Perttu Ahola <celeron55@gmail.com>

Textures, Sounds, and Models:

This does not apply to texture packs made by others.

Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
http://creativecommons.org/licenses/by-sa/3.0/

Artists include:
sdzen
darkrose
sapier
Tom Peter
Telaron
juskiddink
With special thanks to http://www.opengameart.org/

DEVELOPMENT:
Voxelands is under active development, the latest updates can be found
 at:
  https://gitlab.com/voxelands/voxelands
 or on IRC at:
  irc.entropynet.net #voxelands

CHANGES:
See doc/changelog.txt