zydronium/enigma-bbs
1
0
Fork 0
mirror of https://github.com/NuSkooler/enigma-bbs.git synced 2025-07-22 02:35:56 +02:00
Code Issues Projects Releases Packages Wiki Activity
enigma-bbs/docs/modding/file-base-download-manager.md
Bryan Ashby e316b5fe80 Add File Base Download Manager docs
2018-11-18 01:56:40 -07:00

897 B
Raw Blame History

layout title
page File Transfer Protocol Select

File Base Download Manager Module

The file_base_download_manager module provides a download queue manager for "legacy" (X/Y/Z-Modem, etc.) downloads.

Configuration

Configuration Block

Available config block entries:

  • webDlExpireTimeFormat: Sets the moment.js style format for web download expiration date/time.
  • fileTransferProtocolSelection: Overrides the default fileTransferProtocolSelection target for a protocol selection menu.
  • emptyQueueMenu: Overrides the default fileBaseDownloadManagerEmptyQueue target for menu to show when the users D/L queue is empty.

Theming

The following itemFormat object is provided to MCI 1 (ie: %VM1) and MCI 10+ custom fields:

  • fileId: File ID.
  • areaTag: Area tag.
  • fileName: Entry filename.
  • path: Full file path.
  • byteSize: Size in bytes of file.