Timegate (Global Timer Overlay)

Timegate adds a persistent, bottom-right timer overlay to SCORM packages and can optionally gate SCORM completion until a minimum time is met.

Quick Start (Publishers)

1. Unzip the SCORM package.
2. Copy the timegate/ folder into the SCORM root (same level as imsmanifest.xml).
3. Edit timegate/timegate.config.json and set minRequiredMinutes.
4. Run the installer for your OS:
   • macOS: timegate/install-timegate.command
   • Linux/macOS: timegate/install-timegate.sh
   • Windows: timegate/install-timegate.ps1
5. The installer creates <folder>-timegate.zip in the parent folder of the SCORM package.
6. Upload that zip to your LMS.

Configuration

Edit timegate/timegate.config.json:

• minRequiredMinutes (number): required time for the course.
• enforceCompletion (boolean): gate SCORM completion until time met.
• idleTimeoutSeconds (number): stop counting after idle timeout.
• countWhileMediaPlaying (boolean): count while audio/video is playing.
• displayMode (remaining | elapsed): show remaining or elapsed time.
• hideWhenComplete (boolean): hide overlay after minimum met.
• labelText (string): label shown above the timer.
• position (bottom-right | bottom-left): overlay position.
• debug (boolean): enable console logging.
• storageMode (localStorage | suspend_data | dual): choose persistence strategy.

Notes

• Primary persistence uses localStorage. If unavailable, Timegate attempts to store under cmi.suspend_data in a safe JSON namespace.
• Completion gating only affects SCORM reporting; it does not block course UI.