Skip to content

Commit f533c1e

Browse files
authored
Update README.md
1 parent 650d25e commit f533c1e

File tree

1 file changed

+61
-22
lines changed

1 file changed

+61
-22
lines changed

README.md

+61-22
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,23 @@ https://github.com/fastrgv/RufasCube/releases/download/v4.2.1/kc18apr20.7z
1414

1515

1616

17+
1718
# RufasCube -- using OpenGLAda Binding and FreeType Fonts (TTF).
1819

1920

2021
## What's new (newest at top of this list):
2122

2223

24+
**ver 4.2.2 -- 06jun20**
25+
26+
* Fixed sound errors during shuffle.
27+
* Added "seven", a similar but smaller, easier cubic puzzle.
28+
29+
2330
**ver 4.2.1 -- 18apr20**
2431

2532
* Assured that OpenGL v3.3 is sufficient to run this app.
26-
* Added m-key mute-toggle of move-sounds.
33+
* Added m-key-toggle to mute move-sounds.
2734

2835

2936
**ver 4.2.0 -- 17jan20**
@@ -40,7 +47,7 @@ https://github.com/fastrgv/RufasCube/releases/download/v4.2.1/kc18apr20.7z
4047

4148

4249
## RufasCube Game Introduction
43-
RufasCube is NOT another Rubic's Cube. It's a much easier slider puzzle that is incrementally solvable. A 3x3x3 arrangement of cubelets with the center one missing allows sliding permutations. After a randomization, the goal is to restore the cube to its original configuration based on color and alphabetic hints.
50+
RufasCube is NOT another Rubic's Cube. It's a much easier slider puzzle that is incrementally solvable. A 3x3x3 arrangement of cubelets with the center one missing allows sliding permutations. After a randomization, the goal is to restore the cube to its original configuration based on color and alphabetic hints. Now contains a smaller 2x2x2 cube called "Seven", that is an easier version.
4451

4552
Dragging the cursor rotates the cube for a better view angle.
4653

@@ -50,6 +57,8 @@ Zooming can be done with a mousewheel, or a 2-finger drag on MacBooks.
5057

5158
As indicated on screen, (h) will toggle a help screen.
5259

60+
Uses FreeType font rendering & TrueType fonts.
61+
5362
Works on Macs running OS-X and PCs running Windows or GNU/Linux.
5463
Note that both 32 and 64 bit builds for Windows are delivered.
5564

@@ -60,38 +69,39 @@ Note that both 32 and 64 bit builds for Windows are delivered.
6069
-------------------------------------------
6170
* graphics card & driver that supports OpenGL version 3.3 or later;
6271
* Windows, GNU/Linux or a Mac running OS-X;
63-
* rufascube_gnu is the executable name on GNU/Linux.
64-
* rufascube_osx is the executable for Mac OS-X.
65-
* binw32\rufascube32.exe is the 32-bit executable for Windows.
66-
* binw64\rufascube64.exe is the 64-bit executable for Windows.
72+
* cube_gnu,seven_gnu are the executable names on GNU/Linux.
73+
* cube_osx,seven_osx are the executables for Mac OS-X.
74+
* binw32\cube32.exe,binw32\seven32.exe are the 32-bit executables for Windows.
75+
* binw64\cube64.exe,binw64\seven64.exe are the 64-bit executables for Windows.
6776

6877

69-
## Setup of rufascube:
78+
## Setup of cube, seven:
7079
-------------------------------------------
7180

7281
Mac users see "osx-setup.txt".
7382
Windows users see "windows-setup.txt".
7483

7584
Unzip the archive. On Windows, 7z [www.7-zip.org] works well for this.
7685

77-
7886
Open a commandline terminal, and cd to the install directory.
7987

8088
Windows users may type either
8189

82-
* binw32\rufascube32.exe, or
83-
* binw64\rufascube64.exe
90+
* binw32\cube32.exe, or
91+
* binw64\cube64.exe
92+
93+
Linux users type "cube_gnu" to start the game. You may also double click the icon for cube_gnu in file manager.
8494

85-
Linux users type "rufascube_gnu" to start the game. You may also double click the icon for rufascube_gnu in file manager.
95+
Mac users note that this game may be initiated in two ways also. First, by opening a terminal, navigating to the install-directory, and typing "cube_osx" on the command line. Second by navigating to the installation directory in Finder and clicking the "cube.app" icon named "RufasCube". Note also that a 2-finger-swipe simulates the mouse wheel on a MacBook.
8696

87-
Mac users note that this game may be initiated in two ways also. First, by opening a terminal, navigating to the install-directory, and typing "rufascube_osx" on the command line. Second by navigating to the installation directory in Finder and clicking the "rufascube.app" icon named "RufasCube". Note also that a 2-finger-swipe simulates the mouse wheel on a MacBook.
97+
Likewise for "seven".
8898

8999
The install-directory should contain a subdirectory named "data". It contains shaders and sound data.
90100

91101

92102

93103

94-
## Running rufascube:
104+
## Running rufascube(3x3x3),seven(2x2x2):
95105
-------------------------------------------
96106

97107
The primary RGB "skin" is based on an RGB color scheme whereby position along X,Y,Z axis determines RGB-color content.
@@ -123,6 +133,30 @@ More options (as indicated by the help screen):
123133

124134
Finally, the keys (up),(dn),(lf),(rt),(f),(b) are functional but they are only helpful/meaningful when the Coordinate Axes are in "standard" orientation, i.e. x is rightward, y is upward, and z is outward.
125135

136+
### hint
137+
You may find it easier to focus your attention on the 2D representation at the side of the screen.
138+
139+
140+
141+
## Running seven(2x2x2), differences:
142+
-------------------------------------------
143+
144+
This simpler, smaller cube has fewer options.
145+
146+
As indicated on screen, (h) will show a help screen. The (c) key will toggle between the RGB and Vadasz mode at any time. Zoom is controlled by the mousewheel, or the zoom keys i/o (In,Out).
147+
148+
More options (as indicated by the help screen):
149+
150+
* 1-key, ... 5-key shuffles the cubelets
151+
* (s)-key or (=)-key solves the cube if done immediately after a shuffle;
152+
* (i)-key or mousewheel zooms-In;
153+
* (o)-key or mousewheel zooms-Out;
154+
* (m)-key => mute-toggle of sliding sounds;
155+
156+
157+
158+
159+
126160
---------------------------------------------------------------------------
127161
Open source Ada developers are welcome to help improve or extend this game.
128162

@@ -154,27 +188,29 @@ The linux-build is among very few modern OpenGL games where a single pre-built e
154188
which references a minimalistic C++ utility snd4ada.
155189

156190

157-
## Build instructions for RufasCube:
191+
## Build instructions for RufasCube or Seven:
158192

159-
Four [pre-compiled] binary executables are provided, one for gnu/linux, one for OS-X, and two for Windows. The linux binary, rufascube_gnu, is intended to run in the presence of the directory "libs", which contains some dynamically loaded libraries that can be, but need not be present on a target system:
193+
In the following, the "appName" can be either "cube" or "seven".
194+
195+
Four [pre-compiled] binary executables are provided, one for gnu/linux, one for OS-X, and two for Windows. The linux binary, cube_gnu, is intended to run in the presence of the directory "libs", which contains some dynamically loaded libraries that can be, but need not be present on a target system:
160196
GLFWv3, SFML, FLAC, ogg, vorbis, & openal.
161197

162198
Normally, the following build scripts are used; and due to a recent script change, a Windows or linux build machine need not have a C++ compiler installed. Only GNAT is required.
163199

164200
-------------------------------------------------------
165-
Windows32 => wcmp32.bat
201+
Windows32 => wcmp32.bat appName
166202

167-
Windows64 => wcmp64.bat
203+
Windows64 => wcmp64.bat appName
168204

169205
-------------------------------------------------------
170-
MacOSX => ocmpss.sh:
206+
MacOSX => ocmpss.sh appName
171207

172-
build script for generating a portable executable that will run on most OS-X platforms whether or not they have non-standard libraries GLFWv3 or SFML installed. I used this to build the executable that I deliver, named rufascube_osx. Macs with a recent but standard configuration of OS-X should be able to rebuild using this script.
208+
build script for generating a portable executable that will run on most OS-X platforms whether or not they have non-standard libraries GLFWv3 or SFML installed. I used this to build the executable that I deliver, named cube_osx. Macs with a recent but standard configuration of OS-X should be able to rebuild using this script.
173209

174210
------------------------------------------------------
175-
GNU/Linux => lcmpd.sh:
211+
GNU/Linux => lcmpd.sh appName
176212

177-
utilizes the uncommon relocatable libraries (mainly GLFW, SFML) that are delivered in this bundle under ./libs/. This is used to build the dynamically-linked [gnu/linux] executable, which should run in the presence of ./libs, whether or not your system has those libraries installed. This was used to create the executable named rufascube_gnu. If it doesn't run on your linux distro, you will have to try to build the executable yourself. In that case, it is hoped that this script (lcmpss.sh) will work for you. The intent was to provide all the needed interface/include files under ./libs/.
213+
utilizes the uncommon relocatable libraries (mainly GLFW, SFML) that are delivered in this bundle under ./libs/. This is used to build the dynamically-linked [gnu/linux] executable, which should run in the presence of ./libs, whether or not your system has those libraries installed. This was used to create the executable named cube_gnu. If it doesn't run on your linux distro, you will have to try to build the executable yourself. In that case, it is hoped that this script (lcmpss.sh) will work for you. The intent was to provide all the needed interface/include files under ./libs/.
178214

179215

180216

@@ -210,7 +246,7 @@ RufasCube itself is covered by the GNU GPL v3 as indicated in the sources:
210246
You may read the full text of the GNU General Public License
211247
at <http://www.gnu.org/licenses/>.
212248

213-
## Media Files for RufasCube:
249+
## Media Files for RufasCube,Seven:
214250

215251

216252
### General Note
@@ -229,6 +265,9 @@ Thanks to Dmitry Kazakov, Felix Krause, and Stephen Sanguine.
229265
## Acknowledgement:
230266
In february of 2015 I discovered that RufasCube could be considered a software implementation of a Hungarian "Vadasz" 3x3x3 cube, or another similar puzzle called an iQube, whose goals are an all green or all red outer color. Peter's Black Hole and Magic Jack are still other incarnations.
231267

268+
I discovered on 10feb2015 that Seven seems to be a software implementation of a Hungarian "Vadasz" 2x2x2 cube.
269+
270+
232271
For further iqube analysis see:
233272
http://www.jaapsch.net/puzzles/blackhole.htm
234273

0 commit comments

Comments
 (0)