Change README

This commit is contained in:
q13x 2022-12-20 18:38:40 -08:00
parent 529d92ba34
commit cbd0b47628

View File

@ -1,11 +1,8 @@
# EaglercraftX (1.8.9) WebSocket Proxy # EaglercraftX (1.8.9) WebSocket Proxy
### Demo: `wss://eaglercraft-18.worldeditaxe.repl.co/server` ([EaglerX 1.8.9 client](https://web.arch.lol/mc/1.8.8/) only) ### Demo: `wss://eaglerx-server.worldeditaxe.repl.co/server` ([EaglerX 1.8.9 client](https://web.arch.lol/mc/1.8.8/) only)
![Two EaglerX clients connected to the same server](./assets/demo.png) ![Two EaglerX clients connected to the same server](./assets/demo.png)
## What is this? ## What is this?
A WebSocket proxy that allows EaglercraftX 1.8 clients to connect to an offline vanilla Minecraft server with (mostly working) Eaglercraft skin support. This is meant to be a replacement for the unreleased official EaglercraftX bungee until it releases. It supports all 1.8.9 servers, even offline server networks! A WebSocket proxy that allows EaglercraftX 1.8 clients to connect to an offline vanilla Minecraft server with (mostly working) Eaglercraft skin support. This is meant to be a replacement for the unreleased official EaglercraftX bungee until it releases. It supports all offline 1.8.9 servers and even online servers when modified!
## Issues
* Occasional vague "End of Stream" error when disconnected
* Custom skins (excluding custom Eaglercraft skins) do not render correctly
## Setup Guide ## Setup Guide
### Prerequisites ### Prerequisites
* Node.js v12 and up * Node.js v12 and up
@ -55,9 +52,5 @@ export const config = {
} }
}; };
``` ```
<<<<<<< HEAD
4. Run the server (`node index.js`).
=======
3. Start your proxy by running `node index.js`. 3. Start your proxy by running `node index.js`.
4. Connect to your server. For the server address, use the folllowing format: `ws://<IP>:<port>`. If you are using encryption, replace `ws://` with `wss://`. 4. Connect to your server. For the server address, use the folllowing format: `ws://<IP>:<port>`. If you are using encryption, replace `ws://` with `wss://`.
>>>>>>> 7c45e7d890b8025f51d2d479fa3499b232fbc1eb