User Tools

Site Tools


mbbsemu:configuration:modules.json

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
mbbsemu:configuration:modules.json [2021/03/12 01:56] tudaymbbsemu:configuration:modules.json [2023/12/09 21:51] (current) enusbaum
Line 1: Line 1:
-<markdown> +===== modules.json Config File =====
-modules.json Config File+
  
-While MBBSEmu allows you to run a single Module from the command line, using a modules.json file allows you to specify any number of modules to be loaded when you run MBBSEmu. You can specify a modules.json file using the `-C <fileName>command line switch.+While MBBSEmu allows you to run a single Module from the command line, using a modules.json file allows you to specify any number of modules to be loaded when you run MBBSEmu. You can specify a modules.json file using the ''-C <fileName>'' command line switch.
  
-The modules.json file is a simple JSON file that lists an array of modules with their `Identifierand `Path`+The modules.json file is a simple JSON file that lists an array of modules with their **Identifier** and **Path**
  
-**`Identifier`** : This is the unique name given to the MajorBBS/Worldgroup module. This is usually the DLL name (Example: `TSGARN`)+**Identifier**: This is the unique name given to the MajorBBS/Worldgroup module. This is usually the DLL name (Example: ''TSGARN'')
  
-**`Path`**: This is the absolute path on the file system to the folder containing the module (Example: `c:\dos\modules\telearena\`). Using this path variable, modules can now live in their own folders vs. having to all be installed in a single directory as MajorBBS/Worldgroup required.+**Path**: This is the absolute path on the file system to the folder containing the module (Example: ''c:\\dos\\modules\\telearena\\''). Using this path variable, modules can now live in their own folders vs. having to all be installed in a single directory as MajorBBS/Worldgroup required.
  
-**`MenuOptionKey`**: MBBSEmu will specify a default value for each module that can be entered at the main menu. If you want to use a custom value for a module (such as `Tfor Tele-Arena), you can specify it using this option. (Modules with Duplicate `MenuOptionKeyvalues will be ignored, A-Z or 0-9 accepted)+**MenuOptionKey**: MBBSEmu will specify a default value for each module that can be entered at the main menu. If you want to use a custom value for a module (such as ''T'' for Tele-Arena), you can specify it using this option. (Modules with Duplicate **MenuOptionKey** values will be ignored, A-Z or 0-9 accepted)
  
-**`Enabled`**: `1` is the default "true" which enables the module, `0= false and will load the module in a disabled state -- this can be enabled using the sysop commands "/sys enable <moduleid>" +**Enabled**: ''1''"true" and is default, which enables the module. ''0'' "falseand will load the module in a disabled state -- this can be enabled using the sysop commands "/sys enable <moduleid>" 
  
-**Note**: Because the file is JSONon Windows platforms you must escape the backslash in the path with `\\` (See Below)+**Patch**: As of [[https://github.com/mbbsemu/MBBSEmu/pull/502|PR #502]]MBBSEmu has implemented [[mbbsemu:configuration:softpatch|SoftPatch]] support which allows you to apply custom hex edits/string edits directly to a module on load without having to make any modifications to the module DLL file. 
  
-# Example File+**Note**: Because the file is JSON, on Windows platforms you must escape the backslash in the path with ''\\\\'' (See Below)
  
 +===== Example File =====
 +
 +<markdown>
 ```json ```json
 { {
mbbsemu/configuration/modules.json.1615514217.txt · Last modified: 2023/10/06 23:40 (external edit)