Skip to content

An Escape From Tarkov BepInEx module designed to be used with SPT-Aki with the ultimate goal of "Offline" Coop

License

Notifications You must be signed in to change notification settings

chiefmasterR/SIT.Core

 
 

Repository files navigation

SIT.Core

An Escape From Tarkov BepInEx module designed to be used with SPT-Aki Server with the ultimate goal of "Offline" Coop


About

The Stay in Tarkov project was born due to Battlestate Games' (BSG) reluctance to create the pure PvE version of Escape from Tarkov. The project's aim is simple, create a Cooperation PvE experience that retains progression. If BSG decide to create the ability to do this on live OR I receive a DCMA request, this project will be shut down immediately.

Disclaimer

  • You must buy the game to use this. You can obtain it here. https://www.escapefromtarkov.com.
  • This is by no means designed for cheats (this project was made because cheats have destroyed the Live experience)
  • This is by no means designed for illegally downloading the game (and has blocks for people that do!)
  • This is purely for educational purposes. I am using this to learn Unity and TCP/UDP/Web Socket Networking and I learnt a lot from BattleState Games \o/.
  • I am not affiliated with BSG or others (on Reddit or Discord) claiming to be working on a project. Do NOT contact SPTarkov subreddit or Discord about this project.
  • This project is not affiliated with SPTarkov but uses its excellent Server.
  • 30 July 2023. I will no longer support users. This project comes "as-is". It either works for you or it doesn't.

Support

ko-fi

  • Please be aware. The Ko-Fi link is buying me a coffee, nothing else! I do not offer support.
  • Pull Requests are encouraged. Thanks to all contributors!
  • Please do not hand over money expecting help or a solution. I do not offer support.
  • This is a hobby, for fun, project. Please don't treat it seriously. I do not offer support.
  • I do not BS the community. I know this is a semi-broken attempt but will attempt to fix as best I can. I do not offer support.
  • 30 July 2023. Issues & Discussions buttons will no longer be used. I do not offer support.

SPT-AKI Requirement

  • Stay in Tarkov works requires the latest AKI Server to run. You can learn about SPT-Aki here.
  • DO NOT INSTALL THIS ON TO SPT-Aki CLIENT! ONLY INSTALL THE SERVER!

The Wiki is has been constructed by various contributors. All instructions are also kept within the source in the wiki directory.

Coop

Coop Summary

BE AWARE

  • Coop is in early stages of development.
  • Most features work (ish) and it is "playable (ish) with likely bugs". "Playable" and perfect are two very different things. Expect lag (desync), issues and bugs.
  • My tests have included all maps. The maps that work best are Factory and Labs. Performance is very dependant on the CPU / Internet on the Server and Clients and AI count on the Server
  • More Information on HOSTING & COOP is in the HOSTING.md Document

PREREQUISITE

You must have the SPT-Aki mod installed in your Server for this module to work. If you do not wish to use the Coop module, you must disable it in the BepInEx config file.

Can Coop use BSG's Coop code?

No. BSG server code is hidden from the client for obvious reasons. So BSG's implementation of Coop use the same online servers as PvPvE. We don't see this, so we cannot use this.

Coding explanation

  • The project uses multiple methods of BepInEx Harmony patches coupled with Unity Components to achieve its aims.
  • Features/Methods that require constant polling between Client->Server->Client (Move, Rotate, Look, etc) use Components to send data (AI code runs the Update/LateUpdate command and the function every tick, therefore causing network flood).
  • Features/Methods that can easily be "replicated" use ModuleReplicationPatch abstract class to easily round trip the call.
  • All server communication is via JSON TCP Http and Web Socket calls to the "Web Server" developed by SPT-Aki using a typescript mod to handle the "backend" work.
  • CoopGameComponent is attached to the GameWorld object when a Coop ready game is started (any game that isn't Hideout). CoopGameComponent polls the Server for information and passes the data to the PlayerReplicatedComponent.

SPT-Aki

Are Aki Modules supported?

The following Aki Modules are supported.

  • aki-core
  • Aki.Common
  • Aki.Reflection
  • Do SPT-AKI Client mods work? This is dependant on how well written the patches are. If they directly target GCLASSXXX or PUBLIC/PRIVATE then they will likely fail.

Why don't you use Aki Module DLLs?

SPT-Aki DLLs are written specifically for their own Deobfuscation technique and my own technique is not working well with Aki Modules at this moment in time. So I ported many of SPT-Aki features into this module. My end-goal would be to rely on SPT-Aki and for this to be solely focused on SIT only features.

How to compile?

Compiling Document

How to install BepInEx

https://docs.bepinex.dev/articles/user_guide/installation/index.html

Install to Tarkov

BepInEx 5 must be installed and configured first (see How to install BepInEx) Place the built .dll in the BepInEx plugins folder

Test in Tarkov

  • Browse to where BepInEx is installed within your Tarkov folder
  • Open config
  • Open BepInEx.cfg
  • Change the following setting [Logging.Console] Enabled to True
  • Save the config file
  • Run Tarkov through a launcher or bat file like this one (replacing the token with your ID)
start ./Clients/EmuTarkov/EscapeFromTarkov.exe -token=pmc062158106353313252 -config={"BackendUrl":"http:https://127.0.0.1:6969","Version":"live"}
  • If BepInEx is working a console should open and display the module "plugin" as started

Thanks List

License

  • DrakiaXYZ projects contain the MIT License
  • 95% of the original core and single-player functionality completed by SPT-Aki teams. There may be licenses pertaining to them within this source.
  • None of my own work is Licensed. This is solely a just for fun project. I don't care what you do with it.

About

An Escape From Tarkov BepInEx module designed to be used with SPT-Aki with the ultimate goal of "Offline" Coop

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages

  • C# 100.0%