Updated ReadMe.md

This commit is contained in:
ZKWolf 2023-06-26 19:31:12 +02:00
parent ca365e3a70
commit 8996aadbfc

View File

@ -3,21 +3,48 @@
This project is MORE than just a WIP!
Current Progress: Logging (Stashboard, Metrics, gameDataAnalytics), Steam Login.
Current Progress: Logging (Stashboard, Metrics, gameDataAnalytics), Steam Login, Load
Lobby, Some items in the Shop, Messaging System, Currency System and some smaller things,
Leaderboard doesn't crash anymore.
ToDo: Matchmaking, dynamic Leaderboards, Challenges, Progression,
buying things, Fixing the Catalog crash.
For more Info go to the [ToDo page.](https://github.com/users/wolfswolke/projects/2/views/1)
The goal of this project is to revive the Deathgarden backend and servers.
If you have any old HTTP captures of the traffic between the game and server, please submit them here!
If you have any knowledge on how the backend used to work or want to help
please reach out!
I am currently reverse-engineering the files to find all the API endpoints and requests.
Current knowledge
Don't forget we have a live as well. We can work 24/7 on this project.
But we are trying our best to get this project done as fast as possible.
## What you need
## Usage
To launch this api for yourself you need:
Download the [TheExitRebirthBackendAPI-WindowsNoEditor_P.pak](https://github.com/wolfswolke/DeathGarden_API_Rebirth/tree/master/game_files)
File and place it here: "DEATHGARDEN\TheExit\Content\Paks\"
Steam API Key, Python, requirements.txt, either Fiddler or the parameters
in the start_parms.txt file.
Then make a copy of TheExit-WindowsNoEditor.sig and rename it to TheExitRebirthBackendAPI-WindowsNoEditor_P.sig
You should then have the following files in the folder:
```
TheExitRebirthBackendAPI-WindowsNoEditor_P.pak
TheExitRebirthBackendAPI-WindowsNoEditor_P.sig
TheExit-WindowsNoEditor.pak
TheExit-WindowsNoEditor.sig
```
# Self hosting/Developing
You will need a steam API Key. [See Steam_Login.md](https://github.com/wolfswolke/DeathGarden_API_Rebirth/blob/master/Doc/Steam_Login.md)
Python 3.10 (or newer)
Install the requirements.txt
Create a api_config.yaml (Example is in the Config folder)
You can use Fiddler for request analysis.
## Current knowledge
@ -27,7 +54,7 @@ The anticheat is Battleye.
The newest game Version is: te-18f25613-36778-ue4-374f864b
The backend and server can be changed with start parameters.
The backend and server can be changed with start parameters. (New way with the PAK File)
The in-game console can be re-enabled.
@ -41,37 +68,6 @@ The steamAPI.dll cannot be spoofed because Battle Eye checks the signature.
There is a API Key which is NOT used by the game.
If you have any information, suggestions, etc., please create an issue.
### Currently, known Endpoints and URLs
POST https://stashboard.live.tex.bhvronline.com (Stashboard Open Source Status API)
GET https://latest.live.tex.bhvronline.com/api/v1/services/tex ()
POST https://latest.live.tex.bhvronline.com/api/v1/gameDataAnalytics (Game Data Analytics)
Post https://latest.live.tex.bhvronline.com/api/v1/auth (API auth with Steam Session Ticket)
GET https://latest.live.tex.bhvronline.com/api/v1/healthcheck (Keep Alive)
POST https://latest.live.tex.bhvronline.com/metrics (Tells Server HTTP Codes and time for requests)
GET https://latest.live.tex.bhvronline.com/api/v1/utils/contentVersion/latest/2.11
GET https://latest.live.tex.bhvronline.com/api/v1/modifierCenter/modifiers/me
GET https://latest.live.tex.bhvronline.com/api/v1/consent/eula2
POST https://latest.live.tex.bhvronline.com/moderation/check/username
POST https://latest.live.tex.bhvronline.com/metrics/server/event
POST https://stashboard.live.tex.bhvronline.com/api/v1/extensions/quitters/getQuitterState
POST https://stashboard.live.tex.bhvronline.com/api/v1/extensions/progression/initOrGetGroups
POST https://stashboard.live.tex.bhvronline.com/api/v1/me/richPresence
GET https://client-data.live.tex.bhvronline.com/te-18f25613-36778-ue4-374f864b/catalog
This Info will be reworked into a Wiki page.