Proxiani

Proxiani is a proxy server designed to optimize communication between Miriani and MUD clients. It also comes with features that enhance the gaming experience in conjunction with Miriani Soundpacks.

Note

This repository is a fork of Proxiani. This project takes a more abstract approach to the client and server architecture. Notably, parting with MUD client-specific features in the hope to make it more moduler.

Installation

Download and install the latest recommended version of Node.js from nodejs.org. Node 10 or newer is required.

Usage

If you would like to run Proxiani with a console window (mostly just for developers), then use:

$ npm start

If you prefer to run Proxiani without a console window (recommended for most users), then launch the file called Start.vbs that is located inside the Proxiani folder.

Then use your MUD client to connect to:

Host: localhost
Port: 1234

Alternatively, if localhost doesn't work for some reason, then try the localhost IP address instead:

127.0.0.1

There are also some helpful VBScripts located in the root of this package:

Start.vbs - Starts Proxiani without a console window.
Enable Auto Start.vbs - Creates a Proxiani shortcut for Start.vbs in the startup folder.
Disable Auto Start.vbs - Removes the Proxiani shortcut from the startup folder.

Features

Supports SSL/TLS for encrypting all communication with Miriani.
Automatically reconnects to Miriani if network issues break the connection.
Addresses an issue in VIP Mud that causes lines of text to randomly break.
Makes sms, smc, and other starmap commands lightning fast.
Creates clean and timestamped logs of incoming text from Miriani. ... and much more!

Parameters

You can pass the following parameters to Proxiani:

-q: Suppresses message boxes that indicate whether Proxiani started successfully or if another instance is already running.
-d : Use this flag to set a user data directory for Proxiani.

Examples:

$ npm start -- -d C:\Users\MyName\Proxiani

The -- (double hyphen) tells npm to pass the subsequent parameters directly to Proxiani.

$ npm start -- -q -d ../Proxiani Data

When using relative paths with the -d flag, it will be relative to current working directory.

All these parameters can also be passed to Start.vbs if you would like to run Proxiani without a console window. The only difference is that you use // (double slash) instead of -- (double hyphen). For example: