PocketRelay / Client

Client for connecting to Pocket Relay servers
https://pocket-relay.pages.dev/
MIT License
5 stars 3 forks source link
mass-effect-3

Pocket Relay Client

License Build

Discord Server (discord.gg/yvycWW8RgR) | Website (pocket-relay.pages.dev)

Normal Native
Client Client Native

Table of Contents

โ” What

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 servers

For a guide on using this program see the guide Here

๐Ÿ“ฅ Downloads

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.

Variant Download Link
Normal Download
Native Download

๐Ÿš€ Building

Guide for manually compiling the client executable from source

Requirements

On Linux the client dynamically links to OpenSSL so you will need to ensure you have the required OpenSSL dependencies installed. You can find them Here

Combined Answer

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)

git clone --depth 1 https://github.com/PocketRelay/Client.git pocket-relay-client && cd pocket-relay-client && cargo build --release

1) Clone Repository

If you have already directly downloaded the repository source code from GitHub you can skip this step.

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

git clone --depth 1 https://github.com/PocketRelay/Client.git pocket-relay-client

2) Directory

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:

cd pocket-relay-client

The above command will only work if you run it in the same place that youโ€™ve cloned the repository to

3) Compiling

Now to compile the client source into a binary that you can run you need to run the following command:

cargo build --release

4) Client binary

Once the client building finishes you can now find the client executable which will be located in the following folder

target/release

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

Makefile.toml - Mainly used for maintainers

This project also includes a Makefile.toml for cargo make however its more intended for maintainers only in order to do cross compiling, building multiple versions in parallel, signing builds, etc

Requires installing https://github.com/sagiegurari/cargo-make

Building

Build Windows & Linux in parallel

cargo make -t build-all

Building just Windows

cargo make -t build-windows

[!NOTE] When building for Windows on a Windows host you can sign the executable by providing a SIGN_FILE (File path to the .pfx file to use for signing) and SIGN_PASSWORD (The password to the .pdf file) you will also need to obtain a copy of signtool.exe and set the SIGNTOOL_PATH to be the path to that file

After doing that Windows builds will be signed using the provided credentials

Building just Linux

cargo make -t build-linux

๐Ÿ”Œ Credits

This repository contains files from 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

๐ŸŒ EA / BioWare Notice

The Pocket Relay software, in all its forms, is not supported, endorsed, or provided by BioWare or Electronic Arts.

๐Ÿงพ License

The MIT License (MIT)

Copyright (c) 2022 - 2023 Jacobtread

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.ECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.