Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
MoDuLah committed Sep 11, 2024
2 parents a935fed + 08376c9 commit e07b358
Showing 1 changed file with 19 additions and 18 deletions.
37 changes: 19 additions & 18 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,29 +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**

## 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 All @@ -48,6 +33,22 @@ Once the project is built, you can run the application directly from your IDE or
- Add error handling for scenarios where the tar.exe is not available on the system.
- Improve the UI to support more flexible layouts for smaller screens.

# 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.

Forks:
## Contributing
If you'd like to contribute to the project, feel free to fork the repository and submit a pull request.
Expand Down

0 comments on commit e07b358

Please sign in to comment.