From 876fcb2369424f30aa8bf8a0bc6a16652881f728 Mon Sep 17 00:00:00 2001 From: AeonLucid Date: Sun, 31 Oct 2021 03:56:39 +0200 Subject: [PATCH] Update README --- .github/workflows/build.yml | 6 +++++- README.md | 24 +++++++----------------- 2 files changed, 12 insertions(+), 18 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 26fe329..ed58c8f 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,6 +1,10 @@ name: Build -on: [push] +on: + push: + paths: + - ./src/Prospect.Agent/** + - ./src/Prospect.Launcher/** env: PROJ_AGENT: ./src/Prospect.Agent/Prospect.Agent.vcxproj diff --git a/README.md b/README.md index 4f445fa..71fedb1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Prospect +[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/AeonLucid/Prospect/Build?style=for-the-badge)](https://github.com/AeonLucid/Prospect/actions) + Also known as "The Cycle: Frontier". This repository is just something I work on when bored, do not expect much at this stage. @@ -12,7 +14,7 @@ This repository is just something I work on when bored, do not expect much at th - [ ] CloudScript - [ ] ? -## Development setup +## API Development setup ### 1. Download the game @@ -24,13 +26,13 @@ If you are enrolled into the closed beta, you can download a fresh copy with [St This gives you the [exact copy](https://steamdb.info/depot/1600361/history/?changeid=M:8099885118311987420) that is used for this repository. -### 2. Modify your hosts file +### 2. Download the latest launcher -Open `C:\Windows\System32\drivers\etc\hosts` with notepad as an Administrator. +Navigate to the [latest successful](https://github.com/AeonLucid/Prospect/actions) build. Extract the launcher files to a directory. -Add the following line to the bottom of the file and save it. +Run the launcher with the first argument being the path of step 1. ``` -127.0.0.1 A22AB.localhost +./Prospect.Launcher.exe "E:\Depots\depots\1600361\7573497" ``` ### 3. Clone the repository @@ -42,15 +44,3 @@ git clone https://github.com/AeonLucid/Prospect.git ### 4. Open the solution Open the `src/Prospect.sln` in either Rider or Visual Studio. - -### 5. Run the launcher - -The game needs to be modified so that it connects our own servers. With the current implementation it will connect to `https://A22AB.localhost`. The `.localhost` part may not exceed `15` characters. - -Run the `Prospect.Launcher` project with the first argument being the path of the game. - -``` -./Prospect.Launcher.exe "E:\Depots\depots\1600361\7573497" -``` - -> The Cycle uses https://playfab.com/ for their multiplayer service. By default it connects to `titleId.playfabapi.com`, the `.playfabapi.com` part is hardcoded and the `titleId` can be set with `PF_TITLEID`. Known `titleId` values are `A22AB` (The Cycle Playtest) and `2EA46` (Fallback, hardcoded). \ No newline at end of file