nrelay

A console based modular client for Realm of the Mad God built with Node.js and TypeScript.

Docs

Docs covering how to create plugins, all implemented packet structures and their members, and some of the object structures can be found in the docs folder.

Install

Prerequisites

Make sure you have Nodejs installed before running nrelay.

Clone the repo to your computer

git clone https://github.com/thomas-crane/nrelay.git/

Change directory into the new nrelay directory

cd nrelay

Install the required dependencies

npm install

Install typescript globally

npm install -g typescript

Compile the typescript. This will generate a folder called dist containing the compiled JavaScript.

tsc

Note

Step 6 and 7 are optional, but not performing them will restrict how you can run nrelay. See the Run section for more info.

Install nrelay as an npm module. This will let you use nrelay from any directory in the console.

npm install -g

Link the installed module to this folder to automatically update the module when any code changes happen.

npm link

Setup

Now that nrelay is installed, you will need to set up your acc-config.json file. This can be done in a few steps:

Open the nrelay folder in your file explorer
Rename the file acc-config-sample.json to acc-config.json. (Note: Depending on your computer's settings you might not see the .json part of the file name)
Replace the account info with your own account info.

// acc-config-sample.json
{
    "buildVersion": "X19.1.0",              // The current RotMG build version
    "accounts": [
        {
            "guid": "john@email.com",       // Your RotMG account email.
            "password": "SecretPassWord11", // Your RotMG account password.
            "serverPref": "AsiaSouthEast"   // The preferred server to connect to.
        }
    ]
}

If you have multiple accounts which you want to run at the same time, you can add them to the acc-config by duplicating the segment in the curly braces { ... }. E.g.

// acc-config-sample.json
{
    "buildVersion": "X19.1.0",
    "accounts": [
        {
            "guid": "first.account@email.com",
            "password": "SecretPassWord11",
            "serverPref": "AsiaSouthEast"
        },
        {
            "guid": "second.account@email.com",
            "password": "Password22",
            "serverPref": "USSouth"
        }
    ]
}

Run

After setting up the acc-config.json file, nrelay is ready to go. To run nrelay, simply use the command nrelay in the console. If you have setup your acc-config properly (and used the correct credentials) you should see an output similar to this

C:\Documents>nrelay
[NRelay] Starting...
[NRelay] Authorized account
[NRelay] Connecting to AsiaSouthEast
[Client] Starting connection.
[Client] Connected to server!

Note

You will only be able to use the command nrelay if you performed step 6 and 7 during the installation. If you didn't do these steps, you will have to run nrelay by following these steps:

Open a console in the nrelay directory
Use the command npm start.

npm start will only work if the console is in the nrelay directory, whereas the nrelay command can be run anywhere.

Build

Whenever any changes are made to the TypeScript source files, they will need to be recompiled in order for the changes to take effect.

To recompile the TypeScript simply use

tsc

Alternatively, if you are using Visual Studio Code, you can press Ctrl + Shift + B, then select the build task tsc: build - tsconfig.json

nith822 / nrelay