Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/igor-marinescu/rubikquat
Rubik 3D-Simulator in Python using Pygame and Quaternions
https://github.com/igor-marinescu/rubikquat
3d game pygame python quaternion rubik simulator
Last synced: 4 days ago
JSON representation
Rubik 3D-Simulator in Python using Pygame and Quaternions
- Host: GitHub
- URL: https://github.com/igor-marinescu/rubikquat
- Owner: igor-marinescu
- License: gpl-3.0
- Created: 2020-12-11T09:55:31.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-11T11:17:26.000Z (about 4 years ago)
- Last Synced: 2024-11-23T15:36:13.032Z (2 months ago)
- Topics: 3d, game, pygame, python, quaternion, rubik, simulator
- Language: Python
- Homepage:
- Size: 19.6 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RubikQuat
RubikQuat is a 3D Rubik Simulator program, written entirelly in Python by means of [Pygame] modules.
A simple 3D-Engine is implemented using only the basic 2D-graphics.
The orientation in space and rotation is calculated using Quaternions.
The purpose for which RubikQuat was created:
- Learn Python and experiment with Pygame
- Study Rubik's mechanics
- Research Quaternions
- Implement simple 3D-Engine
# Run
Using python:
```sh
$ python -m rubikquat_src
```
Under Windows:
There is a build for Windows (using py2exe) which allows to run the application even without Python.
Unpack the content of the build_zip folder and execute .\build\rubikquat.exe.
# Help
Help screen is displayed when RubikQuat application starts. It can also be invoked each time by pressing the F1 Key or clicking the '?'-button (top-left). Press Esc or mouse left-click to close the help and return to Rubik screen.
# Controls
| Key | Function | Key | Function |
| --- | -------- | --- | -------- |
| L | Flip Left-Face clockwise | Left | Rotate Rubik along Y-axis |
| Shift+L | Flip Left-Face counterclockwise | Right | Rotate Rubik along Y-axis |
| R | Flip Right-Face clockwise | Up | Rotate Rubik along X-axis |
| Shift+R | Flip Right-Face counterclockwise | Down | Rotate Rubik along X-axis |
| F | Flip Front-Face clockwise | Pg-Up | Rotate Rubik along Z-axis |
| Shift+F | Flip Front-Face counterclockwise | Pg-Down | Rotate Rubik along Z-axis |
| U | Flip Top-Face clockwise | Ctrl+Z | Undo the last move |
| Shift+U | Flip Top-Face counterclockwise | Ctrl+Y | Redo a move |
| F1 | Show Help | S | Scramble the Rubik |
You can also do all the above actions by clicking with mouse on corresponding button.
Rotate the Rubik using mouse - just drag the Rubik in the direction you want to rotate it.
The mouse-wheel rotates the Rubik along Z-axis.
# Development
Clean the build:
```sh
> make clean
```
Build the .\build\rubikquat.exe using py2exe:
```sh
> make setup
```
Virtual environment:
```sh
> virtualenv venv
> venv\Scripts\activate
> pip install -r requirements.txt
```
# License
GNU GPL3. See the [LICENSE.md](LICENSE.md) file for details.
# Author
Igor Marinescu
[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen.)
[Pygame]: