enigma-bbs/docs/modding/whos-online.md
Bryan Ashby e6a812cf34 Standardization work on built in user list module plus docs & code cleanup
* More docs, fix some info
* Code cleanup
2018-07-22 12:56:56 -06:00

18 lines
655 B
Markdown

---
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.
* `userName`: Login username.
* `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".