CoTerminalApps file

# CoTerminalApps

**ver 2.4.0 -- 23dec21**

* Updated gnatcoll libraries on OSX & w32; removed unused libgpr.a.
* All "assets", including datafiles & soundfiles, now have licenses compatible with the GPLv3 license.

**ver 2.3.9 -- 05nov21**

* Added example script to build using Gnu/Gnat.
* Refined libraries and build scripts.
* Replaced libgnatcoll.a with one from GitHub.

**ver 2.3.8 -- 21oct21**
* Besides Win64, I now provide a Win32 build, to support older platforms.

**ver 2.3.7 -- 18oct21**
* Elliminated anomalous clutter in nexus selection app;
* Arcade-games now pause to show stats before exitting.

**ver 2.3.6 -- 07oct21**
* SpaceInvaders:
* New red aliens shape.

**ver 2.3.5 -- 06oct21**
* SpaceInvaders:
* New UFO shape; new alien shapes; aliens harder to hit.

===============================================================
## Introduction

CoTerminalApps is a collection of non-graphical, colored-ascii-character puzzles & games that run in a commandline terminal on msWindows, OS-X and Gnu/Linux. Now with sound but still extremely portable.

Has runtime-priority control of console terminal, if needed.

Rebuildable using the free GNAT GPL Ada compiler.

Includes rpn(calculator), cinv(spaceInvaders), cpac(Pacman), cfrog(Frogger) and 10 puzzle games that use ascii characters only: crush(rush-hour), cslid(klotski), c7(flat7), caz(flatAZ), csok(sokoban), chio(hole-in-one), chio4(hole-in-one+4), c9(nine), cdd(dirty-dozen), cpan(panama);

See a visual of the 10 puzzles in the image "./puzzles.png".

Keyboard setup is important. You should have a short key-delay and fast repeat rate setting.

Usable keys for all:

* arrow-keys or WASD or IJKL for movement;
* (q)=quit
* (?)=help toggle

All puzzles & games can now be launched from the selector app thusly:

On Win64 type "winterm.bat"

On Win32 type "w32term.bat"

On Mac/OSX type "macterm.sh"

On Linux type "gnuterm.sh"

Then use the keyboard arrow keys to highlight the desired game, and hit (enter)-key.

Windows users note: I suggest that you DO NOT try using the linux executables under WSL. Simply use the windows version [winterm.bat] because special measures (priority-controls) are necessary on Windows to achieve arcade-level response.

===========================================================================

### CoTerminal-Space-Invaders (cinv.adb)
This is my translation of nInvaders.c into Ada that has SOUND !!!
[thanks to dettus@matrixx-bielefeld.de, copied from Ninvaders.sourceforge.net
You need only the (space)-key to fire your laser gun and the left/right arrow keys
to move out of the way of the alien missiles. Needs an 80-chars x 30-lines window.
There are no command-line options, but difficulty increases with level.

Note this app is under active development & improvement. So be sure to check back for the latest update. Actually, it is an "early" release in a primitive state, yet it is playable and fun.

### CoTerminal-Rush (crush.adb)
Colored, non-graphical Traffic-Rush puzzle game designed to run in a terminal window.

Horizontal and vertical strings of letters represent cars and trucks in a crowded parking garage. The objective is to move them around lengthwise in order to be able to get red car "a" to the exit, which is either at the right or top of the garage. Note that the last digits in each puzzle name represents the minimum number of moves to win.

A stand alone autosolver, bfsr, is provided, but now, an autosolver is embedded into this game. At any time you may press the (=)-key to begin stepping toward a solution.

### CoTerminal-BlockSlide (cslid.adb), CoTerminal-DirtyDozen (cdd.adb)
Colored, non-graphical Block Slider puzzle games designed to run in a terminal window.

Colored blocks of letters can be moved horizontally or vertically wherever there is space. The objective is to move the red block to a specified goal position.

A stand alone autosolver, bfsl, is provided, but now, an autosolver is embedded into these games. At any time you may press the (=)-key to begin stepping toward a solution.

### Gameplay: crush, cslid

"?" toggles the help screen. The "+" and "-" keys (next, previous) are used to cycle through the large number of predefined puzzles. You can reset a puzzle by typing "r". You can autosolve by typing "=".

First, one selects a vehicle or block by typing its identifier letter. Then use the arrow keys to move it. Note that manual selection is not always necessary, as there is an auto-select mechanism for those times when only one selection may move in a given direction.

===============================================================
### Seven, A2Z (c7.adb, caz.adb)

c7 is a flat representation of a 3D 2x2x2 cube with one cubelet missing that allows sliding permutations. Here, the elements are labelled 1..7.

caz is a flat representation of a 3x3x3 cube with one cubelet missing that allows sliding permutations. The elements are labelled with the english alphabet.

Both the "caz" and "c7" puzzles work the same:

* note the original order, and blank location;
* mix;
* then restore.

A character in an adjacent row, column, or layer may be moved to the empty space using the keyboard.

Pressing the (home) key on a typical keyboard produces the character 'H'. So assuming that (home)=>'H', (end)=>'F', (up)=>'A', etc...
the key mapping follows:

* (1)..(5): mix; higher values are more difficult.

* (up),(i),(w): north
* (dn),(k),(s): south
* (rt),(l),(d): east
* (lt),(j),(a): west
* (home),(\),(u),(.),(-): layer-up
* (end),(/),(o),(+): layer-dn

* (?): help
* (q): quit

===============================================================

### CoTerminal-sokoban (csok.adb)
Move the pusher >< with the arrow keys in order to push all the boxes [] onto the goals :: in which case they look like {}. Various other functions available on the help screen. Includes a very large family of puzzle files.

Two [external] sokoban solvers named iplr3r & ibox3r have been added. The command line is "solver-name puzzle-file-name max-levels level-number". Note that the max-levels are embedded into each puzzle file name.

The output file (named similarly to the input file) contains directions from the set {u,d,l,r,U,D,L,R}, where upper case indicates a push. It is size-limited to 17 or fewer boxes, and 128 or fewer interior puzzle positions. Compile it with the command "cmp.sh iplr3r" or "cmp.sh ibox3r".

There are many cases these solvers cannot handle, but they are pretty good at sovling smaller puzzles, particularly the more dense ones.

Two time-limited solvers are embedded into csok. At any time you may press the (=)-key to see if the solver #1 can help you. If so, you will be prompted to keep pressing that same key to proceed toward a solution. No prompt means either the present state is unsolvable, or merely that the embedded algorithm failed. Similarly, the (.)-key initiates solver #2.

Finally, an optional single command-line argument (decimal float) specifies a timeout interval to wait for the internal autosolver before giving up. The default is 10.0 seconds.

### CoTerminal-HoleInOne (chio.adb, chio4.adb)
Move the red 2x2 'a' block into the center of the four L-shaped corner pieces.

### CoTerminal-Nine (c9.adb)
Reverse the order of the numbered blocks.

### RPN (reverse polish notation) command line calculator
A cult classic. Recalls the HP rpn functionality. This version uses differentials to calculate an error estimate.

### Pacman (cpac)
Pacman, is a kid friendly ascii character version of Pacman that plays in a commandline terminal. Pure minimalism with classic sounds and 9 predefined levels.

Now with runtime-priority control to prevent terminal freezes, plus commandline control of gamespeed & ghostspeed.

Runs on Windows, OSX & Linux.

Keyboard setup is important. You should have a short key-delay and fast repeat setting.

The arrow keys, or wasd-keys, or ijkl-keys control movement. The (x),(q) keys quit; (p) pauses game.

Includes executables and source code. Note that this game does NOT require an ncurses library in your environment.

cpac can be given 2 optional command line parameters:
*) game speed 0..9; 0=slow, 5=default=medium, 9=fast;
*) ghost speed 0..9; 0=stopped, 2=default=easy, 9=fast;

Before running cpac, it is recommended to resize your terminal to 60 chars. wide by 40 lines tall; then, perhaps, enlarge the font.

### Frogger (cfrog)
Terminal frogger is a kid friendly ascii character version of Frogger that plays in a commandline terminal. Pure minimalism with classic sounds and three levels.

@@@@ is a raft of lillypads,
QQQQ is a team of turtles,
==== is a log,
TTT is a truck,
ccc is a car.

Runs on Windows, OSX & Linux.

Keyboard setup is important. You should have a short key-delay and fast repeat setting.

The arrow keys, or wasd-keys, or ijkl-keys control movement. The (x),(q) keys quit.

Before running cfrog, it is recommended to resize your terminal to 56 chars. wide by 21 lines tall; then, perhaps, enlarge the font.

===============================================================
## Setup & Running:

Mac users see "osx-setup.txt".
Windows users see "windows-setup.txt".

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

Ensure your keyboard has a short key-delay and fast repeat.

Minimize the size of your terminal window. Your terminal must be 60 chars wide by 40 lines for pacman, smaller for others.

Enlarge the Font so that the window fills your monitor.

To launch the game selector App, depending on your system, type:

winterm.bat or w32term.bat

or
macterm.sh

or
gnuterm.sh

Note that any individual app may still be executed from the directory appropriate to your O.S. For example, on Windows you can CD to bin\win and then type "cfrog" to run Frogger.

===========================================================================
## Compiler Scripts
There are four scripts, w[32]buildall.bat for msWindows, lbuildall.sh for Linux, and obuildall.sh for OS-X. They differ in where the executables are put. Now with so many different precompiled binaries for each OS, there would be too much clutter if they were all put into the same place.

===============================================================
## Build Instructions:
Remember that prebuilt executables are already included. But, if you want to rebuild...

Manually install GNAT GPL from libre.adacore.com/download/. If you don't like my key-mappings, edit the code as you like.

Next, edit the scripts wcmp.bat or lcmp.sh or ocmp.sh so that the path to gnatmake is correct. These scripts streamline the build process by allowing auxilliary files to be neatly hidden in subdirectories. And make sure it is executable.

Then type "[wlo]buildall" to create new command-line executables for your system. ( w for Windows, l for Linux, o for OSX). Note that on OSX, you must have the Apple-Xcode g++ compiler present in order to rebuild.

===============================================================

## What is special about this project?...freedom...
* uses the Ada programming language & GNAT GPL;
* runs on Windows, OSX, & Linux;
* uses only free open source software [F.O.S.S] tools & libraries;
* portable, transparent code, easy to modify, rebuild;
* uses OpenAL-Audio for sounds;
* pure minimalism: no graphics, just colored ASCII characters, keyboard, & sound;

===============================================================
## Legal Mumbo Jumbo:

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

Copyright (C) 2020 <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/>.

----------------------------------------------
## Other Credits and Thanks:
Serhiy Grabarchuk and Peter Grabarchuk for their "Hole in One", "Hole in One plus 4", and "Nine" puzzles.

Mike Billars [michael@gmail.com] for his C-version of Pacman for the console, after which this Ada version was modelled (gnu gpl).

----------------------------------------------
### SoundFiles [x.wav]
Fanfare/Applause sounds are from freesound.org and are covered by the Creative Commons Attribution noncommercial license documented in the accompanying file creativeCommons.txt. Others from
* classicgaming.cc/classics/pac-man/sounds
* classicgaming.cc/classics/frogger/sounds
(also CreativeCommons).

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

## Video BlockSlider Autosolve:

--------------------------------------------------
## Some Earlier Revision History:

**ver 2.0.2 -- 17jun20**
* Enhanced keystroke robustness;
* Enhanced/simplified puzzle coloring [cslid];

**ver 2.0.1 -- 10jun20**
* Fixed blank screen problems due to coding error.

**ver 2.0.0 -- 15may20**
* Added Sound!
* Added Frogger!
* Made sure EXEs run from their own directory, as well as the base directory.
* Replaces/superceeds: MiniPacman, TermFrogger, & TerminalApps.