Manual

Welcome to the Opeke manual.

Here you can find information about installing and using Opeke.

Installation

The guide to getting Opeke to run on your computer

System Requirements

Hardware
Due to its nature, Opeke requires a 3D-rendering capable system. This can be done by software rendering, but for normal performance it's better to use a graphics card and a driver with 3D support.
Otherwise, the program itself doesn't require much resources. It should run on any computer capable of running

Operating System
Because of its KDE dependency, Opeke will only run on platforms supported by KDE. This used to mean Linux or BSD, but thanks to projects like mac.kde.org and windown.kde.org, KDE now runs on every mainstream OS. However, note that both these projects are currently in unstable state. The preferable OS to use Opeke is still GNU/Linux.

Software Requirement
Opeke depends KDE4 for GUI and OGRE for 3D display. On most Linux distributions, thier libraries should be installable from that distribution's repositories. Alternatively, you can downlad them from their respective home pages.

Debian binary package

Users of Debian and Debian-based distros can dowload i386 and amd64 .deb packages from http://opeke.noughmad.org.

Graphical tools exist that automatically install a package and all its dependencies.

If you prefer to use a command-line tool, after downloading the file execute this as root in the directory where you dowloaded the installer:
dpkg -i opeke_0.3.1-1_i386.deb
Replace i386 with amd64 if you have a 64-bit system.

RPM binary package

Mandriva users can install Opeke 0.3.1 direcly from the repository.

Others can download a .rpm package from here.

Compiling from source

If you wish to compile from source, download the source from kde-apps.org.

To compile it, you need OpenGL development files, as well as KDE4 ones. You will also need cmake, qmake and make tools. For versions from 0.4 onwards, OGRE development files (headers) are also required.

After you unpack the .tar.gz file, move to the source directory and type:

$ mkdir build
$ cd build
$ cmake ..
$ make
$ sudo make install

If you wish to install Opeke to a custom directory (for example /usr/lib/kde4), run

$ cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/custom/directory
instead of just
$ cmake ..

Using Opeke

The guide to Opeke's functionality

Creating Bricks

By default, Opeke starts in build mode. This means that when your mouse cursor is over the 3D view, a bricks is following it. When you click the left mouse button, the bricks stays in place (becomes built) and a new moving one appears.

Customize bricks

Before you build a brick, you can change its type (shape), size, color and orientation.

Brick type can be selected from the toolbar by clicking on a Build Block, Build Roof, or any other Build X buttons. The same actions can be found in the Actions menu.

Other settings (size, color and orientation) can be changed from Tool Options widget. If the widget isn't visible, enable it by left-clicking on the toolbar and selecting Tool Options.

Editing existing bricks

After a brick has been built, it can only be resized, recolored or moved. Resizing and coloring is done from the Tool Options widget, the same way as on a new brick.

To move a brick, select it by clicking on it, then move the mouse while holding the left mouse button.

Camera and view

The whole scene can be moved by moving the mouse while holding the right mouse button.

For rotations and other movement, use the arrow keys. The 3D scene can be rotated in several ways. To explore all of them, hold Ctrl or Shift while pressing the arrow keys.