Skip to content

smartanel/EGF-Creator

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

EGF Creator - Quick Start Guide

Welcome to the EGF Creator, the first implementation of the Educational Game Format 1.1!

Getting Started

Simply open index.html in any modern web browser. No installation or server required!

Creating Your First 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 - Opening screen
  • Congratulations - Success screen
  • Game Over - Failure screen
  • Credits - End credits

Click "Add Special Scene", select the type, provide an ID, and upload the XML file.

Content Scenes

Add your educational content:

  • Video Simple - Tutorial videos (MP4, WebM)
  • Audio Simple - Audio lessons (MP3, WAV, OGG)
  • MCQ Simple - Multiple choice questions (XML)
  • Hangman Simple - Hangman-style word puzzles (XML)

Cover Image

Optional but recommended, add the cover image of your game:

  • Cover Image - Package thumbnail (JPEG, PNG)

3. Sequence Tab

Arrange your scenes in order by dragging and dropping. The creator 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

Activate any settings you added:

  • Max Wrong Answers
  • Background Audio
  • Foreground Audio

5. Export Tab

Click "Download EGF Package" to:

  1. Validate your package
  2. Generate the ZIP file
  3. Download to your computer

File Structure

Your EGF package will contain:

your_game.egf
├── mimetype
├── META-INF/container.xml
└── egf/
    ├── egf.xml
    └── assets/
        └── [your uploaded files]

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
  • Save your XML files - Keep copies of scene XML files for editing later

Conformance

This creator produces EGF 1.1 conforming packages that comply with the official specification at egf-format.org.

Need Help?

Check the validation messages in the Export tab - they'll guide you if anything is missing or incorrect!


Happy game creating! 🎮📚

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 75.5%
  • CSS 18.4%
  • HTML 6.1%