Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MoDuLah authored Sep 10, 2024
1 parent 46704cb commit 08376c9
Showing 1 changed file with 3 additions and 19 deletions.
22 changes: 3 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# TDU2 SaveGame Manager
![GitHub Repo stars](https://img.shields.io/github/stars/MoDuLah/TDU2-SaveGame-Manager)

## Download
From the releases page (update pending).
## Overview
The **TDU2 SaveGame Manager** is a tool designed to manage, backup, and restore save game files for the game **Test Drive Unlimited 2**.
It provides an intuitive interface for players to manage their savegame data, back it up, and easily restore backups.
Expand All @@ -12,30 +13,13 @@ The tool also includes additional features such as progress bars for loading tas
- **Validation:** Checks for write permissions and ensures proper directory structures before performing operations.
- **Progress Feedback:** Displays progress bar animations during backup and restore operations for a smooth user experience.
- **Selectable Backup Destination:** The user can select a custom directory to store backups.
- **Getting Started**

# For developers/contributors
## Prerequisites
- **.NET 6.0** (or later) SDK
- **Windows OS** (for running the executable)
- Building the Project
### Clone this repository:
```bash
git clone https://github.com/MoDuLah/MoDuLah.git
```
1. Open the solution in Visual Studio or your preferred C# editor.
2. Restore the NuGet packages.
3. Build the solution.

## Running the Application
Once the project is built, you can run the application directly from your IDE or as a standalone executable.

## Backup and Restore Operations

### Backup
1. Select the folder containing the savegame files from the list on the left side.
2. Feel free to customise the backup destination folder or let the program do it for you on a subdirectory in the software folder.
3. Click the Backup button to create an uncompressed .tar archive of the save game folder in the selected destination.
3. Click the Backup button to create an uncompressed .zip archive of the save game folder in the selected destination.
4. The backup will be saved in the format: <foldername>_backup_yyyy.MM.dd_HH.mm.tar.

### Restore
Expand Down

0 comments on commit 08376c9

Please sign in to comment.