Updated ReadMe.md

This commit is contained in:
ZKWolf 2024-04-23 23:09:47 +02:00
parent 10f76c4a14
commit 3a646d435d

View File

@ -1,8 +1,20 @@
# DeathGarden Bloodharvest API Rebirth Project
*Quick jump [Setup](https://github.com/wolfswolke/DeathGarden_API_Rebirth?tab=readme-ov-file#usage)*
**This project is a work in progress! That means there are bugs!**
**In its current state, you can play, and most features have been implemented. For info about missing features, check out the [to-do page](https://github.com/users/wolfswolke/projects/2/views/1).**
**In its current state, you can play, and most features have been implemented.
For info about missing features, check out the [to-do page](https://github.com/users/wolfswolke/projects/2/views/1).**
**Please note that this project is not affiliated with Behaviour Interactive or any other company.**
**This project is for educational purposes only!**
**This Repository will probably not be updated a lot anymore because
Project Chronos started to work on their own backend in PHP.**
****
****
@ -16,7 +28,7 @@
- Matchmaking via Steam P2P
- Leaderboard doesn't crash anymore
- GameNews (disabled atm because they mess InitOrGetGroup up)
- InitOrGetGroup
- InitOrGetGroup (Challenges disabled atm see TODO)
- A lot of other features and endpoints (most of them keep the game from crashing)
@ -25,14 +37,12 @@
- Dynamic leaderboards
- Challenges (code is done already but needs rework)
- Progression (leveling, currency, end of match, etc.)
- Private matches
- Private matches (Requires Dedicated Servers sadly)
- End-of-match endpoints
For more detailed information about our project's tasks, please visit the [to-do 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 knowledge about how the backend used to work or want to contribute, please reach out!
From what we know the game was based on WH40KEC (Warhammer 40k Eternal Crusade) and some code was also used in DBD.
**Contact Information:**
- Matrix: @zkwolf:matrix.org
@ -45,7 +55,7 @@ From what we know the game was based on WH40KEC (Warhammer 40k Eternal Crusade)
1. Download the [TheExit-Rebirth-Updater.bat](https://github.com/wolfswolke/DeathGarden_API_Rebirth/blob/master/src/files/TheExit-Rebirth-Updater.bat) file and place it in the following directory: "\steamapps\common\DEATHGARDEN\"
2. Run the script and wait for it to finish.
2. Run the script and wait for it to finish. (RED TEXT means something went wrong!)
**Self Hosting/Development Requirements:**
- Steam API Key (see [Steam_Login.md](https://github.com/wolfswolke/DeathGarden_API_Rebirth/blob/master/Doc/Steam_Login.md) for details).
@ -53,20 +63,3 @@ From what we know the game was based on WH40KEC (Warhammer 40k Eternal Crusade)
- Install the requirements from `requirements.txt`.
- Create an api_config.yaml file (an example is available in the `src/config` folder).
- For request analysis, consider using Fiddler.
**Current Knowledge:**
- The game uses Unreal Engine 4.21.0.
- The anticheat is BattlEye (note: Windows 11 blocks vulnerable drivers).
- The newest game version is: te-18f25613-36778-ue4-374f864b (versions may vary by region).
- The backend and server can be changed with start parameters (new method with the PAK file).
- The in-game console can be re-enabled.
- The in-game SET command is available.
- The "Status" API is Stashboard, which has been discontinued since 2019.
- Fluentd was used for logging.
- The game server uses the Amazon GameLift SDK (we are now using P2P).
- The steam_api.dll cannot be spoofed because Battleye checks the signature. (we have a Battleye emulator)
- There is an API key that is currently not used by the game.
- The authentication is done via the bhvrSession cookie. See [bhvrSession.md](https://github.com/wolfswolke/DeathGarden_API_Rebirth/blob/master/Doc/bhvrSession.md) for details.
**Currently Known Endpoints and URLs:**
- This information will be reworked into a wiki page for more detailed reference.