Skip to content

Repository files navigation

EventAutoProfileBackup SPT Mod

Automatic event-based profile backup system with easy restore system.

Usage

After installation this will automatically begin to backup each profile individually when any of the following happens

  • GameLaunch: When the game client is launched
  • RaidStart: When a raid starts
  • RaidEnd: When a raid ends
  • GameClose: When the game client is closed

Backup files

The backup files are stored as follows

  • Path: SPT/user/profiles/EventProfileBackups/backups/profileID-profileUsername/
  • File format: year-month-day_hour-minute-second_event.json
    • Example: 2025-01-14_21-14-49_GameLaunch.json

Restore

Automatically and safely restores profile backups by just placing the desired backup file in the ProfilesToRestore folder.

Process

  • Copy or move the backup file you wish to restore to SPT/user/profiles/EventProfileBackups/ProfilesToRestore/.
  • Start or restart the server
  • When the restore is complete the file will be moved to SPT/user/profiles/EventProfileBackups/RestoredProfiles/.
    • The number of restored backup files retained is set by the MaximumRestoredBackupFiles parameter in the config.jsonc.

Configuration

The configuration is found at SPT/user/mods/EventAutoProfileBackup/config.jsonc

Each event can be enabled or disabled. If there is an event that you want to backup for that is not listed, please create an issue and I will look into adding it.

Contributing

You are free to fork, improve and send PRs to improve the project. Please try to make your code coherent for the other developers.

Development Requirements

History

The mod was originally known as Lua-AutoProfileBackup. Credit to Lua for the original concept. I rewrote most of the functionality for SPT 3.10 and then entirely in migrating it to C# for SPT 4.0.

Note: This repo was originally forked from https://github.com/dvize/SPT-TypeScript. I deleted and recreated this repo to remove it as a fork when I completed the C# rewrite as the code is now all written by me. The git history has been maintained if you'd like to see its origins.

Mod history:

SPT Version Author
SPT 3.1.x-3.2.5 Lua
SPT 3.4-3.5 Reis
3.6-3.9 Props (https://forge.sp-tarkov.com/mod/848/luas-auto-profile-backup-updated)

I also received some great help in the SPT discord from DrakiaXYZ, acidphantasm, and Jehree. Thank you!

Licenses

cc by-nc-sa

This project is licensed under CC BY-NC-SA 4.0.

Credits

This directly depends on and borrows various bits of code from SPT.Server. I also referenced the Fika-Server C# for insight and ideas but it is not in any way a dependency, I just want to make sure I credit them for what I got from it.

Project License
SPT.Server NCSA
Fika Server NCSA

About

SPT Event-based profile backup and restore system

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Contributors

Languages