The MajorBBS Emulation Project Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== How to run MajorMUD with MBBSEmu ======

The process of installing and running MajorMUD on any platform using MBBSEmu is simple and straight forward. This guide was written to help you get MajorMUD up and running quickly with the default options and settings.

Please see our [[https://github.com/mbbsemu/MBBSEmu/issues?q=is%3Aissue+is%3Aopen+label%3Amajormud| GitHub Issue Tracker]] for a full list of known compatibility issues with MajorMUD and MBBSEmu.

===== 1. Download & Install Requirements =====

First you will need to Download MBBSEmu and the DOS version of MajorMUD 1.11p

**__Files:__**

[[https://github.com/mbbsemu/MBBSEmu/releases|Latest Version of MBBSEmu]] for your selected platform

[[https://download.mbbsemu.com/modules/WCCMMUD/WCCMMUD_1.11p_DOS_MBBSEmu_v2.zip|MajorMUD 1.11p for DOS]] (MBBSEmu Ready, no installer)



===== 2. Registering MajorMUD on MBBSEmu =====

Activation Codes for MajorMUD (as with most modules for The MajorBBS) are keyed off your boards unique Registration Number. This number is internally referred to as **BTURNO** within The MajorBBS. On a traditional MajorBBS instance, Registration Number is generated and stored in plaintext within the **GALGSBL.DLL** file after you first install The MajorBBS on a new system.

MBBSEmu allows users to specify this number via the **[[mbbsemu:configuration:appsettings.json|appsettings.json]]** file value **GSBL.BTURNO**. This is an eight digit numeric value that is unique to your board. If your have purchased MajorMUD in the past, you would first populate this value with the registration number from your MajorBBS instance.

Example:
<markdown>
```
"GSBL.BTURNO" : "12345678"
```
</markdown>

The next step is to enter your Activation Code for MajorMUD. If your have purchased a copy of MajorMUD 1.11p for DOS previously, this is where you will enter your Activation code. 

This is done by modifying the **ACTIVATE** value in the **WCCMMUD.MSG** file. By default, the value in the file is set to **DEMO**.

Example:
<markdown>
```
ACTIVATE {DEMO} S 30 Enter your activation code
```
</markdown>

Replace the value **DEMO** between the curly braces with your valid MajorMUD Activation Code. For example, if your purchased 256-Node Activation Code provided to you looks like "**dlhbdfhjlnp**", then you would change the value in the file as follows:

<markdown>
```
ACTIVATE {dlhbdfhjlnp} S 30 Enter your activation code
```
</markdown>

**NOTE 1**: MajorMUD Activation Codes may contain letters, numbers, and special characters

**NOTE 2**: MBBSEmu only runs the __DOS__ version of MajorMUD 1.11p, not the __WG3NT__ version. Activation Codes for the __WG3NT__ version will not work on the __DOS__ versions of MajorMUD. 

===== 3. Starting MBBSEmu & MajorMUD =====

There are two methods you can use to run MajorMUD via MBBSEmu.

==== Command Line Method ====

The first method is simply via a [[mbbsemu:configuration:command_line_options|command line parameter]]. You would use this option if you're only going to be playing one Module via MBBSEmu. To simply run MajorMUD via the command line:

**Windows:**
<markdown>
```
MBBSEmu -M WCCMMUD -P c:\path\to\majormud\
```
</markdown>

**Linux/macOS:**
<markdown>
```
MBBSEmu -M WCCMMUD -P /home/user/path/to/majormud
```
</markdown>

==== Module JSON Method ====

The second method is using a [[mbbsemu:configuration:modules.json|modules.json file]]. You would use this method if you wanted to run MajorMUD in addition to other modules within MBBSEmu. The JSON file allows you to specify configuration options for multiple modules. 

The example below is for __just__ MajorMUD, but could be added to allowing multiple modules to be easily run.

**Windows:**
<markdown>
```json
{
  "Modules": [
    {
      "Identifier": "WCCMMUD",
      "Path": "c:\\bbsv6\\"
    }
  ]
}
```
  * Note: The double "\\" on the path is required because the character "\" is an escape sequence in JSON

**Linux/macOS:**
```json
{
  "Modules": [
    {
      "Identifier": "WCCMMUD",
      "Path": "/home/user/mbbsemu/majormud/"
    }
  ]
}
```
</markdown>

Once the files are created, you run MBBSEmu telling it to load the Module Options from a JSON file using the **"-C"** parameter. 

**Windows:**
<markdown>
```
MBBSEmu -C c:\path\to\modules.json
```
</markdown>

**Linux/macOS:**
<markdown>
```
MBBSEmu -C /home/user/path/to/modules.json
```
</markdown>


====== Archive ======
===== Configure account keys for MBBSEmu & MajorMUD =====

The MBBSEmu-ready MajorMUD package should already have account keys ready for use; however, the below section is archived here future reference.

Once installed, you will need to configure MBBSEmu properly to run MajorMUD. The process itself is simple, but there are several options you will need to set depending on your environment.

MBBSEmu has one JSON file used to control the application settings within MBBSEmu itself, this file is **[[mbbsemu:configuration:appsettings.json|appsettings.json]]**. Settings and options specified within this file are applied globally within MBBSEmu.

For MajorMUD, we'll need to make a couple additional configuration changes to make MajorMUD work "out of the box". 

The first is that MajorMUD requires users to have the key "PAYING" in order to enter the game. You can either change the MajorMUD configuration in the **WCCMMUD.MSG** file, or add the key to all users that log into MBBSEmu.

To make the change to MBBSEmu, add "PAYING" to the array of values in **appsettings.json** for **Account.DefaultKeys**. It should look like this:

<markdown>
```
  "Account.DefaultKeys": [
     "DEMO",
     "NORMAL",
     "USER",
     "PAYING"
   ]
```
   </markdown>