mirror of
https://github.com/sp-tarkov/modules.git
synced 2025-02-13 09:50:43 -05:00
Needs merged with: SPT-AKI/Server#249 Added - Moved beta disclaimer text to the server - Moved `PreventClientModsPatch` to AKI.Debugging as it makes more sense here after this PR. People who need to know, know why. - Ability to show a release note summary to users in-game - Cool debug message only shows build hash. Instructions for testing - Since I opted to store properties in the registry, its not as straight forward as deleting a file. (Thanks Drakia for the suggestion). So in order to test you need to open up regedit and navigate to `Computer\HKEY_CURRENT_USER\Software\Battlestate Games\EscapeFromTarkov` inside of that directory are 3 values stored in relation to this PR. `SPT_AcceptedBETerms` - `REG_DWORD` that stores a value of 0 or 1 `SPT_ShownReleaseNotes` - `REG_DWORD` that stores a value of 0 or 1 `SPT_Version` - `REG_BINARY` that stores a binary converted string. In order to reset after first run for a second test, you just delete all 3 entries. Co-authored-by: Cj <161484149+CJ-SPT@users.noreply.github.com> Reviewed-on: SPT-AKI/Modules#90 Co-authored-by: Cj <cj@noreply.dev.sp-tarkov.com> Co-committed-by: Cj <cj@noreply.dev.sp-tarkov.com>
Modules
BepInEx plugins to alter Escape From Tarkov's behaviour
Project | Function |
---|---|
Aki.Build | Build script |
Aki.Bundles | External bundle loader |
Aki.Common | Common utilities used across projects |
Aki.Core | Required patches to start the game |
Aki.Custom | SPT-AKI enhancements to EFT |
Aki.Debugging | Debug utilities (disabled in release builds) |
Aki.Reflection | Reflection utilities used across the project |
Aki.SinglePlayer | Simulating online game while offline |
Privacy
SPT is an open source project. Your commit credentials as author of a commit will be visible by anyone. Please make sure you understand this before submitting a PR. Feel free to use a "fake" username and email on your commits by using the following commands:
git config --local user.name "USERNAME"
git config --local user.email "USERNAME@SOMETHING.com"
Requirements
- Escape From Tarkov 28476
- Visual Studio Code -OR- Visual Studio 2022
- .NET 6 SDK
- PowerShell v7
Project Setup
Copy-paste Live EFT's EscapeFromTarkov_Data/Managed/
folder to into this project's Project/Shared/Managed/
folder
Build (VS Code)
- File > Open Workspace > Modules.code-workspace
- Terminal > Run Build Task...
- Copy contents of
/Build
into SPT game folder and overwrite
Build (VS 2022)
- Open solution
- Restore nuget packages
- Build solution
- Copy contents of
/Build
into SPT game folder and overwrite
Game Setup
- Copy Live EFT files into a separate directory (from now on this will be referred to as the "SPT directory")
- Download BepInEx 5.4.22 x64 (BepInEx Releases - GitHub)
- Extract contents of the BepInEx zip into the root SPT directory
- Build Modules, Server and Launcher
- Copy the contents of each project's
Build
folder into the root SPT directory - (Optional, but recommended) Download the BepInEx5 version of ConfigurationManager (ConfigurationManager Releases - GitHub) and extract the contents of the zip into the root SPT directory. The default keybind for opening the menu will be
F1
- (Optional) Edit the BepInEx config (
\BepInEx\config\BepInEx.cfg
) and appendDebug
to theLogLevels
setting. Example:LogLevels = Fatal, Error, Warning, Message, Info, Debug
Description
Languages
C#
99.5%
PowerShell
0.5%