AdaVenture file

---

# AdaVenture
## using GLFW & OpenAL

## Recent Changes

**ver 2.4.0 -- 11feb2024**

* Improved/generalized OSX build scripts.
* Command line params clarified: 1=allowHiDpi(default); 0=forceLoDpi.
(Use low DPI to smooth out action graphics.)
* Added waterfall from castle roof into cistern, using both particle & ribbon textures.
* Added a wandering toxic cloud in labyrinth.
* Embellished castle interior.

**ver 2.3.9 -- 21oct2023**

* Added check for adequate window size when displaying list of saved games.
* Changed sort of saved games to show most recent first.

**ver 2.3.4 -- 23feb2023**

* Fixed graphical anomaly in castle; & other code improvements.
* Documented ghost-key.
* Bat now grabs sword if it is dropped to pickup black key.

## More change-history at end of file

## AdaVenture Game Description
AdaVenture is a kid-friendly retro point & click game, a reincarnation in 3D of the original Atari game named "Adventure", with various artistic extrapolations. The mazes have interconnections that are impossible in 3 dimensions, but are painstakingly exact reproductions of those in the original game. In fact, the "mapRoom" subdirectory contains the original maps to help guide you.

Runs on Windows, and GNU/Linux. Includes all source code, build scripts & resources.

-----------------------------------------------------------
Featuring

* no installation
* no dependencies
* simply unzip in your Downloads directory, and run;
* or unzip onto a USB flash drive [w/same file format] and run.
-----------------------------------------------------------

## AdaVenture Introduction
Set in ancient Persia, it begins outside the castle of the young King Xerxes, who inherited a magical golden chalice from his father, Darius the Great. Coveted by Greek foes King Leonidas of Sparta and King Minos of Crete, the chalice has been stolen.

Your quest is to seek and return the royal chalice to its pedestal within the castle of Xerxes...a stealth mission to preclude open hostilities. But, there will be obstacles to overcome. You must find the keys to various realms, defend yourself against dragons and the Minotaur, avoid snakes and pesky bats who steal things only to drop them in random locations, and survive the maze of the green mamba and crazed, flesh-eating scarabs.

## AdaVenture Game Features

* When looking closely at a pickable object, a hand will appear indicating that a click will pick up the object. When holding an object, another click will drop it at the current location. Only one object at a time may be carried.

* Works on PCs or laptops running Windows, or GNU/Linux. And if Ada is installed you can build it yourself! But first try the delivered binaries.

* Windows & Linux binaries provided, as well as full source.

* Laptop friendly controls; supports HiDpi displays.

* The game has four levels. Level 1 : fairly easy campaign in Sparta, with a more difficult variant [ level 3] due to thick dark fog & randomized key locations. These are the top two. Similarly, level 2 is a tricky campaign in Crete, and an even more difficult dark variant [level 4]. These are the bottom two, showing Minotaurs. You select the desired campaign at the beginning of the game.

* You can explicitly save the current game by using the v-key. This allows resumption later. You must replay from the beginning if you die before saving.

* In the unlikely event a game aborts before you save a game, you might be able to recover as follows.
Go to the "data" subdirectory and copy the file "gamestatex.txt" to the ./savedGames/ directory,
then choose resume at startup and pick gamestatex.txt.
Note that this recover file is NOT created if you die, but only if the game malfunctions.

* Maze/Labyrinth hint: For a younger generation that is not familiar with the original Atari Adventure game, note that there is a magenta colored moveable "bridge" that may be picked up and carried to another location where a shortcut is needed with the following shape: **][** Its use is required to access the chalice, and to escape the labyrinth in levels 2 & 4.

* To change the appearance of the avatar, simply download your favorite MineCraft Skin, rename it to "skin.png" and put it into the ./data/ directory. You should probably backup the current skin before you do this, in case of trouble. See Minecraftskins.net. See also ./data/avatars/ for a small selection.

* For developers, serves as a great example of modern OpenGL programming using GLSL 330, shaders, uniforms and Freetype fonts.

* The thin Ada bindings to OpenGL & GLFW3, and the minimal binding to OpenAL in this app are usable as standalone libraries for most any modern Ada graphics project.

* The sound system enables a build with surprising portability across various linux distros, as well as across various platforms.

## mouse/touchpad/keyboard controls

[You might need to disconnect unused gamecontrollers to prevent spinning!]

Look direction is controlled by touch pad or mouse;

The mouse wheel controls camera zoom. On laptops, a 2-finger swipe simulates the mouse wheel;
Zoom can also be controlled with keys n, f, z [Nearer,Further,default]; Note that Zoom changes now show immediately, even when stopped, but Lazy Camera change does not show immediately.

Movement is controlled by the WASD keys or the arrow keys:

(Up)
(Lt) (Dn) (Rt)

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

* (v)-key => saVe game state to resume later
* (esc)-key => exit;
* (i)-key => toggle Intro/Help screen
* (h)-key => toggle Intro/Help screen
* (space)-key => pick or drop
* mouse-click => pick or drop
* (m)-key => toggle Mouse-view (1st-person) or avatar(3rd-person)
* (l)-key => toggle camera type: 1)Lazy(default), or 2)Tight

### Game Notes:
* only one object may be carried.
* In case of unexpected control problems with the game, or if you want to easily inspect some curious feature (like Jupiter in the night sky), temporarily switch to 1st-person mode with the (m)-key.
* When looking for the black key, it might help to try to find the "ghost" key, a white key image on the ceiling above the actual key location. In levels 3 & 4, the fog makes this difficult to see.

### joystick
* joystick: attitude
* center thumb btn: forward
* trigger btn: backward
* side thumb btns: pick or drop items

------------------------------------------------------------
### gamecontroller
* Lpaddle/Lhat: movement
* Rpaddle : attitude
* L/R Shoulder btns: pick or drop items

Note that regression testing of these controllers has not been done for quite a while.
Any volunteers?

------------------------------------------------------------
### controller settings
If the need arises, copy the file "default_settings.txt" to "./data/settings.txt". Then you can manually edit the floats that define the sensitivity for mouse, keyboard, gamepad & joystick, as well as forward speed of the avatar.

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

## System Requirements:

* graphics card with ample memory & driver that supports OpenGL version 3.3 or later;
* Windows, GNU/Linux(glibc > v2.17)
* optional game controller or joystick.

## Setup & Running Adaventure:

The application's root directory [./avent/] contains files for deployment on 2 platforms: 1)windows (64 bit), 2)linux, in addition to source code. If you are NOT running windows, you do not need .dll files.

Windows users see "windows-setup.txt".

Unzip the archive. On Windows, 7z [www.7-zip.org] works well for this.
The proper command to extract the archive and maintain the directory structure is "7z x filename".

Open a commandline terminal, and cd to the install directory, and type:

adaventure64.bat (Windows 64-bit)
adaventure (Linux, gnat build)

The linux executable has been recently tested, and runs well on Trisquel, ScientificLinux, OpenSuse, and Mint.

**If an older Linux system complains that /dev/dsp/ cannot be opened, prepend the command with "padsp",EG: "padsp (ExeName)".**

Also, the Windows executable can be run on linux using wine thusly:
* wine binw64/adaventure64.exe

Windows users note: DO NOT try running the linux executables under WSL [Windows Subsystem for Linux]; that mode is not supported. Simply use the windows version.

Remember to save the game [ v-key ] prior to risky behavior or quitting, in order to easily resume later.
This writes enough information into a file to be able to resume later.

In case of trouble moving, switch to 1st person.

Note that adjustable OpenGL settings should favor performance. OTOH, this game runs fine on an Intel NUC with embedded Intel graphics, so the graphics demands are modest.

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

## Included Open Source libraries that allow rebuilding:
* GLFW, openal, freetype
* glext.lib for Windows
* the included "bindings" directory contains Ada interfaces for:
* gl
* glfwada
* OpenAL
* Stephen Sanguine's AdaPngLib
* Dmitriy Anisimkov's Zlib for Ada
* Felix Krause's FreeTypeAda
* Dmitry Kazakov's strings, tables

## Rebuild Requirements:
* systems: Windows, or GNU/Linux
* a recent Ada compiler; eg. GNU-Ada...try this link:
* Github.com

## Build instructions for AdaVenture:

Three [pre-compiled] binary executables are delivered, two for Windows, & one for gnu/linux. I believe the Windows executables are fairly portable. They were built on Windows 10.

The distributed linux executable requires glibc v2.17 or newer. That means if your distribution is older than 2012, it may not run, and you might need to recompile. But if you have wine, you can simply run the Windows executables.

Build scripts for GNU Ada, which comes with its own g++ compiler, are provided.

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

**msWin64** => setpath64.bat + w64cmp.bat (read ~docs\gnuAdaOnWindows.txt)

Note that the above windows build scripts might need to be adjusted to reference your actual installation directory for the GNU Ada compiler.

------------------------------------------------------
**GNU/Linux** => mcmp.sh:

uses dynamic linking for some common shared libraries that are delivered in this bundle under ./libs/gnu/. These are used to build the [gnu/linux] executable, which should run in the presence of ./libs/gnu/, whether or not your system has those shared libraries installed.

If the delivered linux binary does not run...

* Manually install GNU Ada.
* Rerun the compile script mcmp.sh.

### Fixable link problems during linux build:

On a linux build machine, you might get a few fixable link errors, depending on its configuration. If you are missing "libxxx.so", you might simply need to create a proper softlink so it can be found.

----------------------------------------------------------------------
## For Developers Only: Portable Avatar Using Shaders

* This approach encapsulates the details of avatar shape, color, and movement within GLSL shaders and a related code object that defines vertices and texture maps. The object may be an Ada package or C++ class.

* Programmatic inputs include uniforms for time, position, attitude, & type of motion. The shaders then offload the realtime computational burdens onto the graphics processor.

* Data that defines shape and color, as well as the uniforms and functions that define behavior, reside completely within the object and shaders. This data can ultimately be as detailed and refined as your imagination permits. And any refinements made are not obfuscated in some esoteric or proprietary format with a limited audience, but remain fully portable and easily enhanced by most any developer using Free Open Source tools and compilers.

* One approach would be to completely define the avatar within the shaders alone, possibly without using any texture files. Just look at the creatures in (glslsandbox.com). This would require advanced GLSL skills.

* But a huge selection of available MineCraft skins lead to the present avatar object design.

* In this application, the texture object is a cube with radius one that is defined as 6 disjoint cubelets (the precise name is rectangular cuboid or parallelpiped). The 2 upper quarters map to the head and torso. The lower half is divided into 4 cubelets that are mapped to arms and legs. See "cuboid.txt". The Minecraft images used for the texture also have 6 parts that map to the limbs, head and torso.

* The result is an utterly portable avatar defined by an image and 4 text files:
* texture object body, avatarobj.adb
* texture object specification, avatarobj.ads
* vertex shader, avatarobj.vs
* fragment shader, avatarobj.fs
* any MineCraft Skin png file

* Interfacing game code with such an avatar is simple. Essentially you need only pass the current uniform values prior to drawing, including time, position, attitude, motion-type.

* Of course one still needs a decent camera positioning and pointing policy within the game code in order to fully appreciate and exhibit the avatar. The details are beyond the scope of this brief introduction, but generally the current policy is a damped and delayed move toward some fixed ideal camera angle and position above and behind the avatar. Two possible ideal camera angles are: a) pointing toward the look-direction of the avatar; b) pointing toward the avatar. The ideal camera angles would depend upon the immediate game environment and goals.

----------------------------------------------------------------------
## For Developers Only: Fancy Shaders, FX

This app demonstrates how to use fancy fragment shaders from glslsandbox.com to make starry maze skies. See below (Media Files). It also demonstrates the use of coherent noise to create the rolling fireball in the labyrinth.

----------------------------------------------------------------------
## For Developers Only: OpenAL portable sound package

This app uses a cross-platform sound-playing package for Ada apps that can asynchronously start and stop music loops, as well as initiate transient sounds, allowing unlimited concurrency.

It plays WAV files, via OpenAL, on Windows, and linux platforms.

It is suitable for any Ada application that needs music, sound loops or transient sound effects; eg. games.

-----------------------------------------------------------------------
## What is special about this project?

The linux-build of this app is among very few modern OpenGL games with sound where a single pre-built executable can run on multiple Linux distros without any 3rd party add-ons! It is routinely tested on OpenSuse[2022], ScientificLinux[redhat derivative from 2012], & Mint.

For developers, this project can serve as a testbed for learning modern OpenGL and GLSL.

It uses the Ada programming language and modern OpenGL methods, with textures, shaders and uniforms. Compiles and runs on Windows, GNU/Linux systems.

Focusing on portability, transparency, and open source freedom, this project relies exclusively on F.O.S.S. tools: a thin glfw3 binding, a thin OpenGL binding, a PNG reader by Stephen Sanguine and Dimitry Anisimkov, OpenAL-Audio with a homebrew binding, a FreeTypeAda binding by Felix Krause, plus string & table utilities by Dmitry Kazakov.

The Ada bindings are thin, so the relationship to C++ methodology is transparent. Developers should note that these Ada bindings can be used for your own OpenGL Ada project.

For the C++ programmer the code should be easy to comprehend; and for the experienced Ada programmer there are many ada-specializations yet to be made.

This game is a work in progress, so please excuse any scaffolding and debugging code has not been removed.

Open source Ada developers are welcome to help improve or extend this app.
Developer or not, send comments, suggestions or questions to:

* fastrgv@gmail.com

and please include the file gamestatex.txt from the data directory if you are reporting a freeze or abort.

--------------------------
## License:

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

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

## Media Files:

### General Note
The particular choices of shaders, sounds & images are not essential to the function of the game and are easily replaced.

It is my intention to use media with copyrights or licenses that are compatible with GPLv3. Please notify me if you believe there is an incompatibility, and it will be removed ASAP, eg a CC-by-NC license is NOT GPL compatible.

### SoundFiles
Most sounds are from freesound.org and are covered by the Creative Commons CC0 license documented in the accompanying file ./docs/otherLicenses/creativeCommonsCC0.txt. A few others with CC-by-3.0 license have accompanying text files with attributions.

Others [eg. shriek] are from Freesfx.co.uk, which have an attribution requirement, but no legal restrictions otherwise.

Some original Atari sounds [public domain] were also used.

Credit and thanks to Kevin Macleod [CC-by-3.0] for his great compositions Cephalopod, AngevinB, & Ibn-Al-Noor.

Credit and thanks to the Godfather of Exotica, Korla Pandit, for the excellent renditions of Turkish Dance and Miserlou...a song so old that its origins are vague, yet was known to have been popular in ancient Persia and the middle-east, as well as to all us fans of Dick Dale!

### ImageFiles
* the GPL2.0/GPL3.0-only section of OpenGameArt.Org.
* Mayang.com. See ./docs/mayang_license.txt.
* pixabay.com with a CC0 license.
* All-free-download.com (public domain).

### ShaderFiles
Several fragment shader files used were downloaded from Glslsandbox.com and put under ./data/. All frag. shaders from glslsandbox are under the MIT license (see ./docs/mit_license.txt). Existing comments or any identifying information was retained.

In order to make these usable, I had to modernize them to glsl version 330 specifications, and adapt them to utilize some programatic uniforms for input.

### SkyBoxes

* www.custommapmakers.org/skyboxes.php
* www.OpenGameArt.org; thanks to Pieter Spiney Verhoeven (cloudy)
* Some beautiful hi-res skyboxes used [from OpenGameArt.org] are the work of Heiko Irrgang <hi@93-interactive.com> and licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. To view a copy of this license, visit (http://creativecommons.org/licenses/by-sa/3.0/) or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA. See also the accompanying file ./docs/ccsa3_license.txt.</hi@93-interactive.com>

### Bindings & Utilities

Thanks to Dmitry Kazakov, Dimitry Anisimkov, Stephen Sanguine and Felix Krause, for their software tools, as mentioned above.

## Download Sites for my games:

* Github.com
* Indiedb.com
* Fastrgv.itch.io
* Sourceforge.net
* Gamejolt.com

## Video Level 1:

## Tags
kids,retro,adventure,dragon,castle,maze,labyrinth

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

## Update History:

**ver 2.3.3 -- 8feb2023**
* Refined labyrinth actions & sounds.
* Added theme music for intro-screen [from P.I.R.]
* Added more Kevin Macleod music at finale.

**ver 2.3.2 -- 07jan2023**
* Discontiued OSX development.
* Added exterior stone fence; palms.
* Improved scarab sound effects.
* Improved documentation.

**ver 2.3.1 -- 30sep2022**
* Now using simpler-to-setup GNU Ada for Win64.

**ver 2.2.8 -- 16apr2022**
* Improved zoom function.
* Reverted linux libraries to exclusively shared format for portability.
* Alternate script for GNU-Ada also works, now.

**ver 2.2.7 -- 18jan2022**
* Eliminated unused Frameworks directory
* Updated Windows builds to freetype v2.11.1 DLLs (w32,w64).
* Updated linux libs to use static libfreetype.a & libpng16.a