Merge pull request #11 from PocketRelay/dev

Merge README changes

README.md

@@ -1,8 +1,9 @@
-<img src="https://raw.githubusercontent.com/PocketRelay/.github/main/assets/logo-new-text.svg" width="100%" height="160px">
+<img src="https://raw.githubusercontent.com/PocketRelay/.github/main/assets/logo-new-text.svg" width="100%" height="120px">
 
 # Pocket Relay 
 
-> Mass Effect 3 Server Emulator Rust server implementation
+*Mass Effect 3 Server Emulator / Private Server*
+
 
 ![License](https://img.shields.io/github/license/PocketRelay/ServerRust?style=for-the-badge)
 ![Cargo Version](https://img.shields.io/crates/v/pocket-relay?style=for-the-badge)
@@ -11,87 +12,85 @@
 
 [Discord Server (https://discord.gg/yvycWW8RgR)](https://discord.gg/yvycWW8RgR)
 
-Development on this implementation has made great strides and has surpassed the original Kotlin server in terms of performance
-reliabality, functionality and actual parody to the official server.
-
-# 📖 Setting up a server
+**Pocket Relay** Is a custom implementation of the Mass Effect 3 multiplayer servers all bundled into a easy to use server with a Dashboard for managing accounts and inventories.
 
-For a guide on how to setup a Pocket Relay server see [Here](https://github.com/PocketRelay/.github/blob/main/manual/SETUP_SERVER.md)
-and for connecting to a server see [Here](https://github.com/PocketRelay/.github/blob/main/manual/SETUP_CLIENT.md)
+With **Pocket Relay** you can play Mass Effect 3 multiplayer offline by yourself, over LAN, or even over WAN as a public server 
 
-# ❔ What
+## 📌 EA / BioWare Notice
 
-This is an implementation of a Mass Effect 3 multiplayer server. This server emulates the functionality of the official servers except it can run locally on your machine and be shared over LAN allowing you to play Mass Effect 3 multiplayer 
-without an internet connection or just locally for a LAN party.
+The **Pocket Relay** software in all its forms are in no way or form supported, endorsed, or provided by BioWare or Electronic Arts. 
 
-# 🔌 Client Usage
-In order to connect to a Pocket Relay server you will first need to use the Client tool to patch your
-game and update your hosts file with the address of the server.
+## 📖 Starting your own server
 
-You can find the client [Here (https://github.com/PocketRelay/Client)](https://github.com/PocketRelay/Client)
+If you would like to host your own **Pocket Relay** serveryou can follow this guide [Here](https://github.com/PocketRelay/.github/blob/main/manual/SETUP_SERVER.md) 
 
-The client tool makes it easy to do the setup process. But its possible to do everything the client
-does manually if you'd prefer. Documentation for how to do so will be posted at a later point.
+If you would like to join an existing **Pocket Relay** server you can follow this guide [Here](https://github.com/PocketRelay/.github/blob/main/manual/SETUP_CLIENT.md)
 
-# 🔧 Configuration
+## 📦 Downloads
 
-In order to configure the server such as changing the ports you can see the
-configuration documentation [Here (docs/CONFIG.md)](docs/CONFIG.md)
+Below is a table of the download links for the different platforms and server types
 
-# 📦 Releases
+### Normal
 
-**SQLite**:
+The **SQLite** version of **Pocket Relay** this version requires no additional database setup and is the ideal choice for most 
 
 | Platform | Download                                                                                                |
 | -------- | ------------------------------------------------------------------------------------------------------- |
 | Windows  | [Download](https://github.com/PocketRelay/ServerRust/releases/latest/download/pocket-relay-windows.exe) |
 | Linux    | [Download](https://github.com/PocketRelay/ServerRust/releases/latest/download/pocket-relay-linux)       |
 
-**MySQL**:
+### MySQL
+
+The **MySQL** version which requires that you have a **MySQL** database to use. This version expects you to have some understanding of **MySQL** and a server prepared to use it with
 
 | Platform | Download                                                                                                      |
 | -------- | ------------------------------------------------------------------------------------------------------------- |
 | Windows  | [Download](https://github.com/PocketRelay/ServerRust/releases/latest/download/pocket-relay-windows-mysql.exe) |
 | Linux    | [Download](https://github.com/PocketRelay/ServerRust/releases/latest/download/pocket-relay-linux-mysql)       |
 
-# 🚀 Building
 
-Instructions for building the server can be found [Here](https://github.com/PocketRelay/.github/blob/main/manual/BUILDING.md)
 
-# ⚙️ Features
+## 🔧 Configuration
 
-**Origin Authentication** This server supports origin authentication through the official servers. This is enabled by default but can be changed using the PR_ORIGIN_FETCH environment variable.
+In order to configure the server such as changing the ports you can see the
+configuration documentation [Here (docs/CONFIG.md)](docs/CONFIG.md)
 
-> NOTE: Origin Authentication requires that the PR_RETRIEVER must not be false. If the 
-> retriever system is disabled then it won't be allowed to connect to the official servers
 
-**Origin Fetching** This server supports copying over Origin credits, classes, characters, weapons, levels, etc from the official servers. This is enabled by default and can
-be changed using the PR_ORIGIN_FETCH_DATA environment variable.
+## ⚙️ Features
 
-**API** The server includes an optional API that you can enable which allows querying and modifying 
-player data on the server along with querying the active games on the server.
+- **Origin Support** This server supports **Origin** / **EA Launcher** copies of the game through its fetching system. As long as the official servers are still available and you have internet access the server will connect to the official servers to authorize **Origin** accounts. *This behavior can be disabled using the `PR_ORIGIN_FETCH` environment variable*
+- **Origin Fetching** Along with supporting **Origin** authentication your player data from the official servers can also be loaded for those logging into **Origin** accounts. *This behavior can be disabled using the `PR_ORIGIN_FETCH_DATA` environment variable*
+- **Portable & Platform Independent** This server can be run on most hardware and software due to its low requirements and custom
+implementations of lots of required portions allowing you to run it
+on Windows, Linux, etc. *Note the server will store the player data and logging in a folder named `data` in the same folder as the exe*
+- **Cracked Support** This server supports cracked Mass Effect 3 copies so you can play on the server using them.
+- **Docker Support** This server includes a `Dockerfile` so that it can be run in a containerized environment. The server uses a small alpine linux container to run inside
+- **Dashboard** The server includes a management dashboard 
+    - This includes leaderboards displays
+    - Allowing players to edit their username, email, and password
+    - Deleting and managing accounts
+    - Viewing running games
+    - Inventory editing for admins (Weapons, Classes, Characters, etc)
+    - View server logs as super admin
 
-**Man-In-The-Middle Server** This server has a built in Man-In-The-Middle server for proxying your connection to the Official servers while logging all the packets that travel
-between the client and the server. 
+## 🚀 Manual Building
 
-**Dockerized** This server is able to be built and run in an Alpine linux docker container 
-removing the need for building and managing files and executables.
+Instructions for building the server can be found [Here](https://github.com/PocketRelay/.github/blob/main/manual/BUILDING.md)
 
-**Fully portable & Platform Independent** Other Mass Effect 3 servers were limited by the operating systems that they were able to run on due to limitations with SSLv3 which is required by a portion of the server to function. However this server has its own 
-custom SSLv3 implementation and can be compiled for Windows, Linux and even Alpine linux.
-The entire server fits inside a single executable and the only files it writes to the drive
-are log files and the database if using the SQLite database version. 
+> Note: Building the server can be quite a heavy load on your computer
 
-**Cracked & Origin Support** This server supports both cracked and Origin clients.
+## Dashboard
 
-# 📡 API
+Below are some screenshots of the included dashboard. You can access the dashboard by visting the server connection URL this 
+URL will be present in the server logs / output upon launching.
 
-Pocket Relay servers contain an API which allows you to query the list of players and view currently active games.
-This is not enabled by default but see the configuration documentation for the variable to enable it. 
+> If you are running the server on the same computer you can access the dashboard using http://localhost
 
-You can view its documentation [Here (docs/API.md)](docs/API.md)
+![Dashboard Login](images/3.png)
+![Dashboard Home](images/1.png)
+![Dashboard Inventory](images/2.png)
 
-# ⛔️ Known Issues
+## ⛔️ Known Issues
 
 **Host Migration** Host migration is partially working however it only currently works
 for a single player. If there is more than one player in the game when host migration
@@ -114,12 +113,7 @@ taken to a login screen where you can create a new account with Pocket Relay.
 will crash. The cause for this is not yet known but restarting the game and attempting to create
 an account again usually works.
 
-# 📌 EA / BioWare Notice
-
-All code in this repository is authored by Jacobtread and none is taken from BioWare. This code has been 
-produced from studying the protocol of the official servers and emulating its functionality. This program is in no way or form supported, endorsed, or provided by BioWare or Electronic Arts.
-
-# 🧾 License
+## 🧾 License
 
 MIT License