crichardson/enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updates and add start of WFC doc

Browse Source
This commit is contained in:
Bryan Ashby
2022-05-01 17:40:31 -06:00
parent dd7d24f22e
commit 44505f664a
4 changed files with 45 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/_docs/modding/wfc.md Normal file
View File

@@ -0,0 +1,29 @@
---
layout: page
title: Waiting For Caller (WFC)
---
## The Waiting For Caller (WFC) Module
The `wfc.js` module provides a Waiting For Caller (WFC) type dashboard from a bygone era. ENiGMA½'s WFC can be accessed over secure connections for accounts with the proper ACS. See **Security** information.
## Security
## Theming
The following MCI codes are available:
* MCI 1 (`VM1`): Node status list with the following format items available:
* `{text}`: Username or `*Pre Auth*`.
* `{action}`: Current action/menu.
* `{timeOn}`: How long the node has been connected.
* MCI 2 (`VM2`): Quick log with the following format keys available:
* `{timestamp}`: Log entry timestamp in `quickLogTimestampFormat` format.
* `{level}`: Log entry level from Bunyan.
* `{levelIndicator}`: `T` for TRACE, `D` for DEBUG, `I` for INFO, `W` for WARN, `E` for ERROR, or `F` for FATAL.
* `{nodeId}`: Node ID.
* `{sessionId}`: Session ID.
* `{message}`: Log message.
* MCI 10...99: Custom entries with the following format keys available:
* `{nowDate}`: Current date in the `dateFormat` style, defaulting to `short`.
* `{nowTime}`: Current time in the `timeFormat` style, defaulting to `short`.
* `{now}`: Current date and/or time in `nowDateTimeFormat` format.
* `{processUptimeSeconds}`: Process (the BBS) uptime in seconds.
* `{totalCalls}`: Total calls to the system.
* `{totalPosts}`: Total posts to the system.