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

Add Who's online docs, minor doc updates to last callers, and code cleanup

Browse Source
This commit is contained in:
Bryan Ashby
2018-07-22 10:55:39 -06:00
parent 28afc56d84
commit 0d7a20027c
3 changed files with 20 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/modding/last-callers.md
View File

@@ -23,7 +23,7 @@ Available `config` block entries:
* `actionIndicatorDefault`: Default indicator when an action is not set. Defaults to "-".
### Theming
When in a list view, the following `itemFormat` object is provided:
The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`):
* `userId`: User ID.
* `realName`: User's real name or "N/A".
* `ts`: Timestamp in `dateTimeFormat` format.

17
docs/modding/whos-online.md Normal file
View File

@@ -0,0 +1,17 @@
---
layout: page
title: Who's Online
---
## The Who's OnlineModule
The built in `whos_online` module provides a basic who's online mod.
### Theming
The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`):
* `userId`: User ID.
* `node`: Node ID the user is connected to.
* `timeOn`: A human friendly amount of time the user has been online.
* `realName`: User's real name.
* `location`: User's location.
* `affiliation` or `affils`: Users affiliations.
* `action`: Current action/view in the system taken from the `desc` field of the current MenuModule they are interacting with. For example, "Playing L.O.R.D".