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

Doc updates

Browse Source
This commit is contained in:
Bryan Ashby
2022-08-12 19:21:45 -06:00
parent cc788056ea
commit 8552e2dd35
4 changed files with 33 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/_docs/installation/testing.md
View File

@@ -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/)

12
docs/_docs/modding/menu-modules.md
View File

@@ -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!

8
docs/_docs/modding/wfc.md
View File

@@ -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