
About Pybik 3.0
===============

Pybik is a 3D puzzle game about the cube invented by Ernő Rubik.

 * Various 3D puzzles, such as cubes, towers, prisms, tetrahedra, octahedra,
 dodecahedra and many more
 * Solvers for some puzzles
 * Pretty patterns
 * Editor for move sequences
 * Custom colors and images on the surface of the puzzles

Author: B. Clausius <barcc@gmx.de>
License: GPL-3.0+
Project page: <https://launchpad.net/pybik/>


Installation
============

If Pybik is available for your distribution, you should install Pybik with a
package manager. Otherwise see the file INSTALL for installation instructions.


Feedback
========

If you find any bugs in Pybik or have a suggestion for an improvement then
please submit a bug report [1].

[1] <https://bugs.launchpad.net/pybik/+filebug>


Translation
===========

Translations are managed by the Launchpad translation group [2].  If you want
help to translate Pybik to your language you can do it through the web
interface [3].  Read more about "Translating with Launchpad" [4] and "Starting
to translate" [5].

[2] <https://translations.launchpad.net/+groups/launchpad-translators>
[3] <https://translations.launchpad.net/pybik>
[4] <https://help.launchpad.net/Translations>
[5] <https://help.launchpad.net/Translations/StartingToTranslate>


License
=======

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
details.

You should have received a copy of the GNU General Public License along with
this program.  If not, see <http://www.gnu.org/licenses/>.


Hidden Features
===============

You can change shortcuts for some menu items and actions:

Action         | Menuitem                   | Default
-----------------------------------------------------
selectmodel    | Game->Select Model         | Ctrl+M
initial_state  | Edit->Set as Initial State | None
reset_rotation | Edit->Reset Rotation       | Ctrl+R
preferences    | Edit->Preferences          | Ctrl+P
edit_moves     | None (Select moves editor) | Ctrl+L
edit_cube      | None (Cube editor)         | None

Append the following lines with the shortcuts changed as you like to your
Pybik config file (~/.config/pybik/settings.conf):

action.selectmodel = 'Ctrl+M'
action.initial_state = ''
action.reset_rotation = 'Ctrl+R'
action.preferences = 'Ctrl+P'
action.edit_moves = 'Ctrl+L'
action.edit_cube = ''

The cube editor is a immature feature. To use it anyway, you must assign a
shortcut to the action edit_cube. In cube editor mode swap cubies with left
mouse button and rotate cubies with Ctrl and left mouse button.

