Embedded EGF 1.1 Reader - Quick Start Guide

Embedded EGF 1.1 Reader is a standalone web application that automatically loads and plays a preconfigured Educational Game Format (EGF) package. The package may be included in the application folder or loaded from a remote URL. It is compatible with EGF 1.1 and EGF 1.0.

Configuration

Before using the reader, edit the config.js file to choose which EGF package is loaded automatically at startup and to set the default interface options.

Available settings:

• preloadedEgfUrl: relative path or absolute URL of the .egf file to load automatically at startup. It may point to a file included in the application folder or to a file hosted on another server, provided it is accessible from the browser.
• defaultLang: interface language
  Allowed values: "en", "fr", "es", "pt", "zh", "ar", "hi", "ur", "ru", or "auto" to use the browser language.
  If an unsupported value is provided, the reader falls back to "en".
• defaultTheme: interface theme
  Allowed values: "dark", "light", or "system"
"system" uses the browser-reported system color scheme (prefers-color-scheme)
  If an unsupported value is provided, the reader falls back to "system".

Example:

window.EGF_READER_CONFIG = Object.freeze({
    preloadedEgfUrl: "./your_game.egf",
    defaultLang: "fr",
    defaultTheme: "light"
});