RufasSeven file

# Seven

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

**ver 2.5.2 -- 20apr20**

* Shaders corrected so that OpenGL v3.3 is now sufficient to run this app., thus supporting older graphics hardware.
* Added m-key to toggle move-sound.

**ver 2.5.1 -- 18jan20**

* Much improved Linux portability.

**ver 2.5.0 -- 31dec19**

* converted from SDL2 to GLFW;
* Improved font anti-aliasing thru corrected OpenGL code parameters.
* Improved stex code; reduced aliasing; 3D lettering now zooms too;
* Update png libs;
* Revised key maps;
* Updated documentation;

**ver 2.4.8 -- 26nov19**

* Repaired a library problem with GNU/Linux build that limited portability.
* No problems with Mac/OSX or M.S. Windows builds.

**ver 2.4.7 -- 25jun19**

* Updated SDL2 to version 2.0.9
* Updated Ada binding to SDL2;
* Improved stex (text-display) code;
* Improved code layout;
* Improved contrast on help screen;

**ver 2.4.6 -- 6jan19**

* Now deliver 7z archives;
* Now using SDL v2.0.8;
* Added closeWindow event handler;

**ver 2.4.5 -- 12dec18**

* Now using sdl v207 uniformly on all platforms;
* Added zoom keys n/f/z = Nearer/Further/defaultZoom.

**ver 2.4.4 -- 03aug18**

* Upgraded all 3 platforms to SFML v2.5.0;
* Fixed bad text setting that caused pixellated font;

**ver 2.4.3 -- 28jul18**

* Changed freetype library to assure linux portability.
* Removed unneeded code;
* Revised compile scripts;

**ver 2.4.2 -- 05jul18**

* Simplified OSX build using static non-standard libs;
* Added an alternative GPR build system;
* Put Windows DLLs, EXEs into ./binw32/
* Updated to SDL v207;

Ver 2.4.1 -- 03mar18: Replaced homemade font with Freetype Fonts, yet still using modern OpenGL methods and a thin Ada binding to SDL.

**ver 2.3.6 -- 11apr17**
* added Windows executable & build script
* Improved error checking in shader package;
* Removed OpenGL-deprecated functions that could cause aborts;
* Revised directory structure, simplified codes;
* Corrected the winner test to disallow invalid solutions in RGB mode.


### See end of file for complete revision history



## what is special about this project?
Uses the Ada programming language and fully modern OpenGL methods with textures, shaders and uniforms. Achieves version 3.3 core profile contexts, and compiles and runs on both GNU/Linux and Mac OS-X systems. This project serves as a testbed for learning the complexities of modern OpenGL and GLSL.

Focusing on portability and freedom, no coding effort or compromise has been made to accomodate proprietary operating systems. It relies on a thin SDL2 binding from Dan Vazquez, a thin OpenGL binding from "Lumen", a PNG reader by Stephen Sanguine, and SFML-Audio (because of its elegant audio interface).

The Ada bindings used are thin, so the relationship to C++ methodology is quite transparent. Developers should note that these Ada bindings are usable as a standalone library for most any OpenGL project that uses Ada.

## Seven Game Introduction
Seven is NOT another Rubic's Cube. It's a whole new kind of puzzle. A 2x2x2 arrangement of cubelets with one missing allows sliding permutations. After a randomization, the goal is to restore the cube to its original configuration based on color and numeric hints.

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

Clicking the cursor on a cubelet adjacent to the empty space will slide it into that empty space. On laptops you may also hit (return) when the cursor is on the cubelet of choice to select and slide it. On MacBooks, a 2-finger tap on the touchpad does the job.

As indicated on screen, (h) will toggle a help screen, and (c) will toggle color schemes.

Works on Windows, Macs running OS-X and PCs running GNU/Linux.




-------------------------------------------
## required for running:
* graphics card & driver that supports OpenGL version 3.3 or later;
* Windows, GNU/Linux or a Mac running OS-X;
* seven_gnu is the executable name on GNU/Linux.
* seven_osx is the executable for Mac OS-X.


-------------------------------------------
## Using the build scripts
* systems: Windows, OS-X or GNU/Linux
* Xcode g++ compiler, if using OS-X
* a recent gnat compiler
* the included "libs" directory contains Ada interfaces as well as all needed libraries. Dynamic in the case of GNU/Linux, and static in the case of OS-X.
* lcmp.sh for GNU/Linux should be editted to export the correct path to the "gnatmake" executable.
* ocmpss.sh for OS-X assumes "gnatmake" is visible.

* wcmp.bat for Windows.

* Note that the Ada interface to SFML-AUDIO (snd4ada_hpp.ads) was created with the command: "g++ -c -fdump-ada-spec -C snd4ada.hpp" which references a minimalistic C++ utility snd4ada.


-------------------------------------------
## Setup & Running Seven:

Unzip the archive...windows users can use 7-zip thusly:

1) 7z se*.tar.gz

2) 7z se*.tar

You will see a new directory appear. CD to it.

Linux users should type "seven_gnu" to start the game. You may also double click the icon for seven_gnu in file manager.

Windows users type "binw32\seven.exe" to begin.

Mac users note that this game may be initiated in two ways also. First, by opening a terminal, navigating to the seven_install_directory, and typing "seven_osx" on the command line. Second by navigating to the installation directory in Finder and clicking the "seven.app" icon named "Seven". Note also that a 2-finger-swipe simulates the mouse wheel on a MacBook.

The seven_install_directory should contain a subdirectory named "data". It contains shaders and sound data.

An optional command line parameter "v" initiates a different coloring scheme to look like a Vadasz/RufasCube. The goal here is to make each face show a solid color, after randomization. The numerical cues still work to assist with a solution. All "inner" colors are black so this is still fairly easy for kids.


As indicated on screen, (h) will show a help screen. The (c) key will toggle between the RGB and Vadasz mode at any time. The mousewheel controls zoom.


------------------------------------------
Open source Ada developers are welcome to help improve or extend this game.

Developer or not, send comments, suggestions or questions to:

<fastrgv@gmail.com>



------------------------------------------
## Detailed Build instructions for Seven:

Three [pre-compiled] binary executables are provided, one for Windows, one for gnu/linux and one for OS-X. The linux binary, seven_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:
SDL2, SFML, FLAC, ogg, vorbis, & openal.

The build scripts are described below; and due to a recent script change, a linux build machine need not have a C++ compiler installed. Only GNAT is required.

-------------------------------------------------------

Windows => wcmp.bat

----------------------------------------------------------
MacOSX => ocmpss.sh:

build script for generating a portable executable that will run on most OS-X platforms whether or not they have non-standard libraries SDL2 or SFML installed. These nonstandard libraries are statically linked into the executable. I used this to build the executable that I deliver, named seven_osx. Macs with a recent but standard configuration of OS-X should be able to rebuild using this script.

------------------------------------------------------
GNU/Linux => lcmp.sh (or lcmpss.sh)

utilizes the uncommon relocatable libraries (mainly SDL2, 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 seven_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 (lcmp.sh) will work for you. The intent was to provide all the needed interface/include files under ./libs/.

If the delivered linux binary does not run...

* Manually install GNAT GPL from libre.adacore.com/download/.
* Rerun the compile script lcmp.sh.


### Link Problems during linux build:

On a linux build machine, you might have minor link errors, depending on its configuration. If you are missing "libz", you can simply copy "libz.so" from /usr/gnat/lib/gps/ into /usr/local/lib/. If "libGL" cannot be found, this literally means "libGL.so" was absent. But you might have "libGL.so.1" present. In this case, simply create a softlink by changing to the libGL directory, then type the line:

sudo ln -s libGL.so.1 libGL.so (and enter the admin password)

whence the linker should now be able to find what it wants. But if there is more than one file libGL.so present on your system, make sure you use the best one; i.e. the one that uses your accelerated-graphic-driver.



------------------------------------------------------
## legal mumbo jumbo:

Seven itself is covered by the GNU GPL v3 as indicated in the sources:

Copyright (C) 2015 <fastrgv@gmail.com>

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 may read the full text of the GNU General Public License
at <http://www.gnu.org/licenses/>.

## Media Files for Seven:


### General Note
The particular choice of sound files delivered are not essential to the function of the game and are easily replaced. This software is primarily intended as a tutorial example of modern OpenGL methods. The only requirements are that sounds be in WAV format.

### SoundFiles
Sounds are from freesound.org and is covered by the Creative Commons Attribution noncommercial license documented in the accompanying file creativeCommons.txt.

### ImageFiles (*.png)
For text-textures were created using gimp and are also covered by the GNU GPL v3 license.



## Acknowledgement:
I discovered on 10feb2015 that this seems to be a software implementation of a Hungarian "Vadasz" 2x2x2 cube.

----------------------------------------------
## Best Download Site for all my games:
Github.com


## Revision History
**ver 2.3.5 -- 5jan17**

* Updated to use new SFML libs.
* Corrected a duplicate window glitch.
* Refined compiler scripts.


**ver 2.3.4 -- 31dec16**

* Now using generalized SFML-audio interface code: snd4ada.cpp.
* Improved build system to be compatible with more linux distros.
* Improved OpenGL coding to also support Intel embedded graphics hardware.

**ver 2.3.3 -- 03jul16**

* Improved sounds, snd4ada.cpp codes.
* Updated to use ada-intrinsic pseudo-random numbers, including a time dependent randomization so each run is different.


**ver 2.3.2 -- 12apr16**

* Important library update for Gnu/Linux users on 27% of distros that do not provide FLAC, ogg, vorbis libraries. Missing softlinks caused run failure. That is now fixed.


**ver 2.3.1 -- 20feb16**

* Added Mac binary bundle that acts like a typical Mac App. This app is delivered in the installation directory, but could be moved elsewhere, such as your personal Applications directory [and initiated with a click]. Note that there are some soft [symbolic] links in the bundle that are resolved automatically when copied with the command "cp -r seven.app destination-directory".
* Generalized utex package.


**ver 2.3 -- 13jan16**

* Added mousewheel zoom control;
* Added flat number diagram in upper right window;


**ver 2.2 -- 30nov15**

* Improved PNG loader procedure automatically handles either RGBA or RGB image files for textures.
* Window title changes whenever (c)-key is pressed.

**ver 2.1 -- 18nov15**

* added single command line option "v" to change skin from the default RGB colors to a Vadasz Cube coloring. Alternatively, the (c)-key can be used to toggle skin color.
* improved winner test to allow orientation changes when not in Vadasz mode.
* better handling of key-delay for nicer response.

**ver 2.0 -- 20oct15**

* Initial version of a completely revised Ada version of its C++ predecessor.