Update README.md

This commit is contained in:
q13x 2022-12-21 01:43:40 -08:00 committed by GitHub
parent b61a1c73f5
commit bdb05709a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -7,12 +7,11 @@ A WebSocket proxy that allows EaglercraftX 1.8 clients to connect to an offline
## Setup Guide ## Setup Guide
### Prerequisites ### Prerequisites
* Node.js v12 and up * Node.js v12 and up
* TypeScript installed (`npm i -g typescript`, may require `sudo` or administrator permissions)
* An **OFFLINE** 1.8.9-compatible Minecraft server or proxy * An **OFFLINE** 1.8.9-compatible Minecraft server or proxy
### Setup ### Setup
#### If Repl.it is acceptable, fork the [demo](https://replit.com/@WorldEditAxe/eaglerx-server) and connect to it. All proxy files will be under the `proxy` folder. #### If Repl.it is acceptable, fork the [demo](https://replit.com/@WorldEditAxe/eaglerx-server) and connect to it. All proxy files will be under the `proxy` folder.
1. Download and extract this repository to a folder on your computer. 1. Download the latest package available on this repository.
2. Open a terminal and go to the folder of the repository. Run `npm i`, followed by `tsc`. 2. Open a terminal and go to the folder of the repository. Run `npm i`.
3. Edit `config.js` to configure your proxy. Below is a small breakdown of the configuration file. 3. Edit `config.js` to configure your proxy. Below is a small breakdown of the configuration file.
```js ```js
export const config = { export const config = {