diff --git a/docs/config.md b/docs/config.md index ca760676..ff653e37 100644 --- a/docs/config.md +++ b/docs/config.md @@ -6,11 +6,16 @@ The main system configuration file, `config.hjson` both overrides defaults and p **Windows note**: **~** resolves to *C:\Users\YOURLOGINNAME\* on modern Windows installations, e.g. `C:\Users\NuSkooler\.config\enigma-bbs\config.hjson` -### oputil.js -Please see `oputil.js config` for configuration generation options. +### Creating a Configuration +Your initial configuration skeleton can be created using the `oputil.js` command line utility. From your enigma-bbs root directory: +``` +./oputil.js config new +``` -### Example: System Name -`core/config.js` provides the default system name as follows: +You will be asked a series of questions to create an initial configuration. + +### Overriding Defaults +The file `core/config.js` provides various defaults to the system that you can override via `config.hjson`. For example, the default system name is defined as follows: ```javascript general : { boardName : 'Another Fine ENiGMA½ System' @@ -26,17 +31,14 @@ general: { (Note the very slightly different syntax. **You can use standard JSON if you wish**) +While not everything that is available in your `config.hjson` file can be found defaulted in `core/config.js`, a lot is. [Poke around and see what you can find](https://github.com/NuSkooler/enigma-bbs/blob/master/core/config.js)! + ### Specific Areas of Interest -* [Menu System](menu_system.md) * [Message Conferences](msg_conf_area.md) * [Message Networks](msg_networks.md) * [File Base](file_base.md) * [File Archives & Archivers](archives.md) -* [Doors](doors.md) -* [MCI Codes](mci.md) * [Web Server](web_server.md) -...and other stuff [in the /docs directory](./) - ### A Sample Configuration Below is a **sample** `config.hjson` illustrating various (but certainly not all!) elements that can be configured / tweaked. @@ -125,5 +127,7 @@ Below is a **sample** `config.hjson` illustrating various (but certainly not all } ``` -## Menus -See [the menu system docs](menu_system.md) \ No newline at end of file +## See Also +* [Modding](modding.md) +* [Doors](doors.md) +* [MCI Codes](mci.md) diff --git a/docs/modding.md b/docs/modding.md index 5dcf5a29..9449a91e 100644 --- a/docs/modding.md +++ b/docs/modding.md @@ -9,4 +9,7 @@ See [Menu System](menu_system.md) ## Theming Take a look at how the default `luciano_blocktronics` theme found under `mods/themes` works! -TODO document me! \ No newline at end of file +TODO document me! + +## Add-On Modules +See [Mods](mods.md) \ No newline at end of file