Skip to content

workspace-cbn/EGF-Studio

Repository files navigation

EGF Studio - Quick Start Guide

Welcome to EGF Studio, a browser-based editor for the Educational Game Format (EGF) 1.1.

EGF Studio is a fork of EGF Creator. In addition to creating EGF packages from scratch, it can also open existing .egf files, let you edit scenes and project data, and then export an updated package.

Getting Started

Open index.html in any modern web browser. No installation or server required.

Main Features

With EGF Studio, you can:

  • create a new EGF package
  • open an existing .egf package
  • edit metadata, scenes, sequence, and settings
  • replace scene resources
  • validate and export your package

Creating or Editing an EGF Package

1. Metadata Tab

Fill in your game's basic information:

  • Title (required): Name of your educational game
  • Language (required): Two-letter code (e.g., en, fr, es)
  • Creator (optional): Your name or organization
  • Other optional Dublin Core fields

2. Manifest Tab

Special Scenes (required)

Add exactly one of each:

  • Game Title
  • Congratulations
  • Game Over
  • Credits

Content Scenes

You can add scenes such as:

  • Video Simple
  • Audio Simple
  • MCQ Simple
  • Hangman Simple

Cover Image

Optional but recommended:

  • Cover Image (.jpg, .jpeg, .png)

This tab can also be used to edit existing scenes and replace resources when an .egf package is opened.

3. Sequence Tab

Arrange scenes by drag and drop. EGF Studio enforces these rules:

  • Game Title must be first
  • Congratulations must be third from last
  • Game Over must be second from last
  • Credits must be last

4. Settings Tab

Enable and configure options such as:

  • Max Wrong Answers
  • Background Audio
  • Foreground Audio

5. Export Tab

Click Download EGF Package to:

  1. validate the package
  2. generate the ZIP file
  3. download it to your computer

Tips

  • IDs must be unique - Each manifest item needs a distinct identifier
  • Use descriptive IDs - e.g., intro_video, question_01, game_title
  • Test as you go - Click the Export tab frequently to check validation
  • Use Open EGF to reopen and update an existing package later

Conformance

EGF Studio produces EGF 1.1 conforming packages following the official specification: egf-format.org

Need Help?

Check the validation messages in the Export tab to identify missing or incorrect elements.

Happy game creating and editing! 🎮📚

Credits

This project uses the following third-party and original resources.

All assets listed below are licensed under Creative Commons Zero (CC0) unless otherwise noted.

Audio Assets

The following audio files were sourced from Freesound:

File Author Source
game_title_01.mp3 SkibkaMusic Freesound
game_title_02.mp3 g0ggs Freesound
game_title_03.mp3 EEE3333E Freesound
congratulations_01.wav Maikkihapsis Freesound
congratulations_02.wav mehraniiii Freesound
congratulations_03.wav qubodup Freesound
game_over_01.wav el_boss Freesound
game_over_02.mp3 buffsatan Freesound
game_over_03.wav Av3rageJ0e Freesound
good_answer_01.wav CogFireStudios Freesound
good_answer_02.mp3 Gronkjaer Freesound
good_answer_03.mp3 bogenseeberg Freesound
wrong_answer_01.wav Beetlemuse Freesound
wrong_answer_02.wav guitarguy1985 Freesound
wrong_answer_03.wav KevinVG207 Freesound
background_audio_01.wav Bigvegie Freesound
background_audio_02.mp3 EEE3333E Freesound
background_audio_03.wav Venus17 Freesound
foreground_01.mp3 qubodup Freesound
foreground_02.mp3 moodyfingers Freesound
foreground_03.mp3 TheDJoe93 Freesound

Image Assets

The following visual assets were created by Hervé Yvis with AI assistance and are licensed under Creative Commons Zero (CC0):

  • egf_cover.jpg
  • game_title.jpg
  • congratulations.jpg
  • game_over.jpg
  • level_01.jpg
  • level_02.jpg
  • level_03.jpg
  • challenge.jpg
  • all other Hangman-related images in the resources folder, including:
    • hangman_status_01.jpg
    • hangman_black_status_01.jpg
    • hangman_white_status_01.jpg

The following application icons were also created by Hervé Yvis with AI assistance and are licensed under Creative Commons Zero (CC0):

  • favicon.png
  • apple-touch-icon.png
  • icon-512.png
  • icon-192.png

About

EGF Studio Dashboard

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

No contributors