Add File Base Download Manager docs
This commit is contained in:
@@ -74,6 +74,7 @@
|
||||
- [File Transfer Protocol Select]({{ site.baseurl }}{% link modding/file-transfer-protocol-select.md %})
|
||||
- [Onelinerz]({{ site.baseurl }}{% link modding/onelinerz.md %})
|
||||
- [Show Art]({{ site.baseurl }}{% link modding/show-art.md %})
|
||||
- [Download Manager]({{ site.baseurl }}{% link modding/file_base_download_manager.md %})
|
||||
|
||||
- Administration
|
||||
- [oputil]({{ site.baseurl }}{% link admin/oputil.md %})
|
||||
|
||||
22
docs/modding/file-base-download-manager.md
Normal file
22
docs/modding/file-base-download-manager.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
layout: page
|
||||
title: 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.
|
||||
|
||||
Reference in New Issue
Block a user