diff --git a/README.md b/README.md index b1c6837..d2f033f 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,17 @@ Eaglercraft is real Minecraft 1.6.4 that you can play in any regular web browser **(right click the link and press 'Save link as...' to download the file)** +# Table Of Contents: +| [Multiplayer](#Multiplayer) | [Others](#Others) | +|---------------------------------------------------------------------------------|-------------------------------------------------------| +| [Self hosting (singleplayer)](#Singleplayer?) | [Plugin Development](#Plugin-Development) | +| [Creating a Server - Bukkit](#Creating-a-server---Bukkit) | [Compiling](#Compiling) | +| [Creating a Server - EaglercraftBungee](#Creating-a-server---EaglercraftBungee) | [Creating a resource pack](#Creating-a-resource-pack) | +| [Creating a Client](#Creating-a-Client) | [Contributing](#Contributing) | +| [EaglercraftBungee Configuration](#EaglercraftBungee-Configuration) | | +| [Creating a Reverse Proxy - NGINX](#Creating-a-Reverse-Proxy---NGINX) | | +| [NGINX Configuration](#NGINX-Configuration) | | + ## Singleplayer? You can self host a server (see the "How to make a server" section below), and connect to `ws://localhost:25565` in your client and play one there, it will be essentially an integrated server but with extra steps. @@ -23,7 +34,7 @@ I got tired of closing duplicate 'how to maek sever' issues almost every day so ## How to make a server -There are ***multiple parts*** **to a server**, mainly consisting of a **regular 1.5.2 Bukkit server**, and a **modified version of Bungeecord** called **EaglercraftBungee**, which on top of the regular Bungeecord functionality, it translates WebSocket connections to raw TCP connections which Bukkit can understand. +There are ***multiple parts*** **to a server**, mainly consisting of a **regular 1.6.4 Bukkit server**, and a **modified version of Bungeecord** called **EaglercraftBungee**, which on top of the regular Bungeecord functionality, it translates WebSocket connections to raw TCP connections which Bukkit can understand. You may also want to set up your own **client**, allowing you to *control default server listings, resource packs, and an overall faster connection due to less load.* @@ -37,17 +48,17 @@ If you want to use a domain for your server, **a reverse proxy** can be set up t 1. **Check if Java is installed.** You can download it from [https://www.java.com/en/download/](https://www.java.com/en/download/) 2. Download the [mp-server.zip](mp-server.zip) file from this repository -4. Extract the ZIP file you downloaded to a new folder -5. Open the new folder, go into the `java/bukkit_command` folder -6. Open a new terminal and run `java -jar craftbukkit-1.6.4-R2.0.jar` to start the bukkit server -7. To add some bukkit plugins, download the plugin's JAR file for CraftBukkit 1.6.4 and place it in `java/bukkit_command/plugins` +3. Extract the ZIP file you downloaded to a new folder +4. Open the new folder, go into the `java/bukkit_command` folder +5. Open a new terminal and run `java -jar craftbukkit-1.6.4-R2.0.jar` to start the bukkit server +6. To add some bukkit plugins, download the plugin's JAR file for CraftBukkit 1.6.4 and place it in `java/bukkit_command/plugins` (See [https://github.com/lax1dude/eaglercraft-plugins/](https://github.com/lax1dude/eaglercraft-plugins/) to download some supported plugins) ## Creating a server - EaglercraftBungee 1. In the same new folder, go into the `java/bungee_command` folder 2. In Windows, double-click `run.bat`. It should open a second terminal window Keep both the first and second terminal window you opened, just minimize them, don't close -3. On macOS or Linux, repeat step 7 in [Creating a Server - Bukkit](#Creating-a-server---Bukkit), but navigate to `java/bungee_command` this time +3. On macOS or Linux, repeat step 5 in [Creating a Server - Bukkit](#Creating-a-server---Bukkit), but navigate to `java/bungee_command` this time and run `bungee-dist.jar` 4. To add some bungee plugins, download the plugin's JAR file and place it in `java/bungee_command/plugins` There are alot more configurations in bungeecord, but this should set you up