Skip to content

Commit 51a29dd

Browse files
committed
Added README images and compiling guide
1 parent ea7411e commit 51a29dd

File tree

5 files changed

+72
-16
lines changed

5 files changed

+72
-16
lines changed

README.md

Lines changed: 72 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,89 @@
1+
12
# Pocket Relay Client
23

34
![License](https://img.shields.io/github/license/PocketRelay/Client?style=for-the-badge)
45

5-
## ❔What
6+
| Normal | Native |
7+
| ------------------------------------- | --------------------------------------------------- |
8+
| ![Client](./pictures/client-base.png) | ![Client Native](./pictures/client-base-native.png) |
69

7-
This is a tool for Redirecting your local Mass Effect 3 clients to an Unofficial server. The
8-
connection string you put in will be connected to by the client and then used to redirect
9-
traffic using the system hosts file
10+
## ❔ What
1011

11-
## ❔Usage Guide
12+
This is a client tool which allows Mass Effect 3 clients to connect to unofficial servers rather than the official EA servers. This tool allows players to play on [Pocket Relay](https://pocket-relay.pages.dev/) servers
1213

13-
For a guide on using this program see the guide [Here](https://pocket-relay.pages.dev/guide/client/)
14+
For a guide on using this program see the guide [Here](https://pocket-relay.pages.dev/docs/client/joining)
1415

16+
## 📥 Downloads
1517

16-
## ❔How
18+
Below are some quick download links to download the latest versions, the client tool contains a built in auto-updater so you don't have to return to this website every time a new release is available.
1719

18-
This tool uses the system hosts file at `C:/Windows/System32/drivers/etc/hosts` and adds
19-
`127.0.0.1 gosredirector.ea.com` which tells your computer to send all the traffic that
20-
would normally go to `gosredirector.ea.com` to your local computer where its then instead handled by the client tool
20+
| Variant | Download Link |
21+
| ------- | --------------------------------------------------------------------------------------------------------- |
22+
| Normal | [Download](https://github.com/PocketRelay/Client/releases/latest/download/pocket-relay-client-native.exe) |
23+
| Native | [Download](https://github.com/PocketRelay/Client/releases/latest/download/pocket-relay-client-native.exe) |
2124

22-
## 🔌 Credits
2325

24-
This repository contains files from [https://github.com/Erik-JS/masseffect-binkw32](https://github.com/Erik-JS/masseffect-binkw32) in the /legacy directory as they were embedded in previous
25-
versions of the client in order to disable certificate verification
2626

27-
## EA / BioWare Notice
27+
## 🚀 Building
28+
29+
Guide for manually compiling the client executable from source
30+
31+
### Requirements
32+
33+
- **Rust & Cargo** Rust version 1.70.0 or newer is required in order to compile the client you can install both of these using Rustup which you can install using the guide Here
34+
- **Git** Git is required to clone the github repository to your system. You can ignore this step if you manually download the latest source archive from github directly Here
35+
36+
### Combined Answer
37+
38+
If you want skip all the steps and just have a list of commands to paste in for the default setup you can paste the following command into your terminal. (This is using the bash syntax for multiple commands)
39+
40+
```shell
41+
git clone --depth 1 https://github.com/PocketRelay/Client.git pocket-relay-client && cd pocket-relay-client && cargo build --release
42+
```
43+
44+
### 1) Clone Repository
45+
46+
> If you have already directly downloaded the repository source code from GitHub you can skip this step.
47+
48+
First you will need to clone the GitHub repository for the client. The following command will clone only the latest code changes from the GitHub repository
49+
50+
```shell
51+
git clone --depth 1 https://github.com/PocketRelay/Client.git pocket-relay-client
52+
```
53+
54+
### 2) Directory
55+
56+
In order to build the client using commands you will need to open the client source code directory that you’ve just cloned within your terminal. You can do that using the cd command. The following command will set your current directory to the client source code:
57+
58+
59+
```shell
60+
cd pocket-relay-client
61+
```
62+
63+
> The above command will only work if you run it in the same place that you’ve cloned the repository to
64+
65+
### 3) Compiling
66+
67+
Now to compile the client source into a binary that you can run you need to run the following command:
68+
69+
```shell
70+
cargo build --release
71+
```
72+
73+
### 4) Client binary
74+
75+
Once the client building finishes you can now find the client executable which will be located in the following folder
76+
77+
```
78+
target/release
79+
```
80+
81+
> If you are on Windows the file will be named pocket-relay-client.exe and if you are on Linux it will be named pocket-relay-client
82+
83+
84+
## 🔌 Credits
2885

29-
All code in this repository is authored by Jacobtread and none is taken from BioWare. This code has been
30-
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.
86+
This repository contains files from [https://github.com/Erik-JS/masseffect-binkw32](https://github.com/Erik-JS/masseffect-binkw32) in the /legacy directory as they were embedded in previous versions of the client in order to disable certificate verification
3187

3288
## 🧾 License
3389

pictures/1.png

-29.9 KB
Binary file not shown.

pictures/2.png

-45.7 KB
Binary file not shown.

pictures/client-base-native.png

12.1 KB
Loading

pictures/client-base.png

24.7 KB
Loading

0 commit comments

Comments
 (0)