README.md
1Violetland
2==========
3
4Violetland is an open source cross-platform game similar to Crimsonland. In this game the player should help a girl by name of Violet to struggle with hordes of monsters. For this purpose the various weapon, and also the special abilities of the heroine which are opening with experience can be used.
5
6### Features
7
8 * graphic is based on opengl.
9 * dynamic change of day and night.
10 * not disappearing corpses.
11 * character improves with experience.
12 * firearms, hand grenades, teleports, bonuses.
13 * [languages](http://www.getlocalization.com/violetland/): english, [french](http://www.getlocalization.com/violetland/m_translate/8553/), [russian](http://www.getlocalization.com/violetland/m_translate/8551/), [galician](http://www.getlocalization.com/violetland/m_translate/8554/), [spain](http://www.getlocalization.com/violetland/m_translate/8552/).
14 * works on gnu/linux, freebds, windows, mac.
15
16### Community
17
18 * [Git source repository](https://github.com/ooxi/violetland) [](https://travis-ci.org/ooxi/violetland)
19 * [Issue tracker](https://github.com/ooxi/violetland/issues)
20 * [Wiki](https://github.com/ooxi/violetland/wiki)
21 * [IRC](http://webchat.freenode.net/?channels=violetland) irc.freenode.net #violetland
22 * [Google Groups](http://groups.google.com/group/violetland)
23
24SCREENSHOTS
25-----------
26
27[](http://violetland.github.com/images/screenshots/original/violetland-illumination.png)
28[](http://violetland.github.com/images/screenshots/original/violetland-laser.png)
29[](http://violetland.github.com/images/screenshots/original/violetland-death.png)
30[](http://violetland.github.com/images/screenshots/original/violetland-flashlight.png)
31[](http://violetland.github.com/images/screenshots/original/violetland-massacre.jpg)
32
33SYSTEM REQUIREMENTS
34-------------------
35
36Before you enjoy the game make sure that you have a 3D-accelerated video card and latest drivers for your card with 3D-acceleration support.
37
38Currently are supported: windows, gnu/linux, freebsd, mac os x.
39
40WINDOWS
41-------
42
43CAUTION! Now a hot switching of video modes from options screen isn't finalized. When you will apply changes in the options screen, the program will shut down. You must manually restart the program.
44
45The executable was created with help of MSVC++ 2010, thus the Microsoft Visual C++ 2010 Redistributable Package may be needed. You can download it from [Microsoft](http://www.microsoft.com/downloads/en/details.aspx?FamilyID=a7b7a05e-6de6-4d3a-a423-37bf0912db84&displaylang=en).
46
47The program can't be started (because it can't load resources) if the path to the executable contains cyrillic symbols.
48
49There is a workaround for this problem. Run the program by the command shell script called start.cmd from the root program folder.
50
51LINUX
52-----
53
54Check for violetland package in main repositories of your linux distro. If there is nothing, check related wiki page for [third party packages](https://github.com/ooxi/violetland/wiki/Third-Pary-Packages).
55
56An universal way to play violetland on linux is to build the program with help of the cmake build system. You probably can install it from the main repository of your linux distribution.
57Also your system must have the SDL packages (`SDL`, `SDL_image`, `SDL_ttf`, `SDL_mixer`), the same devel packages and gcc.
58
59
60### NOTE FOR UBUNTU USERS
61You should execute command like `sudo apt-get install cmake libsdl-ttf2.0-dev libsdl-mixer1.2-dev libsdl-image1.2-dev libboost-all-dev` to install required packages (tested with Ubuntu 12.04).
62
63Besides, some additional steps are required.
64
65First download and unpack the distribution package or get files from the repository.
66
67Next go to the root distribution directory and make the program using cmake (the default install prefix is `/usr/local`):
68
69 $ git submodule update
70 $ mkdir build
71 $ cd build
72 $ cmake ..
73 $ sudo make install
74
75Then run the program:
76
77 $ violetland
78
79Instead of installing the program to `/usr/local` you can install it in your home folder or everywhere you want. Then probably the root password to access `/usr/local` will be not necessary. To do that you can use next example:
80
81 $ git submodule init; git submodule update
82 $ mkdir build
83 $ cd build
84 $ cmake -DCMAKE_INSTALL_PREFIX=../dist ..
85 $ make install
86 $ cd ../dist/bin/
87 $ ./violetland
88
89In addition you can install the executable and the game data to the separate directory trees:
90
91 $ git submodule init; git submodule update
92 $ mkdir build
93 $ cd build
94 $ cmake -DCMAKE_INSTALL_PREFIX=/usr/local -DDATA_INSTALL_DIR=/usr/share/games/violetland -DLOCALE_INSTALL_DIR=/usr/share/locale ..
95 $ sudo make install
96
97
98### NOTE FOR FEDORA USERS
99
100In order to build Violetland on Fedora 17, you need to install the following packages
101
102 # yum install boost-devel cmake gcc-c++ SDL-devel SDL_image-devel SDL_mixer-devel SDL_ttf-devel
103
104The rest of the build and installation procedure is identical to Ubuntu.
105
106
107OpenBSD
108-------
109
110[OpenBSD](http://www.openbsd.org/) support was tested with OpenBSD 5.2
111
112 # pkg_add boost sdl sdl-image sdl-mixer sdl-ttf
113 $ git clone https://github.com/ooxi/violetland.git; cd violetland
114 $ git submodule init; git submodule update
115 $ mkdir build; cd build
116 $ cmake -DCMAKE_INSTALL_PREFIX=../dist ..
117 $ make install
118
119
120Controls
121--------
122
123 * `w` - Up
124 * `a` - Left
125 * `s` - Down
126 * `d` - Right
127 * `q` - Enter/leave teleport mode
128 * `space` - Grenade
129 * `f` - Toggle Flashlight
130 * `g` - Toggle laser sight
131 * `c` - Abilities menu pause
132 * `esc` - Main menu pause
133 * `right mouse click` - Fire
134 * `left mouse click` - Reload
135
136
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}