README.txt 3.49 KB
Newer Older
TicklishHoneyBee's avatar
TicklishHoneyBee committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
========================================================================
				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,
16
17
 freetype, openAL, vorbisfile, ogg, zlib. CMake, make, and g++ (or other
 C++ compiler) and bzip2 and jpeg are required to build from source.
TicklishHoneyBee's avatar
TicklishHoneyBee committed
18
19
20
21
22
23

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 .
24
25
26
27
28
29
30
31
3) make -j3

Other optional cmake parameters:
1) -DBUILD_SERVER=0 (default 1) builds the dedicated server
2) -DBUILD_CLIENT=0 (default 1) builds the rich client
3) -DENABLE_AUDIO=0 (default 1) enables audio support

The option -DRUN_IN_PLACE expects the user to run voxelands from the extracted source directory.
TicklishHoneyBee's avatar
TicklishHoneyBee committed
32
33
34
35
36
37
38
39
40
41
42

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
43
44
45

Main controls:

sdzen's avatar
sdzen committed
46
    W, S, A, D - Walk forward backward, left, and right.
47
48
49
50
51
52
    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.
sdzen's avatar
sdzen committed
53
54
55
    Space - Jump.
    R - Move Up (ladders, swimming, flying)
    F - Move Down (ladders, swimming, flying)
56
57
58
59
    E - Run.

Action controls:

sdzen's avatar
sdzen committed
60
61
62
    I - Enter inventory.
    Q - Examine pointed block.
    H - Use item in hand.
63
=======
64
    T - Talk / commands.
sdzen's avatar
sdzen committed
65
    K - Toggle fly mode.
66
67
68
69
70
71
72
73
    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.

TicklishHoneyBee's avatar
TicklishHoneyBee committed
74
75
76
77

LICENSE:
Code:
Voxelands is licensed under the GPLv3 or later.
TicklishHoneyBee's avatar
1512.00    
TicklishHoneyBee committed
78
Copyright (c) 2013-2016 Lisa 'darkrose' Milne <lisa@ltmnet.com>
TicklishHoneyBee's avatar
1407.00    
TicklishHoneyBee committed
79
Forked from Minetest 0.3.x
80
81
Copyright (c) 2010-2011 Perttu Ahola <celeron55@gmail.com>

TicklishHoneyBee's avatar
TicklishHoneyBee committed
82
Textures, Sounds, and Models:
83
84
85

This does not apply to texture packs made by others.

TicklishHoneyBee's avatar
TicklishHoneyBee committed
86
Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
87
88
http://creativecommons.org/licenses/by-sa/3.0/

TicklishHoneyBee's avatar
1512.00    
TicklishHoneyBee committed
89
90
91
92
93
94
95
To satisfy the attribution clause, any project using Voxelands' assets
 must provide a prominent notice as part of each of said project's
 credits notices (such as in documentation, on a website, and/or any
 other credits screen associated with the project) showing both the
 CC-BY-SA licensing, the ownership by Voxelands of the asset, and a link
 to the Voxelands' project at http://www.voxelands.com/.

TicklishHoneyBee's avatar
TicklishHoneyBee committed
96
97
98
99
Artists include:
sdzen
darkrose
sapier
TicklishHoneyBee's avatar
TicklishHoneyBee committed
100
101
Tom Peter
Telaron
TicklishHoneyBee's avatar
TicklishHoneyBee committed
102
juskiddink
TicklishHoneyBee's avatar
TicklishHoneyBee committed
103
104
105
106
107
108
109
110
111
112
113
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