Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maldorne/mud-web-proxy
Web proxy for playing MUD / MUSH / MOO games.
https://github.com/maldorne/mud-web-proxy
moo mud mush proxy telnet websockets
Last synced: about 2 months ago
JSON representation
Web proxy for playing MUD / MUSH / MOO games.
- Host: GitHub
- URL: https://github.com/maldorne/mud-web-proxy
- Owner: maldorne
- License: other
- Created: 2020-04-04T11:41:39.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-06-18T18:35:36.000Z (3 months ago)
- Last Synced: 2024-07-18T21:39:06.507Z (2 months ago)
- Topics: moo, mud, mush, proxy, telnet, websockets
- Language: JavaScript
- Homepage: https://www.maldorne.org
- Size: 220 KB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-muds - mud-web-proxy
README
# mud-web-proxy
### What is this?
[node.js](https://nodejs.org/en/) microserver which provides a secure websocket (`wss://`) to telnet (`telnet://`) proxy for [MUD](https://en.wikipedia.org/wiki/MUD) / MUSH / MOO game servers, supporting all major data interchange and interactive text protocols. To connect and play a game, you will need to run in your web page a web client capable to connect through `wss` to this proxy, like [`mud-web-client`](https://github.com/maldorne/mud-web-client).
### History
This project is a fork of [MUDPortal-Web-App](https://github.com/plamzi/MUDPortal-Web-App), made by [@plamzi](https://github.com/plamzi), creator of [mudportal.com](http://www.mudportal.com/). The original project had the code of both the client and proxy-server apps, and was outdated and did not support secure connections (`wss://` instead of `ws://`), so I decided to fork it, separate in different projects and update them. But kudos to [@plamzi](https://github.com/plamzi), who is the original author.
### Motivation
In modern browsers, web-pages served through `https://` are not allowed to open connections to non-secure locations, so an `https://`-served web could not include a web client which opens a connection using `ws://`. Modifications were needed to allow secure connections.
## Features
* MCCP compression support (zlib)
* MXP protocol support built into the client
* MSDP protocol support
* GMCP / ATCP protocol support (JSON) with sample uses in multiple existing plugins
* 256-color support, including background colors
* Unicode font support and UTF-8 negotiation
* To avoid abuse, default installation only allows connection to an specific server, although it can be configured to connect to any server sent by the client as an argument.
## Installation
``` bash
git clone https://github.com/maldorne/mud-web-proxy
npm install
sudo node wsproxy.js
```
You need to have your certificates available to use wsproxy. If you start the proxy without certificates, you'll see something like this:
``` bash
$ sudo node wsproxy.js
Could not find cert and/or privkey files, exiting.
```
You need to have available both files in the same directory as the proxy, like this:
``` bash
$ ls
cert.pem chat.json LICENSE.md node_modules package.json package-lock.json privkey.pem README.md wsproxy.js
```
where `cert.pem` and `privkey.pem` will be links to the real files, something like:
``` bash
cert.pem -> /etc/letsencrypt/live/...somewhere.../cert.pem
privkey.pem -> /etc/letsencrypt/live/...somewhere.../privkey.pem
```
How to install the certificates is beyond the scope of this project, but you could use [Certbot](https://certbot.eff.org/about/). You can find installation instructions for every operating system there.
## Configuration
In `wsproxy.js` you can change the following options:
``` javascript
/* this websocket proxy port */
ws_port: 6200,
/* default telnet host */
tn_host: 'muds.maldorne.org',
/* default telnet/target port */
tn_port: 5010,
/* enable additional debugging */
debug: false,
/* use node zlib (different from mccp) - you want this turned off unless your server can't do MCCP and your client can inflate data */
compress: true,
/* set to false while server is shutting down */
open: true,
```
Probably you will only have to change:
* `tn_host` with your hostname. `localhost` or `127.0.0.1` don't seem to work: [see conversation here](https://github.com/maldorne/mud-web-proxy/issues/5#issuecomment-866464161).
* `tn_port` with the port where the mud is running.