moon/enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
enigma-bbs/docs/configuration/creating-config.md
Bryan Ashby 4d4be5d6a9
Major progress on revamp 
* Deprecated explicit prompt.hjson/general.promptFile, etc.: menu.hjson can simply include any number of files
* All menus and themes, their events, etc. are managed by ThemeManager allowing includes, refs, etc. and much cleaner code
2020-06-17 00:10:51 -06:00

796 B
Raw Blame History

layout title
page Creating Initial Config Files

Configuration files in ENiGMA½ are simple UTF-8 encoded HJSON files. HJSON is just like JSON but simplified and much more resilient to human error.

Initial 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

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 for more information.