Skip to main content

KnotLink Protocol and Integration

KnotLink is the bridge between FolderRewind and external programs (such as game mods and scripts).

Typical use cases​

  • Notify external program to save before backup
  • Notify external program to reload state after restore
  • Accept external commands to trigger backup or restore, and force a Full backup when needed

Plugin integration points​

  • PluginHostContext.BroadcastEvent(...): broadcast events
  • PluginHostContext.QueryKnotLinkAsync(...): request-response query
  • IFolderRewindKnotLinkCommandHandler: extend recognizable commands

Example commands in MineRewind​

  • BACKUP_CURRENT
  • BACKUP <config_id> <folder_index|folder_name> [comment] [FORCE_FULL]
  • RESTORE_CURRENT_LATEST
  • LIST_BACKUPS_CURRENT
  • RESTORE_CURRENT

See implementation details in KnotLink Command API.