From 8552e2dd358fc66a97d69379f134c3207b4f6e08 Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Fri, 12 Aug 2022 19:21:45 -0600 Subject: [PATCH] Doc updates --- UPGRADE.md | 25 +++++++++++++------------ docs/_docs/installation/testing.md | 5 ++--- docs/_docs/modding/menu-modules.md | 12 ++++++++++-- docs/_docs/modding/wfc.md | 8 ++++++++ 4 files changed, 33 insertions(+), 17 deletions(-) diff --git a/UPGRADE.md b/UPGRADE.md index 93c7b1d4..b2635887 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -1,7 +1,7 @@ # Introduction This document covers basic upgrade notes for major ENiGMA½ version updates. -> :information_source: Be sure to read the version-to-version upgrade notes below for each upgrade! +> :information_source: **Be sure to read the version-to-version upgrade notes below** for each upgrade! # Before Upgrading * Always back up your system! (See [Administration](./docs/admin/administration.md)) @@ -27,9 +27,8 @@ npm install # or simply 'yarn' ``` # Problems -Report your issue on Xibalba BBS, hop in #enigma-bbs on FreeNode and chat, or -[file a issue on GitHub](https://github.com/NuSkooler/enigma-bbs/issues). - +1. Check [TROUBLESHOOTING](TROUBLESHOOTING.md) first. +2. Report your issue on Xibalba BBS, hop in #`enigma-bbs` on FreeNode and chat, or [file a issue on GitHub](https://github.com/NuSkooler/enigma-bbs/issues) if you believe you've found a bug or missing feature. # 0.0.12-beta to 0.0.13-beta * To enable the new Waiting for Caller (WFC) support, please see [WFC](docs/modding/wfc.md). @@ -38,22 +37,24 @@ Report your issue on Xibalba BBS, hop in #enigma-bbs on FreeNode and chat, or ```hjson { - term: { - // checkUtf8Encoding requires the use of cursor position reports, which are not supported on all terminals. - // Using this with a terminal that does not support cursor position reports results in a 2 second delay - // during the connect process, but provides better autoconfiguration of utf-8 + // checkUtf8Encoding requires the use of cursor + // position reports, which are not supported on all terminals. + // Using this with a terminal that does not support cursor + // position reports results in a 2 second delay during the + // connect process, but provides better autoconfiguration of utf-8 checkUtf8Encoding: true - // Checking the ANSI home position also requires the use of cursor position reports, which are not - // supported on all terminals. Using this with a terminal that does not support cursor position reports - // results in a 3 second delay during the connect process, but works around positioning problems with + // Checking the ANSI home position also requires the use of + // cursor position reports, which are not supported on all + /// terminals. Using this with a terminal that does not support + // cursor position reports results in a 3 second delay during + // the connect process, but works around positioning problems with // non-standard terminals. checkAnsiHomePosition: true } } - ``` In addition to these, there are also new options for `term.cp437TermList` and `term.utf8TermList`. Under most circumstances these should not need to be changed. If you want to customize these lists, more information is available in `config_default.js` diff --git a/docs/_docs/installation/testing.md b/docs/_docs/installation/testing.md index 1efc47cc..1982d0d2 100644 --- a/docs/_docs/installation/testing.md +++ b/docs/_docs/installation/testing.md @@ -12,7 +12,7 @@ _Note that if you've used the [Docker](docker.md) installation method, you've al If everything went OK: -```bash +```text ENiGMA½ Copyright (c) 2014-2022, Bryan Ashby _____________________ _____ ____________________ __________\_ / \__ ____/\_ ____ \ /____/ / _____ __ \ / ______/ // /___jp! @@ -34,11 +34,10 @@ To shut down the server, press Ctrl-C. * The default port for Telnet is 8888 and 8889 for SSH. * Note that on *nix systems port such as telnet/23 are privileged (e.g. require root). See - [this SO article](http://stackoverflow.com/questions/16573668/best-practices-when-running-node-js-with-port-80-ubuntu-linode) for some tips on using these ports on your system if desired. + [this Stack Overflow article](http://stackoverflow.com/questions/16573668/best-practices-when-running-node-js-with-port-80-ubuntu-linode) for some tips on using these ports on your system if desired. * The first user you create when logging in will be automatically be added to the `sysops` group. ## Telnet Software - If you don't have any telnet software, these are compatible with ENiGMA½: * [SyncTERM](http://syncterm.bbsdev.net/) diff --git a/docs/_docs/modding/menu-modules.md b/docs/_docs/modding/menu-modules.md index 1a1328a8..940752b9 100644 --- a/docs/_docs/modding/menu-modules.md +++ b/docs/_docs/modding/menu-modules.md @@ -145,7 +145,7 @@ Prepares the menu's View Controller for a form of `name` and `formId` using the * `validateConfigFields()` ### Date/Time Helpers -The following methods take a single input to specify style, defaulting to `short`: +The following methods take a single input to specify style, defaulting to `short`. If your menu or theme `config` block specifies a cooresponding value such as `dateFormat` or `dateTimeFormat`, that value will be used, else standard fallbacks apply: * `getDateFormat()` * `getTimeFormat()` * `getDateTimeFormat()` @@ -154,7 +154,7 @@ The following methods take a single input to specify style, defaulting to `short * `promptForInput()` -`standardMCIReadyHandler()`: This is a standard and commonly used `mciReady()` implemenation: +`standardMCIReadyHandler()`: This is a standard and commonly used `mciReady()` implementation: ```javascript mciReady(mciData, cb) { @@ -162,6 +162,14 @@ mciReady(mciData, cb) { } ``` +Where `mciData` is a Object mapping [MCI codes](../art/mci.md) such as `TL2` to their properties: +* `SGR`: Graphics rendition +* `focusSGR` (Only present if art contained both, ie: `TL2^[0;mTL2`) +* `position` (Array of Number): Position in [Row, Column] order +* `args` (Array): Any arguments to the MCI code +* `code` (String): The code itself, such as `TL` +* `id` (Number): The MCI code's ID such as `1` + > :information_source: Search the code for the above methods to see how they are used in the base system! diff --git a/docs/_docs/modding/wfc.md b/docs/_docs/modding/wfc.md index 1aaacfe5..1f0727e3 100644 --- a/docs/_docs/modding/wfc.md +++ b/docs/_docs/modding/wfc.md @@ -20,6 +20,12 @@ The system allows any user with the proper security to access the WFC / system o > :information_source: Due to the above, the WFC screen is **disabled** by default as at a minimum, you'll need to add your user to the `wfc` group. See also [Security](../configuration/security.md) for more information on keeping your system secure! +Adding your user to the `wfc` group: +```bash +# Repalce USERNAME with your leet +op username +./oputil.js user group USERNAME "+wfc" +``` + To change the ACS required, specify a alternative `acs` in the `config` block. For example: ```hjson mainMenuWaitingForCaller: { @@ -30,6 +36,8 @@ mainMenuWaitingForCaller: { } ``` +> :bulb: You can add additional co-ops by adjust the required ACS. + > :lock: ENiGMA½ will enforce ACS of at least `SC` (secure connection) ## Theming