mirror of
https://github.com/NuSkooler/enigma-bbs.git
synced 2025-07-27 21:16:09 +02:00
Many doc updates RE: HJSON/general config
This commit is contained in:
parent
5ea6f5e1f8
commit
284151a0c9
6 changed files with 58 additions and 26 deletions
|
@ -2,26 +2,13 @@
|
|||
layout: page
|
||||
title: Creating Initial Config Files
|
||||
---
|
||||
Configuration files in ENiGMA½ are simple UTF-8 encoded [HJSON](http://hjson.org/) files. HJSON is just
|
||||
like JSON but simplified and much more resilient to human error.
|
||||
Configuration files in ENiGMA½ are simple UTF-8 encoded [HJSON](http://hjson.org/) files. HJSON is just like JSON but simplified and much more resilient to human error.
|
||||
|
||||
## config.hjson
|
||||
Your initial configuration skeleton can be created using the `oputil.js` command line utility. From your
|
||||
enigma-bbs root directory:
|
||||
```
|
||||
## Initial Configuration
|
||||
Your initial configuration skeleton can be created using the `oputil.js` command line utility. From your enigma-bbs root directory:
|
||||
```bash
|
||||
./oputil.js config new
|
||||
```
|
||||
|
||||
You will be asked a series of questions to create an initial configuration.
|
||||
You will be asked a series of questions to create an initial configuration, which will be saved to `/enigma-bbs-install-path/config/config.hjson`. This will also produce `config/<bbsName>-menu.hjson` and `config/<bbsName>-prompt.hjson` files (where `<bbsName>` is replaced by the name you provided in the steps above). See [Menu HJSON](menu-hjson.md) and [Prompt HJSON](prompt-hjson.md) for more information.
|
||||
|
||||
## menu.hjson and prompt.hjson
|
||||
|
||||
Create your own copy of `/config/menu.hjson` and `/config/prompt.hjson`, and specify it in the
|
||||
`general` section of `config.hjson`:
|
||||
|
||||
````hjson
|
||||
general: {
|
||||
menuFile: my-menu.hjson
|
||||
promptFile: my-prompt.hjson
|
||||
}
|
||||
````
|
Loading…
Add table
Add a link
Reference in a new issue