Gradient Descent

A game of learning the concepts behind gradient descent by exploring the depths looking for treasure.

Developed for the I AM AI exhibition by IMAGINARY.

Configuration

A config file is loaded when opening the application. It supports the following keys:

• defaultLanguage (string, default: "en"): Default language to use. Can be overriden by the lang query string.
• languages (array of strings, default: all languages present in tr.json): Selection and order of language codes for i18n.
• useGamepads (boolean, default: true): Enables gamepad use.
• useScreenControls (boolean, default: true): Shows on-screen controllers.
• useKeyboardControls (boolean, default: true): Control the game via keyboard (player 1: ←↓→ resp. ←Space→, player 2: ASD).
• botType ("none", "random", "gradient-descent", "tangent-intersection" or null, default: null): Set the type of bot player to use. Let the user choose if null.
• botTypeLabels ("difficulty" or "strategy", default: "difficulty"): Set the type of labels used to describe the bot type ("difficulty": difficulty level, "strategy": name of the bot strategy)
• showBotTypeTips (boolean, default: false): Show longer descriptions for bot types. Tips are optional, and can be set in the translation files with the keys bot-types.difficulty.<type>-tip o bot-types.strategy.<type>-tip.
• maxPlayers (integer, default: 2): Maximum number of players (between 1 and 4).
• maxTime (integer or string "Infinity", default: "Infinity"): Maximum number seconds until the game is over.
• maxProbes (integer or string "Infinity", default: "Infinity"): Maximum number of probes until the game is over.
• showSeaFloor (boolean, default: false): Make the sea floor visible from the very beginning.
• maxDepthTilt (float >= 0, default: 4): Tilt the sea floor generation towards shallow [0,1) or deep (1,∞).
• map (array or null, default: null): If null, auto-generate a map. Otherwise, use the supplied map. See below for details.
• continuousGame (boolean, default: false): Skip the title screen and time limit, auto-restart.
• showDemo (boolean, default: false): Alternate between the title screen and demo mode.
• demoDuration (integer, default: 18000): Duration of the demo mode in milliseconds.
• fullScreenButton (boolean, default: true): Show a button to toggle full-screen mode.
• languageButton (boolean, default: true): Show a button to cycle through the languages defined via languages.
• debugControls (boolean, default: false): Shows debugging data for controls.
• debugLog (boolean, default: false): Shows debugging messages in the console.

By default, the config file config.json is used. However, this file name can be overwritten by setting the config query string variable, e.g. index.html?config=config.local.json.

Remote controlling the game

The game adds a game object to the global scope.

Setting a sea floor map

A sea floor map is just an array of numbers between 0 (close to the water surface) and 1 (distant from the water surface). The array is used to generate a polyline from the left side of the screen to the right having equidistant nodes at the elements of the map array.

Maps can be set via game.setMap(map), e.g. setting a very simple V-shaped map could look like this:

game.setMap([0, 1, 0]);

A simple parabola-like map can be defined like so:

const parabola = t => 1 - Math.pow(2 * t - 1, 2);
const createMap = (distance, length) => Array.from(
  { length: length },
  (_, i) => distance(i / (length - 1))
);
game.setMap(createMap(parabola, 100));

Passing null as map will revert to auto-generating a new map for every round of the game.

Whenever another game round is started, the current map will be output to the developer console of the browser. This allows to store the current (possibly auto-generated) map elsewhere and re-use it later.

Note that the map is only applied for new rounds of the game, not the current one.

Setting the game mode

The game consists of the modes title, numplayers and play. You can switch to another mode or re-enter the current mode via game.setMode(mode). E.g. to load a map and play a new round of the game, run

const map = ...;
game.setMap(map);
game.setMode('play');

Showing the sea floor

If the game is in play mode, the sea floor of the current game round can be shown via game.showSeaFloor(animate). If animate is true, the sea floor will be uncovered slowly. Otherwise, it will be shown immediately. This method has no effect in other game modes.

Compilation

This web application is built using several compilable languages:

• The HTML pages are built from pug template files.
• The CSS stylesheet is pre-compiled from sass files.
• The JS scripts are trans-compiled from es6 (ES2015) files.

To make any modifications re-compilation is necessary. You should install:

• node and npm
• yarn
• gulp (install globally)

Afterwards run the following in the command line to install dependencies:

cd src
yarn

After the dependencies have been installed successfully, you can compile as needed:

• sass (stylesheets)

  gulp styles
  

• scripts (ES6)

  gulp scripts
  

• dependencies (ES6)

  gulp dependencies
  

• pug (HTML pages)

  gulp html
  

• all

  yarn run build
  

  respectively

  gulp build
  

• watch for changes and recompile as needed

  gulp build
  

Note that gulp html needs to be run after gulp styles, gulp scripts and gulp dependencies since the html files need to be updated in order to point to the updated build artifacts. gulp build will run all task in order and take care of html.

Serving and automatic reloading

cd src
npx reload -d .. -w ../index.html -p [free port]

Internationalization

To add a new translation, the following steps are necessary:

• Figure out the language code for the language you want to add, e.g. eo for Esperanto.
• Copy a locale file from tr for a language you are familiar with and rename its basename to match the new language code, e.g. copy tr/en.json to tr/eo.json.
• Translate all the texts in the new locale file. Preserve whitespace.
• Add the new language code and its endonym to tr.json.
• Add your name to the list of contributors below.

Credits

Developed by Christian Stussak and Eric Londaits, based on a concept by Aaron Montag, IMAGINARY gGmbH.

Translations

• Dutch: Jarne Renders
• English: Christian Stussak, Eric Londaits
• French: Barbara Knapiak, Daniel Ramos
• German: Christian Stussak, Andreas Daniel Matt
• Spanish: Daniel Ramos

License

Copyright (c) 2020 IMAGINARY gGmbH Licensed under the MIT License (see LICENSE)