1505.01
[voxelands/voxelands-menche.git] / README.txt
blobd41766452503654f2169f18db75f5a81eddeafa6
1 ========================================================================
2                                 README
3 ========================================================================
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.
14 DEPENDENCIES:
15 Voxelands requires the standard C++ library, irrlicht 1.8 or later,
16  freetype, openAL, vorbisfile, ogg, and zlib. CMake, make, and g++ (or other
17  C++ compiler) are required to build from source.
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 2) make -j3
26 WINDOWS:
27 Voxelands can be cross compiled with mingw, or built natively with MSVC,
28  instructions for the latter are available on the forums:
29  http://forum.voxelands.com
31 USE:
32 Simply run bin/voxelands from any console/terminal.
34 CONTROLS:
35 Controls can be set in the Settings tab of the main menu
36  W: walk forward
37  A: walk left
38  S: walk backwards
39  D: walk right
40  Space: jump, move up
41  E: run, move down
42  Mouse left: dig/hit
43  Mouse right: place/use
44  Mouse wheel: select wielded item
45  Shift: sneak
46  R: Toggle viewing all loaded chunks
47  I: Inventory menu
48  ESC: Pause Menu / Exit game
49  T: Chat
51 LICENSE:
52 Code:
53 Voxelands is licensed under the GPLv3 or later.
54 Copyright (c) 2013-2015 Lisa 'darkrose' Milne <lisa@ltmnet.com>
55 Forked from Minetest 0.3.x
56 Copyright (c) 2010-2011 Perttu Ahola <celeron55@gmail.com>
58 Textures, Sounds, and Models:
60 This does not apply to texture packs made by others.
62 Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
63 http://creativecommons.org/licenses/by-sa/3.0/
65 Artists include:
66 sdzen
67 darkrose
68 sapier
69 Tom Peter
70 Telaron
71 juskiddink
72 With special thanks to http://www.opengameart.org/
74 DEVELOPMENT:
75 Voxelands is under active development, the latest updates can be found
76  at:
77   https://gitlab.com/voxelands/voxelands
78  or on IRC at:
79   irc.entropynet.net #voxelands
81 CHANGES:
82 See doc/changelog.txt