R5Reloaded/r5sdk
1
0
Fork 0
mirror of https://github.com/Mauler125/r5sdk.git synced 2025-02-09 19:15:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Kawe Mazidjatari 2022-10-10 21:33:04 +02:00
parent bc3b580525
commit 9f02778fd6
1 changed files with 20 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -1,49 +1,33 @@
# Description # Description
* Fully documented SDK to be used for the 'Apex Legends' Source Engine. * Development package to be used for the 'Apex Legends' Source Engine.
## Instructions ## Instructions
To compile and use the SDK: To compile and use the SDK:
1. Download or clone the solution to `<gamedir>\platform\`. 1. Download or clone the solution to `<gamedir>\platform\`.
* The results should be `r5apex.exe\platform\r5apexsdk\detours.sln`. * The results should be `r5apex.exe\platform\sdk\r5sdk.sln`.
2. Open `detours.sln` in Visual Studio and compile the project. 2. Open `r5sdk.sln` in Visual Studio and compile the solution.
* The launcher executable and worker dll will be copied over automatically to the root directory of the game. * The launcher executable and worker dll will be copied over automatically to the root directory of the game.
* If this does not happen, copy `r5apexsdk64.dll` and `r5reloaded.exe` to the game folder (where `r5apex.exe` resides). * If this does not happen, copy `gamesdk.dll` and `launcher.exe` to the game folder (where `r5apex.exe` resides).
4. Run `r5reloaded.exe` and follow instructions in the console to launch in desired mode. 4. Run `launcher.exe`, toggle the desired options and hit the `Launch Game` button.
## Launch options
There are 4 launch options, all of them use separate `startup_*.cfg` files to pass command line arguments to the game.
All preconfigured launch parameters are available from the release page of this repository.
* Launch option 1 [DEBUG GAME] is for research and development purposes on the game.
* Launch option 2 [RELEASE GAME] is for playing the game and creating servers.
* Launch option 3 [DEBUG DEDICATED] is for research and development purposes on the dedicated server.
* Launch option 4 [RELEASE DEDICATED] is for running and hosting dedicated servers.
The `startup_*.cfg` files are loaded from `<gamedir>\platform\cfg\startup_*.cfg`
* Launch option 1 [DEBUG GAME] loads `startup_debug.cfg`
* Launch option 2 [RELEASE GAME] loads `startup_retail.cfg`
* Launch option 3 [DEBUG DEDICATED] loads `startup_dedi_debug.cfg`
* Launch option 4 [RELEASE DEDICATED] loads `startup_dedi_retail.cfg`
You can add or remove launch parameters from these files. Be carefull, as some are necessary to run the SDK with the game.
## Launch parameters ## Launch parameters
When the `-wconsole` parameter is passed to the game, a external debug terminal will pop up When the `-wconsole` parameter is passed to the game, an external debug terminal will pop up
in which everything of the game gets logged to (this is passed by default on debug launch options). in which everything of the game gets logged to (this is passed by default on debug launch options).
This does not count for the dedicated server, the debug terminal is always present as this is a console application. This does not count for the dedicated server, the debug terminal is always present as this is a console application.
When the `-ansiclr` parameter is passed to the game or dedicated server, color logging will be enabled to enhance When the `-ansiclr` parameter is passed to the game or dedicated server, color logging will be enabled to enhance
output readability. It is recommended to use this unless your system does not support `VirtualTerminalLevel 1`. output readability. It is recommended to use this unless your system does not support `VirtualTerminalLevel 1`,
This is passed by default. in which a SDK warning message will follow. This parameter is passed by default.
Additional launch parameters can be added to the `startup_*.cfg` files,
which are located in `<gamedir>\platform\cfg\startup_*.cfg`.
## Note [Important] ## Note [Important]
This is not a cheat or hack. Do not attempt to use this on the latest version of the game! This is not a cheat or hack. Do not attempt to use the SDK on the live version of the game!
The only versions currently supported are `R5pc_r5launch_N1094_CL456479_2019_10_30_05_20_PM` and anything below. The only versions currently supported are `R5pc_r5launch_N1094_CL456479_2019_10_30_05_20_PM` and anything below.
The following builds are tested and guaranteed to work: The following builds are tested and guaranteed to work:
@ -62,17 +46,19 @@ The following builds are tested and guaranteed to work:
* S3 `R5pc_r5launch_N1094_CL456479_2019_10_30_05_20_PM` * S3 `R5pc_r5launch_N1094_CL456479_2019_10_30_05_20_PM`
## R5Net DISCLAIMER ## Pylon DISCLAIMER
When hosting to the Server Browser (R5Net) you will stream your IP address to the database When you host game servers on the Server Browser (Pylon) you will stream your IP address to the database
which will be stored there until you stop hosting the server. which will be stored there until you stop hosting the server.
This is needed so you can connect to other player's servers. This is needed so other people can connect to your server.
There is a Checkbox in the server browser called `Server Visibility` that is by default set to `Offline`. There is a Checkbox in the server browser called `Server Visibility` that is by default set to `Offline`.
* `Offline` allows you to play the game offline without any data being broadcasted to the R5Net master server. * `Offline` allows you to play the game offline without any data being broadcasted to the Pylon master server.
* `Hidden` allows you to play the game online, but your server will not be listed in the server borwser list * `Hidden` allows you to play the game online, but your server will not be listed in the server borwser list
people with a token can connect to your server, similar to the real private matches of Apex Legends. people with a token can connect to your server, similar to the real private matches of Apex Legends.
* `Public` allows you to play online, your server will be listed in the server browser list and everyone * `Public` allows you to play online, your server will be listed in the server browser list and everyone
except for banned people can youn your server. except for banned people can join your server.
Alternative way is just to host the server without ticking the server browser checkbox and just give the people you want to connect the IP including the port. Alternatively, you can host game servers without the use of our master server, and grant people access to your game server
by sharing the IP address and port manually. The client can connect using the `connect` command. The usage of the `connect`
command is as follows: IPv4 `connect 127.0.0.1:37015`, IPv6 `connect [::1]:37015`, NOTE: the IP and port where examples.