diff --git a/WHATSNEW.md b/WHATSNEW.md index 191f1c7b..f78bf6c3 100644 --- a/WHATSNEW.md +++ b/WHATSNEW.md @@ -15,8 +15,8 @@ This document attempts to track **major** changes and additions in ENiGMA½. For * The old concept of `autoScale` has been removed. See https://github.com/NuSkooler/enigma-bbs/issues/166 * Ability to delete from personal mailbox (finally!) * Add ability to skip file and/or message areas during newscan. Set config.omitFileAreaTags and config.omitMessageAreaTags in new_scan configuration of your menu.hjson -* `{userName}` (sanatized) and `{userNameRaw}` as well as `{cwd}` have been added to param options when launching a door. -* Any module may now register for a system startup intiialization via the `initializeModules(initInfo, cb)` export. +* `{userName}` (sanitized) and `{userNameRaw}` as well as `{cwd}` have been added to param options when launching a door. +* Any module may now register for a system startup initialization via the `initializeModules(initInfo, cb)` export. * User event log is now functional. Various events a user performs will be persisted to the `system.db` `user_event_log` table for up to 90 days. An example usage can be found in the updated `last_callers` module where events are turned into Ami/X style actions. Please see `UPGRADE.md`! * New MCI codes including general purpose movement codes. See [MCI codes](docs/art/mci.md) * `install.sh` will now attempt to use NPM's `--build-from-source` option when ARM is detected. diff --git a/docs/modding/local-doors.md b/docs/modding/local-doors.md index 06b80ac1..4ab8037b 100644 --- a/docs/modding/local-doors.md +++ b/docs/modding/local-doors.md @@ -41,7 +41,7 @@ The following variables may be used in `args` entries: | `{dropFile}` | Dropfile _filename_ only. | `DOOR.SYS` | | `{dropFilePath}` | Full path to generated dropfile. The system places dropfiles in the path set by `paths.dropFiles` in `config.hjson`. | `C:\enigma-bbs\drop\node1\DOOR.SYS` | | `{userId}` | Current user ID. | `420` | -| `{userName}` | _Sanitized_ username. Safe for filenames, etc. | `izard` | +| `{userName}` | [Sanitized](https://www.npmjs.com/package/sanitize-filename) username. Safe for filenames, etc. If the full username is sanitized away, this will resolve to something like "user_1234". | `izard` | | `{userNameRaw}` | _Raw_ username. May not be safe for filenames! | `\/\/izard` | | `{srvPort}` | Temporary server port when `io` is set to `socket`. | `1234` | | `{cwd}` | Current Working Directory. | `/home/enigma-bbs/doors/foo/` |