neckfire/the-cycle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update README

Browse Source
This commit is contained in:
AeonLucid
2021-10-31 03:56:39 +02:00
parent bcc675489e
commit 876fcb2369
2 changed files with 12 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/build.yml
+5 -1
View File
@@ -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
README.md
+7 -17
View File
@@ -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).